ASPxSummaryItem.GetGroupRowDisplayText(GridViewColumn, Object) Method

Formats the specified value according to the current group row summary item’s format settings.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public string GetGroupRowDisplayText(
    GridViewColumn column,
    object value
)

VB.NET

Public Function GetGroupRowDisplayText(
    column As GridViewColumn,
    value As Object
) As String

Parameters

Name	Type	Description
column	GridViewColumn	A GridViewColumnobject that specifies the column, the values of which are aggregated by the summary.
value	Object	An object that is the summary value.

Returns

Type	Description
String	A String value that is the summary display text.

Remarks

The pattern used to format the summary value can be specified by a summary item’s ASPxSummaryItemBase.DisplayFormat or ASPxSummaryItemBase.ValueDisplayFormat property, or by the underlying column’s EditPropertiesBase.DisplayFormatString property. If no format pattern is specified explicitly, the default pattern used to format values of the predefined summary types is used (see Format Summary Value to learn more).

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetGroupRowDisplayText(GridViewColumn, 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#

asp-net-mvc-grid-display-group-summary-in-group-headers/CS/Sample/Controllers/GridGroupRowContentTemplate.cs#L91

    var summaryValue = Grid.GetGroupSummaryValue(Container.VisibleIndex, item);
    sb.Append(item.GetGroupRowDisplayText(column, summaryValue));
}

VB.NET

asp-net-mvc-grid-display-group-summary-in-group-headers/VB/Sample_VB/Controllers/GridGroupRowContentTemplate.vb#L94

    Dim summaryValue = Grid.GetGroupSummaryValue(Container.VisibleIndex, item)
    sb.Append(item.GetGroupRowDisplayText(column, summaryValue))
Next i