Back to Devexpress

PivotCustomDrawCellBaseEventArgs Members

windowsforms-devexpress-dot-xtrapivotgrid-dot-pivotcustomdrawcellbaseeventargs-dot-underscore-members.md

latest27.0 KB
Original Source

PivotCustomDrawCellBaseEventArgs Members

Provides data for custom painting events invoked for particular data cells.

Fields

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

Properties

NameDescription
BoundsGets the cell bounds.
ColumnCustomTotalGets the column custom total that contains the current cell.
ColumnFieldGets the innermost column field that corresponds to the current cell.
ColumnFieldIndexFor internal use.
ColumnIndexGets the visual index of the column that contains the current cell.
ColumnValueTypeGets the type of column that contains the current cell.
DataFieldGets the data field that identifies the current cell.
DisplayTextGets the display text of the current cell.
FocusedGets whether the current cell is focused.
RowCustomTotalGets the row custom total that contains the current cell.
RowFieldGets the innermost row field that corresponds to the current cell.
RowFieldIndexFor internal use.
RowIndexGets the visual index of the row that contains the current cell.
RowValueTypeGets the type of row that contains the current cell.
SelectedGets whether the current cell is selected.
SummaryTypeGets the type of summary calculated in the current cell.
SummaryValueGets values of the predefined summaries calculated for the current cell.
ThreadSafeArgsGets an event parameter that provides thread-safe access to event data.
ValueGets the current cell’s value.

Methods

NameDescription
CreateDrillDownDataSource()Returns data records used to calculate a summary value for the current cell.
CreateDrillDownDataSource()Returns data records used to calculate a summary value for the cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
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(List<String>)Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns to return. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
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, 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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
CreateDrillDownDataSource(Int32)Returns data records used to calculate a summary value for the current cell. Allows you to 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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
CreateDrillDownDataSourceAsync()Returns a list of records used to calculate a summary value for the specified cell asynchronously. Inherited from PivotCellEventArgs.
CreateDrillDownDataSourceAsync(List<String>)Returns data records used to calculate a summary value for the current cell asynchronously. Allows you to specify the columns to return. Inherited from PivotCellEventArgs.
CreateDrillDownDataSourceAsync(Int32, List<String>)Returns data records used to calculate a summary value for the current cell asynchronously. Allows you to specify the columns and limit the number of records to return. Inherited from PivotCellEventArgs.
CreateDrillDownDataSourceAsync(Int32)Returns data records used to calculate a summary value for the current cell asynchronously. Allows you to specify the columns and limit the number of records to return. Inherited from PivotCellEventArgs.
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(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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
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.
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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
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(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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
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.
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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
CreateSummaryDataSource()Returns a summary data source.
CreateSummaryDataSource()Returns a summary data source. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetCellValue(PivotGridField)Returns a cell value calculated for the current column and row field values, against the specified data field.
GetCellValue(Int32, Int32)Returns a cell value by the column and row indexes.
GetCellValue(Int32, Int32)Returns a cell value by the column and row indexes. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetCellValue(Object[], Object[], TField)Returns a cell value calculated for the specified column and row field values, against the specified data field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetCellValue(Object[], Object[], PivotGridField)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.
GetColumnFields()Returns an array of column fields that correspond to the current cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetColumnGrandTotal(TField)Returns a Column Grand Total value calculated for the current row field values, against the specified data field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetColumnGrandTotal(PivotGridField)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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetColumnGrandTotal(Object[], PivotGridField)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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetFieldValue(TField)Returns the value of the specified column or row field that identifies the column/row in which the processed cell resides. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetFieldValue(PivotGridField, Int32)Returns a field value that belongs to the specified field and corresponds to a data cell with the specified column or row index.
GetFieldValue(PivotGridField)Returns a field value that belongs to the specified field and corresponds to the current data cell.
GetGrandTotal(TField)Gets the Grand Total value for the specified field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetGrandTotal(PivotGridField)Returns the Grand Total value calculated against the specified data 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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetNextColumnCellValue(PivotGridField)Returns the value of the cell located in the next column of the current row.
GetNextRowCellValue(TField)Returns the value of the cell in the next row. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetNextRowCellValue(PivotGridField)Returns the value of the cell located in the next row of the current column.
GetPrevColumnCellValue(TField)Returns the value of the cell in the same row but in the previous column. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetPrevColumnCellValue(PivotGridField)Returns the value of the cell located in the previous column of the current row.
GetPrevRowCellValue(TField)Returns the value of the cell in the previous row. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetPrevRowCellValue(PivotGridField)Returns the value of the cell located in the previous row of the current column.
GetRowFields()Returns an array of row fields that correspond to the current cell.
GetRowFields()Returns an array of the row fields that correspond to the current cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetRowGrandTotal(TField)Returns a Row Grand Total value calculated for the current column field values, against the specified data field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetRowGrandTotal(PivotGridField)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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
GetRowGrandTotal(Object[], PivotGridField)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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
IsFieldValueExpanded(PivotGridField)Indicates whether a field value that belongs to the specified field and corresponds to the current 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. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
IsFieldValueRetrievable(PivotGridField)Gets whether the value of the specified column or row field can be retrieved for the current cell by the PivotCustomDrawCellBaseEventArgs.GetFieldValue method.
IsOthersFieldValue(TField)Indicates whether the processed data cell resides within the “Others” row/column when the Top X Value feature is enabled. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>.
IsOthersFieldValue(PivotGridField)Indicates whether the current 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

PivotCustomDrawCellBaseEventArgs Class

DevExpress.XtraPivotGrid Namespace