Back to Devexpress

PivotFieldValueCancelEventArgs Members

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

latest12.4 KB
Original Source

PivotFieldValueCancelEventArgs Members

Provides data for the PivotGridControl.FieldValueCollapsing and PivotGridControl.FieldValueExpanding events.

Fields

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

Properties

NameDescription
CancelGets or sets whether the field value can be expanded/collapsed.
CustomTotalGets the custom total which the currently processed column/row header corresponds to. Inherited from PivotFieldValueEventArgs.
DataFieldGets the data field that identifies the processed value. Inherited from PivotFieldValueEventArgs.
FieldGets the field being processed. Inherited from PivotFieldEventArgs.
FieldIndexGets the field’s position among the visible fields within the header area. Inherited from PivotFieldValueEventArgs.
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.
IsCollapsedGets whether the processed field value is collapsed. Inherited from PivotFieldValueEventArgs.
IsColumnGets whether the field is displayed within the Column Header Area. Inherited from PivotFieldValueEventArgs.
IsOthersValueGets whether the current header corresponds to the “Others” row/column. Inherited from PivotFieldValueEventArgs.
MaxIndexGets the maximum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed. Inherited from PivotFieldValueEventArgs.
MinIndexGets the minimum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed. Inherited from PivotFieldValueEventArgs.
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.
SelectedGets whether the processed field value is selected. Inherited from PivotFieldValueEventArgs.
SourceGets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.
ValueGets the column field or row field value which the currently processed column/row header corresponds to. Inherited from PivotFieldValueEventArgs.
ValueTypeGets the type of the currently processed column/row header. Inherited from PivotFieldValueEventArgs.

Methods

NameDescription
ChangeExpandedState()Changes the expanded state of the field value currently being processed. Inherited from PivotFieldValueEventArgs.
CreateDrillDownDataSource()Returns a list of records associated with the field value currently being processed. Inherited from PivotFieldValueEventArgs.
CreateDrillDownDataSource(Int32, List<String>)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. Inherited from PivotFieldValueEventArgs.
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 PivotFieldValueEventArgs.
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 PivotFieldValueEventArgs.
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(Int32, Int32)Returns a value displayed in the specified cell. Inherited from PivotFieldValueEventArgs.
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. Inherited from PivotFieldValueEventArgs.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetHigherLevelFields()Returns the parent field(s) for the field value being currently processed. Inherited from PivotFieldValueEventArgs.
GetHigherLevelFieldValue(PivotGridField)Returns the value of a specific parent field corresponding to the field value currently being processed. Inherited from PivotFieldValueEventArgs.
GetType()Gets the Type of the current instance. Inherited from Object.
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

PivotFieldValueCancelEventArgs Class

DevExpress.Xpf.PivotGrid Namespace