PivotGridFieldBase.GetDisplayText(Object) Method

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

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

public virtual string GetDisplayText(
    object value
)

VB.NET

Public Overridable 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 specified value formatted for display purposes.

Remarks

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

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetDisplayText(Object) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-create-a-custom-exporter-for-pivotgridcontrol-with-xtrareport/CS/Report_at_Runtime/PivotReportGenerator.cs#L79

foreach (PivotGridField field in pcea.GetColumnFields())
    sb.AppendFormat("{0} | ", field.GetDisplayText( pcea.GetFieldValue(field) ));//add formatting if it's necessary
if (multipleDataField)

VB.NET

winforms-create-a-custom-exporter-for-pivotgridcontrol-with-xtrareport/VB/Report_at_Runtime/PivotReportGenerator.vb#L78

For Each field As DevExpress.XtraPivotGrid.PivotGridField In pcea.GetColumnFields()
    sb.AppendFormat("{0} | ", field.GetDisplayText(pcea.GetFieldValue(field)))
Next 'add formatting if it's necessary