Back to Devexpress

PivotCellBaseEventArgs Members

wpf-devexpress-dot-xpf-dot-pivotgrid-dot-pivotcellbaseeventargs-dot-underscore-members.md

latest16.3 KB
Original Source

PivotCellBaseEventArgs Members

Provides data for the events which are 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
ColumnCustomTotalGets the custom total to which the processed cell’s column corresponds.
ColumnFieldGets the innermost column field which corresponds to the processed cell.
ColumnFieldIndexThis member supports the internal infrastructure and is not intended to be used directly from your code.
ColumnIndexGets the visual index of the column that contains the processed cell.
ColumnValueTypeGets the type of the cell’s column header.
DataFieldGets the data field which identifies the column where the processed cell resides.
DisplayTextGets the display text of the cell currently being processed.
FocusedGets whether the processed cell is the focused cell.
HandledGets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSourceGets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEventGets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
RowCustomTotalGets the custom total to which the processed cell’s row corresponds.
RowFieldGets the innermost row field which corresponds to the processed cell.
RowFieldIndexThis member supports the internal infrastructure and is not intended to be used directly from your code.
RowIndexGets the visual index of the row that contains the processed cell.
RowValueTypeGets the type of the cell’s row header.
SelectedGets whether the processed cell is selected.
SourceGets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.
SummaryTypeGets the type of summary calculated in the current cell.
SummaryValueGets the summary value currently being processed.
ValueGets the processed cell’s value.

Methods

NameDescription
CreateDrillDownDataSource()Returns a list of records used to calculate a value for the current cell.
CreateDrillDownDataSource(List<String>)Returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns to return.
CreateDrillDownDataSource(Int32, List<String>)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 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(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(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 which correspond to the processed cell.
GetColumnGrandTotal(PivotGridField)Returns a Column Grand Total value calculated for the current row field values, against the specified data field.
GetColumnGrandTotal(Object[], PivotGridField)Returns a Column Grand Total value calculated for the specified row field values, against the specified data field.
GetFieldValue(PivotGridField, Int32)Returns the specified column or row field’s value for the cell, addressed by its zero-based index in the Data Area.
GetFieldValue(PivotGridField)Returns the value of the specified column or row field which identifies the column/row in which the processed cell resides.
GetGrandTotal(PivotGridField)Gets the Grand Total for the specified field.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetNextColumnCellValue(PivotGridField)Returns the value of the cell in the same row but in the next column.
GetNextRowCellValue(PivotGridField)Returns the value of the cell in the next row.
GetPrevColumnCellValue(PivotGridField)Returns the value of the cell in the same row, but in the previous column.
GetPrevRowCellValue(PivotGridField)Returns the value of the cell in the previous row.
GetRowFields()Returns an array of row fields that correspond to the processed cell.
GetRowGrandTotal(PivotGridField)Returns a Row Grand Total value calculated for the current column field values, against the specified data field.
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.
InvokeEventHandler(Delegate, Object) protectedWhen overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
IsFieldValueExpanded(PivotGridField)Indicates whether the specified field’s value that represents a row or column header of the processed cell is expanded.
IsFieldValueRetrievable(PivotGridField)Gets whether the value of the specified column or row field can be retrieved for the current cell by the PivotCellBaseEventArgs.GetFieldValue method.
IsOthersFieldValue(PivotGridField)Indicates whether the processed data cell resides within the “Others” row/column when the Top N Value feature is enabled.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
OnSetSource(Object) protectedWhen overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.
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

PivotCellBaseEventArgs Class

DevExpress.Xpf.PivotGrid Namespace