PivotGridControl.FieldValueCollapsing Event
In This Article
Occurs when a field value is about to be collapsed, allowing cancellation of the action.
Namespace: DevExpress.Xpf.PivotGrid
Assembly: DevExpress.Xpf.PivotGrid.v24.2.dll
NuGet Package: DevExpress.Wpf.PivotGrid
#Declaration
public event PivotFieldValueCancelEventHandler FieldValueCollapsing
#Event Data
The FieldValueCollapsing event's data class is PivotFieldValueCancelEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Cancel | Gets or sets whether the field value can be expanded/collapsed. |
Custom |
Gets the custom total which the currently processed column/row header corresponds to.
Inherited from Pivot |
Data |
Gets the data field that identifies the processed value.
Inherited from Pivot |
Field |
Gets the field being processed.
Inherited from Pivot |
Field |
Gets the field’s position among the visible fields within the header area.
Inherited from Pivot |
Handled |
Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.
Inherited from Routed |
Is |
Gets whether the processed field value is collapsed.
Inherited from Pivot |
Is |
Gets whether the field is displayed within the Column Header Area.
Inherited from Pivot |
Is |
Gets whether the current header corresponds to the “Others” row/column.
Inherited from Pivot |
Max |
Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed.
Inherited from Pivot |
Min |
Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed.
Inherited from Pivot |
Original |
Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class.
Inherited from Routed |
Routed |
Gets or sets the Routed |
Selected |
Gets whether the processed field value is selected.
Inherited from Pivot |
Source |
Gets or sets a reference to the object that raised the event.
Inherited from Routed |
Value |
Gets the column field or row field value which the currently processed column/row header corresponds to.
Inherited from Pivot |
Value |
Gets the type of the currently processed column/row header.
Inherited from Pivot |
The event data class exposes the following methods:
Method | Description |
---|---|
Change |
Changes the expanded state of the field value currently being processed.
Inherited from Pivot |
Create |
Returns a list of records associated with the field value currently being processed.
Inherited from Pivot |
Create |
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 Pivot |
Create |
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 Pivot |
Create |
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 Pivot |
Get |
Returns a value displayed in the specified cell.
Inherited from Pivot |
Get |
Returns the specified column or row field’s value for the cell addressed by its zero-based index in the Data Area.
Inherited from Pivot |
Get |
Returns the parent field |
Get |
Returns the value of a specific parent field corresponding to the field value currently being processed.
Inherited from Pivot |
Invoke |
When 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 Routed |
On |
When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes.
Inherited from Routed |
#Remarks
The FieldValueCollapsing event is raised before a field value is collapsed by an end-user, allowing you to cancel this action. After the field value has been collapsed, the PivotGridControl.FieldValueCollapsed event is raised.
See Also