PivotGridField.GetDisplayText(Object) Method

Returns the display representation of the specified value, according to the settings used to format field values.

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public string GetDisplayText(
    object value
)

VB.NET

Public Function GetDisplayText(
    value As Object
) As String

Parameters

Name	Type	Description
value	Object	An object which identifies the value to format.

Returns

Type	Description
String	A String value that represents the formatted value.

Remarks

The GetDisplayText method fires the PivotGridControl’s PivotGridControl.FieldValueDisplayText event, allowing you to provide a custom text for the specified value.

The settings used to format field values are specified via the PivotGridField.ValueFormat property.