PivotGridFieldBase.GetValueText(Object) Method

Returns a formatted text representation of the specified value according to the settings used to format field values.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v24.1.Core.dll

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Navigation

Declaration

C#

public virtual string GetValueText(
    object value
)

VB.NET

Public Overridable Function GetValueText(
    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 that specifies the formatted text representation of the specified value.

Remarks

This method is called internally to format field values. This method can also be used to get the text representation of values when custom painting field values via the PivotGridControl.CustomDrawFieldValue event.

If the value parameter defines a NULL reference this method returns a string specified by the PivotGridFieldBase.EmptyValueText property. Otherwise, this method formats the specified value according to the settings of the PivotGridFieldBase.ValueFormat and PivotGridFieldBase.GroupInterval properties.