GridSummaryItem.GetDisplayText(Object, Boolean) Method

Formats the specified value using the summary item’s format settings.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public virtual string GetDisplayText(
    object value,
    bool fullForm
)

VB.NET

Public Overridable Function GetDisplayText(
    value As Object,
    fullForm As Boolean
) As String

Parameters

Name	Type	Description
value	Object	A Object representing the value to be formatted.
fullForm	Boolean	true if the formatted string should contain static text identifying the summary item type; otherwise, false.

Returns

Type	Description
String	A string representing the specified value formatted with respect to the summary item’s format settings.

Remarks

The GetDisplayText method formats the specified value using the summary item’s GridSummaryItem.DisplayFormat property value. If this property value is an empty string, the format string used by the GetDisplayText method is returned by the GridSummaryItem.GetDisplayFormatByType method.

Note that if the specified value is formatted using the GridSummaryItem.DisplayFormat property value, the fullForm parameter value is ignored. Otherwise, this parameter value is passed to the GridSummaryItem.GetDisplayFormatByType method to obtain a proper format string.

Please refer to the Working with Summaries in Code. Custom Summaries topic for details on getting summary items’ values and display texts.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetDisplayText(Object, Boolean) 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-grid-show-multiple-group-summaries-in-group-footer-cell/CS/MultiGroupSummary/MyGridControl/MyGridViewInfo.cs#L86

    fci.Value = dEntry.Value;
    fci.DisplayText = ((GridSummaryItem)dEntry.Key).GetDisplayText(dEntry.Value, false);
}

VB.NET

winforms-grid-show-multiple-group-summaries-in-group-footer-cell/VB/MultiGroupSummary/MyGridControl/MyGridViewInfo.vb#L91

    fci.Value = dEntry.Value
    fci.DisplayText = DirectCast(dEntry.Key, GridSummaryItem).GetDisplayText(dEntry.Value, False)
End Sub