PivotGridControl.FieldValueDisplayText Event

Enables you to provide custom text displayed within individual field values or filter dropdown items.

Namespace: DevExpress.Xpf.PivotGrid

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

Declaration

C#

public event PivotFieldDisplayTextEventHandler FieldValueDisplayText

VB.NET

Public Event FieldValueDisplayText As PivotFieldDisplayTextEventHandler

Event Data

The FieldValueDisplayText event's handler receives an argument of the PivotFieldDisplayTextEventArgs type. The following properties provide information specific to this event:

Property	Description
CustomTotal	Gets the custom total which the currently processed column/row header corresponds to. Inherited from PivotFieldValueEventArgs.
DataField	Gets the data field which identifies the processed value. Inherited from PivotFieldValueEventArgs.
DisplayText	Gets or sets the item's display text.
Field	Gets the field being processed. Inherited from PivotFieldEventArgs.
FieldIndex	Gets the field's position among the visible fields within the header area. Inherited from PivotFieldValueEventArgs.
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 RoutedEventArgs.
IsCollapsed	Gets whether the processed field value is collapsed. Inherited from PivotFieldValueEventArgs.
IsColumn	Gets whether the field is displayed within the Column Header Area. Inherited from PivotFieldValueEventArgs.
IsOthersValue	Gets whether the current header corresponds to the "Others" row/column. Inherited from PivotFieldValueEventArgs.
IsPopulatingFilterDropdown	Gets whether the current event is called to populate the filter dropdown.
MaxIndex	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 PivotFieldValueEventArgs.
MinIndex	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 PivotFieldValueEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Selected	Gets whether the processed field value is selected. Inherited from PivotFieldValueEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.
ThreadSafeDataField	Gets the data field that identifies the processed value. Provides read-only access to field settings.
ThreadSafeField	Gets the field being processed. Provides read-only access to field settings.
Value	Gets the processed item's value.
ValueType	Gets the type of the currently processed column/row header. Inherited from PivotFieldValueEventArgs.

Remarks

Handle the FieldValueDisplayText event to do the following:

• Customize the text displayed within column or row headers (field values, totals, grand totals, etc.).

  If the FieldValueDisplayText event is raised for a field value or total header, the Field parameter identifies the corresponding column field or row field. If this event is raised for a data field header, the Field parameter identifies the corresponding data field. If the event is raised for a grand total header, the Field property returns null. To get the type of the processed header, use the PivotFieldValueEventArgs.ValueType property.

• Customize the text of items displayed within the filter dropdown. In this instance, the event parameter's PivotFieldDisplayTextEventArgs.IsPopulatingFilterDropdown property is set to true. The Field parameter returns the column, row or filter field whose dropdown has been invoked.

To specify a custom display text for a header or filter window's item, assign the required string to the PivotFieldDisplayTextEventArgs.DisplayText property.

To learn more, see Custom Formatting.

NOTE

If a field's PivotGridField.SortMode property is set to FieldSortMode.DisplayText and the pivot grid is in Asynchronous Mode, the FieldValueDisplayText event is handled in a background thread. In this instance, you cannot access the PivotFieldEventArgs.Field and PivotFieldValueEventArgs.DataField event parameter's properties. Use the PivotFieldDisplayTextEventArgs.ThreadSafeField and PivotFieldDisplayTextEventArgs.ThreadSafeDataField properties instead.