ASPxPivotGrid Members

Represents the ASPxPivotGrid control.

Constructors

Name Description
ASPxPivotGrid()

Initializes a new instance of the ASPxPivotGrid class.

Properties

Name Description
AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl)
AccessibilityCompliant

Enables support for Section 508.

Adapter Gets the browser-specific adapter for the control.
(Inherited from Control)
AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control)
Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from WebControl)
BackColor Gets or sets the background color of the Web server control.
(Inherited from WebControl)
BackgroundImage

Gets the web control's background image.

(Inherited from ASPxWebControl)
BackwardCompatibility static

Provides access to the control's backward compatibility settings.

(Inherited from ASPxWebControl)
Border

Gets the web control's border settings.

(Inherited from ASPxWebControl)
BorderBottom

Gets the settings of the web control's bottom border.

(Inherited from ASPxWebControl)
BorderColor

Gets or sets the border color of the web control. Use the BorderWrapper.BorderColor property instead.

(Inherited from ASPxWebControl)
BorderLeft

Gets the settings of the web control's left border.

(Inherited from ASPxWebControl)
BorderRight

Gets the settings of the web control's right border.

(Inherited from ASPxWebControl)
BorderStyle

Gets or sets the border style of the web control. Use the BorderWrapper.BorderStyle property instead.

(Inherited from ASPxWebControl)
BorderTop

Gets the settings of the web control's top border.

(Inherited from ASPxWebControl)
BorderWidth

Gets or sets the border width of the web control. Use the BorderWrapper.BorderWidth property instead.

(Inherited from ASPxWebControl)
Bound

Gets a value that specifies whether the control is data bound.

(Inherited from ASPxDataWebControlBase)
Caption

Gets or sets the text to render in an HTML caption element in an ASPxPivotGrid.

CellTemplate

Gets or sets a template to display the content of cells.

ChildControlsCreated Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control)
ClientID

Gets the control's identifier generated by ASP.NET.

(Inherited from ASPxWebControlBase)
ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property.
(Inherited from Control)
ClientIDSeparator Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control)
ClientInstanceName

Gets or sets the pivot grid's client programmatic identifier.

ClientSideEvents

Gets an object that lists the client-side events specific to the ASPxPivotGrid.

CollapsedStateStoreMode

Gets or sets how the grid stores information about the collapsed rows/columns.

ColumnCount

Gets the number of columns displayed within the ASPxPivotGrid.

Context Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control)
ControlStyle Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from WebControl)
ControlStyleCreated Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
(Inherited from WebControl)
Controls

Gets the web control's collection of child controls.

(Inherited from ASPxWebControlBase)
CssClass

Gets or sets the name of the cascading style sheet (CSS) class that specifies the ASpxPivotGrid's style.

CssFilePath

Gets or sets the path to a CSS file that defines the pivot grid's appearance.

CssPostfix

Gets or sets a CSS class name postfix that identifies style settings to be applied to the pivot grid.

Cursor

Gets or sets the type of cursor to display when the mouse pointer is over the web control.

(Inherited from ASPxWebControl)
CustomizationFieldsLeft

Gets or sets the X-coordinate of the Customization form's top-left corner.

CustomizationFieldsTop

Gets or sets the Y-coordinate of the Customization form's top-left corner.

CustomizationFieldsVisible

Gets or sets a value that specifies whether the pivot grid's Customization form is displayed within the page.

CustomizationFormImages

Gets the settings that define images displayed in the Customization Form.

Data

For internal use only.

DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer.
(Inherited from Control)
DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl.
(Inherited from Control)
DataMember

Gets or sets the name of the list of data that the data-bound control binds to, in instances where the data source contains more than one distinct list of data items.

(Inherited from ASPxDataWebControl)
DataSource

Gets or sets the object from which the data-bound control retrieves its list of data items.

DataSourceID

Gets or sets the ID of the control from which the data-bound control retrieves its list of data items.

DefaultDataProcessingEngine static

Gets or sets a default engine used to perform data processing in the pivot grid.

DisabledCssClass static Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled.
(Inherited from WebControl)
DisabledStyle

This property isn't used.

EmptyAreaTemplate

Gets or sets a template to display the content of the empty area.

EmptyImage static

Obsolete. Gets the settings of an image which is displayed by the control if the control's value is null.

(Inherited from ASPxWebControl)
EnableCallBacks

Gets or sets a value that specifies whether the callback or postback technology is used to manage round trips to the server.

EnableCallbackAnimation

Gets or sets whether a specific animation effect is used when the control content is updated via a callback.

EnableCallbackCompression

Gets or sets whether callback result compression is enabled.

EnableDefaultAppearance

Obsolete. Specifies whether to enable the control's default appearance.

(Inherited from ASPxWebControl)
EnablePagingCallbackAnimation

Gets or sets whether a specific animation effect is used when changing pages.

EnablePagingGestures

Gets or sets a value specifying whether an end-user can switch pages with a swipe gesture.

EnableRowsCache

Gets or sets whether data caching is enabled.

EnableTheming Gets or sets a value indicating whether themes apply to this control.
(Inherited from WebControl)
EnableViewState Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from Control)
Enabled

This property isn't used.

EncodeHtml

Gets or sets a value that specifies whether the control keeps any of its values that are HTML as HTML, or instead, strips out the HTML markers.

Events Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control)
FieldValueTemplate

Gets or sets a template to display the content of field value cells.

Fields

Provides access to a pivot grid's field collection.

Font Gets the font properties associated with the Web server control.
(Inherited from WebControl)
ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from WebControl)
GlobalAccessibilityCompliant static

Gets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site.

(Inherited from ASPxWebControl)
GlobalCheckReferencesToExternalScripts static

Gets or sets whether the availability and correctness of references to external client scripts (such as jQuery, jQuery UI, Knockout, etc.), which are used by certain DevExpress web controls, are checked.

(Inherited from ASPxWebControl)
GlobalEmbedRequiredClientLibraries static

Obsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources.

(Inherited from ASPxWebControl)
GlobalRightToLeft static

Gets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site.

(Inherited from ASPxWebControl)
GlobalStyleSheetTheme static

Gets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site.

(Inherited from ASPxWebControl)
GlobalTheme static

Gets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site.

(Inherited from ASPxWebControl)
GlobalThemeBaseColor static

Gets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site.

(Inherited from ASPxWebControl)
GlobalThemeFont static

Gets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site.

(Inherited from ASPxWebControl)
Groups

Gets the collection of field groups.

HasAttributes Gets a value indicating whether the control has attributes set.
(Inherited from WebControl)
HasChildViewState Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control)
HeaderTemplate

Gets or sets a template to display the content of field headers.

Height

Gets or sets the height of the web server control.

(Inherited from ASPxWebControl)
IControlBuilderAccessor.ControlBuilder For a description of this member, see ControlBuilder.
(Inherited from Control)
IControlDesignerAccessor.UserData For a description of this member, see UserData.
(Inherited from Control)
ID Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control)
IDataBindingsAccessor.DataBindings For a description of this member, see DataBindings.
(Inherited from Control)
IDataBindingsAccessor.HasDataBindings For a description of this member, see HasDataBindings.
(Inherited from Control)
IExpressionsAccessor.Expressions For a description of this member, see Expressions.
(Inherited from Control)
IExpressionsAccessor.HasExpressions For a description of this member, see HasExpressions.
(Inherited from Control)
IdSeparator Gets the character used to separate control identifiers.
(Inherited from Control)
Images

Provides access to the settings that define images displayed within the pivot grid's elements.

ImagesEditors

Provides access to the settings that define images displayed in the editors, used to edit filter values within the Prefilter Control (Filter Editor).

ImagesPrefilterControl

Provides access to the settings that define images displayed within the Prefilter (Filter Editor).

Initialized

Gets a value indicating whether the web control has been initialized.

(Inherited from ASPxWebControlBase)
IsCallback

Gets a value indicating whether the request is the result of a callback sent by the control.

(Inherited from ASPxWebControl)
IsChildControlStateCleared Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control)
IsDataBound

Gets a value indicating whether the grid is data bound.

IsDataSourceEmpty

Gets a value that identifies whether no data source is specified for the pivot grid. For internal use only.

IsPrefilterPopupVisible

Gets or sets whether the Filter Editor (Prefilter) is visible.

IsTrackingViewState Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control)
IsUpdateLocked

Gets whether the ASPxPivotGrid has been locked for updating.

IsViewStateEnabled Gets a value indicating whether view state is enabled for this control.
(Inherited from Control)
JSProperties

Enables you to supply any server data that can then be parsed on the client.

LoadViewStateByID Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control)
Loaded

Indicates whether a web control has been loaded into the Page object.

(Inherited from ASPxWebControlBase)
LockDataRefreshOnCustomCallback static

Gets or sets whether refreshing pivot grid data is locked while handling the ASPxPivotGrid.CustomCallback event.

NamingContainer Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
(Inherited from Control)
OLAPConnectionString

Specifies a connection string to a cube in an MS Analysis Services database.

OLAPDataProvider

Gets or sets which data provider should be used to bind to an OLAP cube.

OptionsBehavior

Provides access to pivot grid behavior options.

OptionsChartDataSource

Provides access to the chart options.

OptionsCustomization

Provides access to the pivot grid's customization options.

OptionsData

Provides access to the pivot grid's data specific options.

OptionsDataField

Provides access to options, which control the presentation of data fields in the ASPxPivotGrid.

OptionsFilter

Provides access to options that specify the appearance and behavior of filter windows.

OptionsLayout

Provides access to options that control how the pivot grid layout is stored to/restored from a storage (a stream or string).

OptionsLoadingPanel

Provides access to the loading panel's settings.

OptionsOLAP

Provides access to the pivot grid's OLAP mode specific options.

OptionsPager

Provides access to the pivot grid's pager options

OptionsView

Provides access to the ASPxPivotGrid control's view options.

Page Gets a reference to the Page instance that contains the server control.
(Inherited from Control)
Parent Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control)
ParentImages

This property is not in effect for the ASPxWebControl class.

(Inherited from ASPxWebControl)
ParentStyles

This property is not in effect for the ASPxWebControl class.

(Inherited from ASPxWebControl)
PreRendered

For internal use.

Prefilter

Gets the Prefilter's settings.

RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from Control)
RowCount

Gets the total number of rows displayed within the ASPxPivotGrid.

SaveStateToCookies

Gets or sets a value that specifies whether cookies are used to persist the information about the control.

SaveStateToCookiesID

Gets or sets the name (identifier) of the cookie in which the ASPxPivotGrid's state is persisted.

ScriptHelper

For internal use.

ShadowImage static

Obsolete. Gets the shadow image properties.

(Inherited from ASPxWebControl)
Site Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control)
SkinID Gets or sets the skin to apply to the control.
(Inherited from WebControl)
Style Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from WebControl)
Styles

Provides access to the style settings that control the appearance of the pivot grid's elements.

StylesEditors

Provides access to style settings that paint editors, used to edit filter values within the Filter Editor (Prefilter).

StylesFilterControl

Provides access to the style settings used to paint the Filter Editor (Prefilter).

StylesPager

Provides access to the style settings that control the appearance of the pager displayed within the pivot grid.

StylesPrint

Provides access to style settings that allow the export appearance of the pivot grid (and its visual elements) to be defined.

SummaryText

Gets or sets a value that describes the ASPxPivotGrid's contents.

SupportsDisabledAttribute Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.
(Inherited from WebControl)
TabIndex Gets or sets the tab index of the Web server control.
(Inherited from WebControl)
TagKey Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from WebControl)
TagName Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from WebControl)
TemplateControl Gets or sets a reference to the template that contains this control.
(Inherited from Control)
TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control)
Theme

Gets or sets the name of the Theme to be applied to the control.

(Inherited from ASPxWebControl)
ToolTip

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

UniqueID Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from Control)
ValidateRequestMode Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.
(Inherited from Control)
ViewState Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from Control)
ViewStateIgnoresCase Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control)
ViewStateMode Gets or sets the view-state mode of this control.
(Inherited from Control)
Visible Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from Control)
VisibleRowsOnPage

Gets the number of rows displayed on the current page.

Width

Gets or sets the ASPxPivotGrid width.

Methods

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.

Events

Name Description
AddPopupMenuItem

Enables you to customize the context menu.

AfterPerformCallback

Fires after a callback initiated by the ASPxPivotGrid control has been processed on the server side.

BeforeGetCallbackResult

Occurs after a callback sent by the current control has been processed on the server, but prior to the time the respective callback result render is formed.

BeforeLoadLayout

Occurs before a layout is restored from a storage, allowing you to cancel this action.

BeforePerformDataSelect

Occurs before the ASPxPivotGrid control obtains data from a data source.

BeginRefresh

Occurs before the control starts recalculating its data.

CallbackError static

Allows you to handle any server exception that might occur during server-side processing of a callback sent by a DevExpress web control.

(Inherited from ASPxWebControl)
ClientLayout

Enables you to save and restore the previously saved layout of the pivot grid.

ControlHierarchyCreated

Occurs after the ASPxPivotGrid's table has been created.

CustomCallback

Fires when a round trip to the server has been initiated by a call to the client ASPxClientPivotGrid.PerformCallback method.

CustomCellDisplayText

Enables custom display text to be provided for cells displayed within the Data Area.

CustomCellStyle

Allows the appearances of cells to be dynamically customized.

CustomCellValue

Allows you to replace cell values with custom ones.

CustomChartDataSourceData

Occurs when a ASPxPivotGrid prepares data to be displayed in a WebChartControl.

CustomChartDataSourceRows

Allows you to customize pivot grid data before passing it to a chart control.

CustomCustomizationFormSort

Allows you to change fields and folders order in the Customization Form.

CustomFieldSort

Provides the ability to sort data using custom rules.

CustomFieldValueCells

Allows you to customize field value cells.

CustomFilterExpressionDisplayText

Enables you to display custom text within the Prefilter panel, corresponding to the current filter expression.

CustomFilterPopupItems

Allows you to customize the filter drop-down list items.

CustomGroupInterval

Enables grouping axis values, using your own criteria.

CustomJsProperties

Enables you to supply any server data that can then be parsed on the client.

CustomLoadCallbackState

Allows you to load the ASPxPivotGrid's callback state, which was previously saved by handling the ASPxPivotGrid.CustomSaveCallbackState event.

CustomSaveCallbackState

Allows you to preserve the ASPxPivotGrid's callback state in a custom manner.

CustomServerModeSort

In OLAP and server mode, provides the capability to sort data using custom rules.

CustomSummary

Enables summary values to be calculated manually.

CustomUnboundFieldData

Enables providing data to unbound fields.

DataAreaPopupCreated

Occurs after a panel that displays data headers has been created.

DataBinding Occurs when the server control binds to a data source.
(Inherited from Control)
DataBound

Occurs after the server control binds to the data source.

(Inherited from ASPxDataWebControlBase)
DataSourceChanged

Fires when the pivot grid's data source changes.

Disposed Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from Control)
EndRefresh

Occurs after the control has completed recalculating its data.

FieldAreaChanged

Occurs after the field's location or visibility has been changed.

FieldAreaChanging

Enables you to control whether the dragged field header can be dropped at the area it's currently located over.

FieldAreaIndexChanged

Occurs when the field's PivotGridFieldBase.AreaIndex property has been changed.

FieldExpandedInFieldGroupChanged

Fires when the expansion status of fields combined into a field group is changed.

FieldFilterChanged

Occurs after a field's filter condition has been changed.

FieldFilterChanging

Allows you to customize the filter that is being applied or cancel filtering.

FieldPropertyChanged

Occurs after a field's property has been changed.

FieldUnboundExpressionChanged

Occurs after an unbound field expression has been changed.

FieldValueCollapsed

Fires after a field value has been collapsed.

FieldValueCollapsing

Enables you to control whether field values can be collapsed.

FieldValueDisplayText

Enables the display text of individual column and row headers and filter dropdown items to be customized.

FieldValueExpanded

Fires after a field value has been expanded.

FieldValueExpanding

Enables you to control whether field values can be expanded.

FieldValueNotExpanded

Occurs in OLAP mode, when an end-user clicks an expand button or selects Expand All from the context menu, and the field value cannot be expanded.

FieldVisibleChanged

Occurs after a field's visibility has been changed.

FilterControlCustomValueDisplayText

Enables you to specify the entered filter value's custom display text, to be displayed when the filter control's condition value editor is inactive.

FilterControlOperationVisibility

Enables you to dynamically hide operation items (such as the Equals, Contains, etc.) of the Filter Control's operation dropdown menu.

FilterControlParseValue

Enables you to process and modify an entered value before it is actually accepted by the filter control.

GridLayout

Fires immediately after the ASPxPivotGrid's layout has been changed.

GroupFilterChanged

Occurs after a group filter condition has been changed.

HtmlCellPrepared

Enables the settings of individual data cells to be changed.

HtmlFieldValuePrepared

Enables the settings of individual field value cells to be changed.

Init Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from Control)
LayoutUpgrade

Occurs when a layout is restored from a data store, and its version is different than that of the control's current layout version.

Load Occurs when the server control is loaded into the Page object.
(Inherited from Control)
OLAPException

Obsolete. Raised when a query processing error occurs on a bound OLAP server, or when the connection to this server is lost.

OLAPQueryData

Allows you to get a query used to obtain data in ASPxPivotGrid.

OLAPQueryTimeout

Occurs when the query time-out has expired.

PageIndexChanged

Fires after the selected page has been changed.

PopupMenuCreated

Enables you to create custom menu items.

PreRender Occurs after the Control object is loaded but prior to rendering.
(Inherited from Control)
PrefilterCriteriaChanged

Occurs when the Prefilter's criteria are changed.

QueryException

Occurs when a query processing error occurs on a bound server providing data for the ASPxPivotGrid.

Unload Occurs when the server control is unloaded from memory.
(Inherited from Control)
See Also