Back to Devexpress

PivotGridControl.CustomValueAppearance Event

wpf-devexpress-dot-xpf-dot-pivotgrid-dot-pivotgridcontrol-74351832.md

latest13.6 KB
Original Source

PivotGridControl.CustomValueAppearance Event

Allows you to specify brushes used to paint field value cells.

Namespace : DevExpress.Xpf.PivotGrid

Assembly : DevExpress.Xpf.PivotGrid.v25.2.dll

NuGet Package : DevExpress.Wpf.PivotGrid

Declaration

csharp
public event PivotCustomValueAppearanceEventHandler CustomValueAppearance
vb
Public Event CustomValueAppearance As PivotCustomValueAppearanceEventHandler

Event Data

The CustomValueAppearance event's data class is PivotCustomValueAppearanceEventArgs. The following properties provide information specific to this event:

PropertyDescription
BackgroundGets or sets the brush used to paint the background of the processed field value cell.
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.
ForegroundGets or sets the brush used to paint the foreground of the processed field value 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.
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.
IsExportingGets or sets whether the pivot grid is being exported (or printed).
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.

The event data class exposes the following methods:

MethodDescription
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.
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.
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.
InvokeEventHandler(Delegate, Object)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 RoutedEventArgs.
OnSetSource(Object)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 RoutedEventArgs.

Remarks

The CustomValueAppearance event is fired for each field value cell after the PivotGridControl layout changes.

This event allows you to specify brushes used to paint the background and foreground of the processed field value cell. To do this, use the event parameter’s PivotCustomValueAppearanceEventArgs.Background and PivotCustomValueAppearanceEventArgs.Foreground properties, respectively.

Use the PivotCustomValueAppearanceEventArgs.IsExporting property to obtain whether the pivot grid is being exported (or printed). If the PivotCustomValueAppearanceEventArgs.IsExporting property returns true , brushes assigned to the PivotCustomValueAppearanceEventArgs.Background and PivotCustomValueAppearanceEventArgs.Foreground properties will affect the processed field value cell’s export (or print) appearance. Otherwise, these brushes will affect the field value cell’s display appearance.

To specify brushes used to paint summary cells, handle the PivotGridControl.CustomCellAppearance event.

See Also

PivotGridControl Class

PivotGridControl Members

DevExpress.Xpf.PivotGrid Namespace