TcxDataSummaryItems.Add(TObject,TcxSummaryPosition,TcxSummaryKind,string) Method

Adds a new summary item with specified settings and adds the item to the collection.

Declaration

function Add(AItemLink: TObject; APosition: TcxSummaryPosition; AKind: TcxSummaryKind; const AFormat: string = ''): TcxDataSummaryItem; overload;

Parameters

Name	Type	Description
AItemLink	TObject	The target data item. Pass a TcxGridColumn descendant instance as the parameter. This parameter value initializes the ItemLink property of the created summary item.
APosition	TcxSummaryPosition	The target position of the created summary item. This parameter value initializes the Position property of the created summary item.
AKind	TcxSummaryKind	The required summary calculation algorithm. This parameter value initializes the Kind property of the created summary item.
AFormat	string	Optional. The formatting pattern for the created summary item’s display text. This parameter value initializes the Format property of the created summary item.

Returns

Type	Description
TcxDataSummaryItem	The created summary item. Different summary item collection types create corresponding items. You may need to cast the returned object to the corresponding terminal [TcxDataSummaryItem] class descendant to access all public API members. Tip Call the returned object’s ClassType function to identify the actual type of the created summary item.

Remarks

Call the Add function to create a summary item with the required settings. You can use the Items property to access all summary items in the collection.