GridGroupSummaryItemCollection.Add(SummaryItemType, String) Method

Adds a new summary item to the current summary collection and initializes its summary type and field name.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

[EditorBrowsable(EditorBrowsableState.Never)]
public virtual GridGroupSummaryItem Add(
    SummaryItemType summaryType,
    string fieldName
)

VB.NET

<EditorBrowsable(EditorBrowsableState.Never)>
Public Overridable Function Add(
    summaryType As SummaryItemType,
    fieldName As String
) As GridGroupSummaryItem

Parameters

Name	Type	Description
summaryType	SummaryItemType	A SummaryItemType value that is the new item’s summary type. This parameter is used to initialize the GridSummaryItem.SummaryType property.
fieldName	String	A string value that is the field’s name used to calculate the summary. This parameter is used to initialize the GridSummaryItem.FieldName property.

Returns

Type	Description
GridGroupSummaryItem	A GridGroupSummaryItem object that is a new summary item added to the collection.

Remarks

This method sets the following properties as follows:

• GridSummaryItem.DisplayFormat to an empty string.
• GridSummaryItem.Format to null.
• GridGroupSummaryItem.ShowInGroupColumnFooter to null.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Add(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-conditionally-hide-summaries-from-group-rows/CS/ConditionallyHideSumsInGroupRows/Form1.cs#L24

summaryMin = (GridGroupSummaryItem)gridView1.GroupSummary.Add(SummaryItemType.Min, "Unit Price");
summaryMax = (GridGroupSummaryItem)gridView1.GroupSummary.Add(SummaryItemType.Max, "Unit Price");

VB.NET

winforms-grid-conditionally-hide-summaries-from-group-rows/VB/ConditionallyHideSumsInGroupRows/Form1.vb#L25

Dim tmp_XViewsPrinting = New Design.XViewsPrinting(gridControl1)
summaryMin = CType(gridView1.GroupSummary.Add(SummaryItemType.Min, "Unit Price"), GridGroupSummaryItem)
summaryMax = CType(gridView1.GroupSummary.Add(SummaryItemType.Max, "Unit Price"), GridGroupSummaryItem)