GridColumnSummaryItemCollection.Add(SummaryItemType, String, String) Method

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

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

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

VB.NET

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

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 GridColumnSummaryItem.FieldName property.
displayFormat	String	A string value that is the display format of the summary. The parameter is used to initialize the GridSummaryItem.DisplayFormat property.

Returns

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

Remarks

The GridSummaryItem.Format property is set to null.