PivotGridFieldBase.GetTotalValueText(Object) Method

Returns a formatted text representation of the specified value according to the settings used to represent the headers of column or row totals.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

public virtual string GetTotalValueText(
    object value
)

VB.NET

Public Overridable Function GetTotalValueText(
    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 the text displayed within the headers of column and row totals. This method can also be used to get the text representation of values when custom painting field values via the PivotGridControl.CustomDrawFieldValue event.

The GetTotalValueText method formats the specified value according to the settings of the PivotGridFieldBase.TotalValueFormat property.