ASPxPivotGrid Methods

Represents the ASPxPivotGrid control.

Name Description
AddAttributesToRender(HtmlTextWriter) Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from WebControl)
AddParsedSubObject(Object) Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
(Inherited from Control)
AddedControl(Control, Int32) Called after a child control is added to the Controls collection of the Control object.
(Inherited from Control)
ApplyStyle(Style) Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from WebControl)
ApplyStyleSheetSkin(Page) Applies the style properties defined in the page style sheet to the control.
(Inherited from Control)
BeginRenderTracing(TextWriter, Object) Begins design-time tracing of rendering data.
(Inherited from Control)
BeginUpdate()

Prevents the ASPxPivotGrid from being rendered until the ASPxPivotGrid.EndUpdate method is called.

BuildProfileTree(String, Boolean) Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
(Inherited from Control)
CalcCallbackResult()

Initiates a callback by the client and obtains the result processed within the server.

ClearCachedClientID() Sets the cached ClientID value to null.
(Inherited from Control)
ClearChildControlState() Deletes the control-state information for the server control's child controls.
(Inherited from Control)
ClearChildState() Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control)
ClearChildViewState() Deletes the view-state information for all the server control's child controls.
(Inherited from Control)
ClearEffectiveClientIDMode() Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.
(Inherited from Control)
CollapseAll()

Collapses all the columns and rows in the pivot grid.

CollapseAllColumns()

Collapses all columns.

CollapseAllRows()

Collapses all rows.

CollapseValue(Boolean, Object[])

Collapses the specified column or row.

CopyBaseAttributes(WebControl) Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from WebControl)
CreateControlCollection() Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from Control)
CreateDrillDownDataSource()

Returns data records used to calculate summary values for all cells.

CreateDrillDownDataSource(Int32, Int32)

Returns data records associated with the specified cell.

CreateDrillDownDataSource(Int32, Int32, Int32)

Returns data records associated with the specified cell. Used in OLAP and server mode.

CreateDrillDownDataSource(Int32, Int32, Int32, List<String>)

Returns data records used to calculate a summary value for the specified cell in OLAP and server mode. Allows you to specify the columns, and limit the number of records to return.

CreateDrillDownDataSource(Int32, Int32, List<String>)

Returns data records used to calculate a summary value for the specified cell in OLAP and server mode. Allows you to specify the columns to return.

CreateOLAPDrillDownDataSource(Int32, Int32, Int32, List<String>)

Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the specified cell. Allows you to specify the columns, and limit the number of records to be returned.

CreateOLAPDrillDownDataSource(Int32, Int32, List<String>)

Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the specified cell. Allows you to specify the columns to be returned.

CreateServerModeDrillDownDataSource(Int32, Int32, Int32, List<String>)

Obsolete. In server mode, returns a list of records used to calculate a summary value for the specified cell. Allows you to specify the columns and limit the number of records to be returned.

CreateServerModeDrillDownDataSource(Int32, Int32, List<String>)

Obsolete. In server mode, returns a list of records used to calculate a summary value for the specified cell.

CreateSummaryDataSource()

Returns the ASPxPivotGrid's summary data source.

CreateSummaryDataSource(Int32, Int32)

Returns a summary data source for the specified row.

DataBind()

Binds the data source to the invoked server control.

(Inherited from ASPxWebControl)
DataBind(Boolean) Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.
(Inherited from Control)
DataBindChildren() Binds a data source to the server control's child controls.
(Inherited from Control)
Dispose()

Enables a server control to perform final clean up before it is released from memory.

EndRenderTracing(TextWriter, Object) Ends design-time tracing of rendering data.
(Inherited from Control)
EndUpdate()

Re-enables render operations after a call to the ASPxPivotGrid.BeginUpdate method and forces an immediate re-rendering.

EnsureID() Creates an identifier for controls that do not have an identifier assigned.
(Inherited from Control)
EnsureRefreshData()

Refreshes the grid's data. This member supports the internal infrastructure and is not intended to be used directly from your code.

Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) static Determines whether the specified object instances are considered equal.
(Inherited from Object)
ExpandAll()

Expands all the columns and rows in the pivot grid.

ExpandAllColumns()

Expands all columns.

ExpandAllRows()

Expands all rows.

ExpandValue(Boolean, Int32)

Expands the specified column or row by its index.

ExpandValue(Boolean, Object[])

Expands the specified column or row.

FindControl(String) Searches the current naming container for a server control with the specified id parameter.
(Inherited from Control)
FindControl(String, Int32) Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.
(Inherited from Control)
Focus()

Sets input focus to the web control.

(Inherited from ASPxWebControl)
GetAbsoluteColumnIndex(Int32)

Returns the column's absolute index by its visible index within the current page.

GetAbsoluteRowIndex(Int32)

Returns the row's absolute index by its visible index within the current page.

GetCallbackErrorMessage() static

Obtains the error info while processing the redirection page.

(Inherited from ASPxWebControl)
GetCellInfo(Boolean, Int32, Int32)

Returns an object that contains information on the specified cell.

GetCellInfo(Int32, Int32)

Returns an object that contains information on the specified cell.

GetCellValue(Int32, Int32)

Returns the value displayed in the specified cell.

GetCellValue(Object[], Object[], PivotGridField)

Returns a cell value calculated for the specified column and row field values, against the specified data field.

GetClientSideEventHandler(String)

Returns the specified client event's handler.

(Inherited from ASPxWebControl)
GetColumnIndex(Object[])

Returns the index of the specified column.

GetColumnIndex(Object[], PivotGridField)

Returns the index of the specified column.

GetCssClassNamePrefix()

For internal use only.

(Inherited from ASPxWebControl)
GetCssClassNamePrefix(String)

For internal use only.

(Inherited from ASPxWebControl)
GetDefaultBooleanProperty(String, DefaultBoolean)

For internal use only.

(Inherited from ASPxWebControl)
GetDesignModeState() Gets design-time data for a control.
(Inherited from Control)
GetFieldByArea(PivotArea, Int32)

Returns a pivot grid field located at the specified position within the specified area.

GetFieldCountByArea(PivotArea)

Returns the number of fields located in the specified area.

GetFieldList()

Returns the names of data source fields to which the pivot grid fields are bound.

GetFieldValue(PivotGridField, Int32)

Returns the specified field value.

GetFieldValueByIndex(PivotGridField, Int32)

Returns the specified field's value by its index.

GetFieldValueInfo(Boolean, Int32)

Returns information about the specified field value.

GetFieldValueInfo(PivotGridField, Int32)

Returns information about the specified field value.

GetFieldValueOLAPMember(PivotGridField, Int32)

Returns an OLAP member for the specified field value.

GetFieldValueType(Boolean, Int32)

Gets the type of a field value in the column or row area.

GetFieldValueType(PivotGridField, Int32)

Gets the type of a specific column/row field's value.

GetFieldsByArea(PivotArea)

Returns all visible pivot grid fields located at the specified area.

GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetKPIImage(PivotKPIGraphic, PivotKPIType, Int32)

Returns an image that corresponds to the specified KPI value.

GetOLAPKPIList()

Gets names of available KPI in a cube.

GetOLAPKPIMeasures(String)

Returns measures used to calculate the value, goal, status, trend and weight that represent the values of the specified Key Performance Indicator (KPI).

GetOLAPKPIServerGraphic(String, PivotKPIType)

Returns a graphic set defined on the server for the specified KPI's trend and status.

GetOLAPKPIValue(String)

Returns the specified KPI's value.

GetResourceUrl(Page, String) static

Returns a URL reference to an embedded resource in an assembly.

(Inherited from ASPxWebControl)
GetResourceUrl(Page, Type, String) static

Returns a URL reference to an embedded resource in an assembly.

(Inherited from ASPxWebControl)
GetRouteUrl(Object) Gets the URL that corresponds to a set of route parameters.
(Inherited from Control)
GetRouteUrl(RouteValueDictionary) Gets the URL that corresponds to a set of route parameters.
(Inherited from Control)
GetRouteUrl(String, Object) Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control)
GetRouteUrl(String, RouteValueDictionary) Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control)
GetRowIndex(Object[])

Returns the absolute index of the specified row.

GetRowIndex(Object[], PivotGridField)

Returns the index of the specified row.

GetType() Gets the Type of the current instance.
(Inherited from Object)
GetUniqueIDRelativeTo(Control) Returns the prefixed portion of the UniqueID property of the specified control.
(Inherited from Control)
HasControls() Determines if the server control contains any child controls.
(Inherited from Control)
HasEvents() Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control)
HtmlEncode(String)

For internal use only.

(Inherited from ASPxWebControl)
HtmlEncode(String, Boolean)

For internal use only.

(Inherited from ASPxWebControl)
IAttributeAccessor.GetAttribute(String) Gets an attribute of the Web control with the specified name.
(Inherited from WebControl)
IAttributeAccessor.SetAttribute(String, String) Sets an attribute of the Web control to the specified name and value.
(Inherited from WebControl)
IControlDesignerAccessor.GetDesignModeState() For a description of this member, see GetDesignModeState().
(Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary) For a description of this member, see SetDesignModeState(IDictionary).
(Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control) For a description of this member, see SetOwnerControl(Control).
(Inherited from Control)
IParserAccessor.AddParsedSubObject(Object) For a description of this member, see AddParsedSubObject(Object).
(Inherited from Control)
IsAccessibilityCompliantRender()

Returns a value that indicates whether the control's accessible html code is rendered.

(Inherited from ASPxWebControl)
IsAccessibilityCompliantRender(Boolean)

Returns a value that indicates whether the control's accessible html code is rendered.

(Inherited from ASPxWebControl)
IsClientSideAPIEnabled()

Returns a value that indicates whether a specific programmatic interface (in particular, specific JavaScript objects and methods) are available to the control on the client side.

(Inherited from ASPxWebControl)
IsEnabled()

Returns a value that specifies whether a web control is enabled.

(Inherited from ASPxWebControlBase)
IsFieldValueCollapsed(PivotGridField, Int32)

Indicates whether the specified field value is collapsed.

IsLiteralContent() Determines if the server control holds only literal content.
(Inherited from Control)
IsLoading()

Indicates that the ASPxPivotGrid is being loaded.

IsObjectCollapsed(PivotGridField, Int32)

Returns whether the specified column field value or row field value is collapsed.

IsVisible()

Returns a value that specifies whether the current web control is displayed.

(Inherited from ASPxWebControlBase)
LayoutChanged()

Updates a pivot grid.

LoadCollapsedStateFromStream(Stream)

Restores the collapsed state of field values from the specified stream.

LoadCollapsedStateFromString(String)

Restores the collapsed state of field values from the specified string.

LoadControlState(Object) Restores control-state information from a previous page request that was saved by the SaveControlState() method.
(Inherited from Control)
LoadLayoutFromStream(Stream)

Restores the pivot grid layout from the specified stream.

LoadLayoutFromStream(Stream, PivotGridWebOptionsLayout)

Restores the pivot grid layout from the specified stream, using the specified settings.

LoadLayoutFromString(String)

Restores the pivot grid layout from the specified string.

LoadLayoutFromString(String, PivotGridWebOptionsLayout)

Restores the pivot grid layout from the specified string, using the specified settings.

MakeResponseCompressed() static

Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client.

(Inherited from ASPxWebControl)
MakeResponseCompressed(Boolean) static

Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client, and accepts a parameter specifying whether to apply compression to IE6.

(Inherited from ASPxWebControl)
MapPathSecure(String) Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control)
MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
MergeStyle(Style) Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from WebControl)
OnBubbleEvent(Object, EventArgs) Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control)
OnDataBinding(EventArgs) Raises the DataBinding event.
(Inherited from Control)
OnUnload(EventArgs) Raises the Unload event.
(Inherited from Control)
OpenFile(String) Gets a Stream used to read a file.
(Inherited from Control)
RaiseBubbleEvent(Object, EventArgs) Assigns any sources of the event and its information to the control's parent.
(Inherited from Control)
RedirectOnCallback(String) static

Redirects a client to a new URL while processing a callback.

(Inherited from ASPxWebControl)
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RegisterBaseScript(Page) static

Registers base scripts, required to embed an ASPxWebControl control onto the specified page.

(Inherited from ASPxWebControl)
RegisterBaseScript(Page, Boolean) static

Registers base scripts required to embed an ASPxWebControl control onto the specified page.

(Inherited from ASPxWebControl)
RegisterUtilsScript(Page) static

Obsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page.

(Inherited from ASPxWebControl)
ReloadData()

Reloads the ASPxPivotGrid's data.

RemovedControl(Control) Called after a child control is removed from the Controls collection of the Control object.
(Inherited from Control)
RenderBeginTag(HtmlTextWriter) Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl)
RenderChildren(HtmlTextWriter) Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control)
RenderContents(HtmlTextWriter) Renders the contents of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl)
RenderControl(HtmlTextWriter) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from Control)
RenderControl(HtmlTextWriter, ControlAdapter) Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
(Inherited from Control)
RenderEndTag(HtmlTextWriter) Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
(Inherited from WebControl)
RequireClientLibrariesRegistering() static

Specifies whether client library registration is required.

(Inherited from ASPxWebControl)
ResolveAdapter() Gets the control adapter responsible for rendering the specified control.
(Inherited from Control)
ResolveClientUrl(String)

Gets a URL that can be used by the browser.

(Inherited from ASPxWebControlBase)
ResolveUrl(String) Converts a URL into one that is usable on the requesting client.
(Inherited from Control)
RetrieveFields()

Creates PivotGridField objects for all the fields in the bound data source.

RetrieveFields(PivotArea, Boolean)

Creates PivotGridField objects for all the fields in the bound data source, and moves the fields to the specified area, making them visible or hidden.

SaveCollapsedStateToStream(Stream)

Saves the collapsed state of field values to the specified stream.

SaveCollapsedStateToString()

Saves the collapsed state of field values to the specified string.

SaveControlState() Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from Control)
SaveLayoutToStream(Stream)

Saves the pivot grid layout to the specified stream.

SaveLayoutToStream(Stream, PivotGridWebOptionsLayout)

Saves the pivot grid layout to the specified stream, using the specified settings.

SaveLayoutToString()

Saves the pivot grid layout to the specified string.

SaveLayoutToString(PivotGridWebOptionsLayout)

Saves the pivot grid layout to the specified string, using the specified settings.

SetCallbackErrorMessage(String) static

Specifies the message text to be displayed for remote clients when a DevExpress control callback error has occurred.

(Inherited from ASPxWebControl)
SetClientSideEventHandler(String, String)

Defines a handler for the specified client event.

(Inherited from ASPxWebControl)
SetDefaultBooleanProperty(String, DefaultBoolean, DefaultBoolean)

For internal use only.

(Inherited from ASPxWebControl)
SetDesignModeState(IDictionary) Sets design-time data for a control.
(Inherited from Control)
SetIECompatibilityMode(Int32) static

Switches all DevExpress controls on a page to use the specified IE version.

(Inherited from ASPxWebControl)
SetIECompatibilityMode(Int32, Control) static

Obsolete. Switches all DevExpress controls on the specified page to use the specified IE version.

(Inherited from ASPxWebControl)
SetIECompatibilityModeEdge() static

Switches all DevExpress controls on a page to use the latest IE version.

(Inherited from ASPxWebControl)
SetIECompatibilityModeEdge(Control) static

Obsolete. Switches all DevExpress controls on the specified page to use the latest IE version.

(Inherited from ASPxWebControl)
SetRenderMethodDelegate(RenderMethod) Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from Control)
SetTraceData(Object, Object) Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.
(Inherited from Control)
SetTraceData(Object, Object, Object) Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.
(Inherited from Control)
ToString() Returns a string that represents the current object.
(Inherited from Object)
XtraFindFieldsItem(XtraItemEventArgs)

For internal use only.

See Also