GridControl.CustomSummaryExists Event

Enables you to specify which summaries should be calculated and displayed.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v14.2.dll

Declaration

C#

public event CustomSummaryExistEventHandler CustomSummaryExists

VB.NET

Public Event CustomSummaryExists As CustomSummaryExistEventHandler

Event Data

The CustomSummaryExists event's handler receives an argument of the CustomSummaryExistEventArgs type. The following properties provide information specific to this event:

Property	Description
Exists	Gets or sets whether the summary value should be calculated and displayed.
GroupLevel	Gets the nesting level of a group row whose summary value is being calculated.
GroupRowHandle	Gets the handle of a group row whose summary value is calculated.
IsGroupSummary	Gets whether a group summary value is calculated.
IsTotalSummary	Gets whether a total summary value is calculated.
Item	Gets a summary item whose value is calculated.

Remarks

The event is raised before a particular summary value is calculated, allowing cancellation of the calculation. To cancel summary value calculation, set the event parameter's CustomSummaryExistEventArgs.Exists parameter to false.

• Total Summary

  In this case, the CustomSummaryExistEventArgs.IsTotalSummary parameter returns true. The processed summary item is returned by the CustomSummaryExistEventArgs.Item property. If required, use the summary item's properties to identify the column where it is displayed.

• Group Summary

  In this case, the CustomSummaryExistEventArgs.IsGroupSummary parameter returns true. The CustomSummaryExistEventArgs.GroupRowHandle property identifies the group for which the summary value is about to be calculated. The processed group summary item is returned by the CustomSummaryExistEventArgs.Item property.