GridSummaryItem.SetSummary(SummaryItemType, String) Method

Specifies the type and display format of the summary item.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v24.1.dll

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

Declaration

C#

public void SetSummary(
    SummaryItemType summaryType,
    string displayFormat
)

VB.NET

Public Sub SetSummary(
    summaryType As SummaryItemType,
    displayFormat As String
)

Parameters

Name	Type	Description
summaryType	SummaryItemType	A SummaryItemType enumeration value specifying the summary type. This value is assigned to the GridSummaryItem.SummaryType property.
displayFormat	String	A string specifying the summary value’s display format. This value is assigned to the GridSummaryItem.DisplayFormat property.

Remarks

Please refer to the Summaries topic for detailed information on summaries.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SetSummary(SummaryItemType, String) 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-customize-footer-menu-calculate-custom-totals/CS/Form1.cs#L67

    col.SummaryItem.Tag = "Count";
    col.SummaryItem.SetSummary(DevExpress.Data.SummaryItemType.Custom, string.Empty);
}

VB.NET

winforms-grid-customize-footer-menu-calculate-custom-totals/VB/Form1.vb#L59

    col.SummaryItem.Tag = "Count"
    col.SummaryItem.SetSummary(DevExpress.Data.SummaryItemType.Custom, String.Empty)
End Sub