Back to Devexpress

PivotCellEventArgsBase<TField, TData, TCustomTotal> Members

corelibraries-devexpress-dot-xtrapivotgrid-dot-pivotcelleventargsbase-3-dot-underscore-members.md

latest11.8 KB
Original Source

PivotCellEventArgsBase<TField, TData, TCustomTotal> Members

Provides data for events which are invoked for particular cells.

Fields

NameDescription
Empty staticProvides a value to use with events that do not have event data. Inherited from EventArgs.

Properties

NameDescription
ColumnCustomTotalGets the column custom total which displays the current cell.
ColumnFieldGets the innermost column field which corresponds to the processed cell.
ColumnFieldIndexFor internal use.
ColumnIndexGets the visual index of the column that contains the processed cell.
ColumnValueTypeGets the type of column which contains the processed cell.
DataFieldGets the data field which identifies the column where the processed cell resides.
RowCustomTotalGets the row custom total which contains the current cell.
RowFieldGets the innermost row field that corresponds to the processed cell.
RowFieldIndexFor internal use.
RowIndexGets the index of the row that contains the processed cell.
RowValueTypeGets the type of row that contains the processed cell.
SummaryTypeGets the summary type of the currently processed value.
SummaryValueGets the summary value currently being processed.
ValueGets the processed cell’s value.

Methods

NameDescription
CreateDrillDownDataSource()Returns data records used to calculate a summary value for the cell.
CreateDrillDownDataSource(List<String>)Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns to return.
CreateDrillDownDataSource(Int32, List<String>)Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to return.
CreateDrillDownDataSource(Int32)Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to return.
CreateOLAPDrillDownDataSource(List<String>)Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns to be returned.
CreateOLAPDrillDownDataSource(Int32, List<String>)Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned.
CreateServerModeDrillDownDataSource(List<String>)Obsolete. In server mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns to be returned.
CreateServerModeDrillDownDataSource(Int32, List<String>)Obsolete. In server mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned.
CreateSummaryDataSource()Returns a summary data source.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetCellValue(TField)Returns a cell value calculated against the specified data field.
GetCellValue(Int32, Int32)Returns a cell value by the column and row indexes.
GetCellValue(Object[], Object[], TField)Returns a cell value calculated for the specified column and row field values, against the specified data field.
GetColumnFields()Returns an array of column fields that correspond to the current cell.
GetColumnGrandTotal(TField)Returns a Column Grand Total value calculated for the current row field values, against the specified data field.
GetColumnGrandTotal(Object[], TField)Returns a Column Grand Total value calculated for the specified row field values, against the specified data field.
GetFieldValue(TField, Int32)Returns the specified column or row field’s value for the cell, addressed by its zero-based index in the data area.
GetFieldValue(TField)Returns the value of the specified column or row field that identifies the column/row in which the processed cell resides.
GetGrandTotal(TField)Gets the Grand Total value for the specified field.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetNextColumnCellValue(TField)Returns the value of the cell in the same row but in the next column.
GetNextRowCellValue(TField)Returns the value of the cell in the next row.
GetPrevColumnCellValue(TField)Returns the value of the cell in the same row but in the previous column.
GetPrevRowCellValue(TField)Returns the value of the cell in the previous row.
GetRowFields()Returns an array of the row fields that correspond to the current cell.
GetRowGrandTotal(TField)Returns a Row Grand Total value calculated for the current column field values, against the specified data field.
GetRowGrandTotal(Object[], TField)Returns a Row Grand Total value calculated for the specified column field values, against the specified data field.
GetType()Gets the Type of the current instance. Inherited from Object.
IsFieldValueExpanded(TField)Indicates whether the specified field’s value that represents the row or column header of the processed cell is expanded.
IsFieldValueRetrievable(TField)Gets whether the value of the specified column or row field can be retrieved for the current cell by the PivotCellEventArgsBase<TField, TData, TCustomTotal>.GetFieldValue method.
IsOthersFieldValue(TField)Indicates whether the processed data cell resides within the “Others” row/column when the Top X Value feature is enabled.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ToString()Returns a string that represents the current object. Inherited from Object.

See Also

PivotCellEventArgsBase<TField, TData, TCustomTotal> Class

DevExpress.XtraPivotGrid Namespace