CustomSummaryExistEventArgs Class

Provides data for the GridView.CustomSummaryExists event.

Namespace: DevExpress.Data

Assembly: DevExpress.Data.v19.2.dll

Declaration

public class CustomSummaryExistEventArgs :
    EventArgs
Public Class CustomSummaryExistEventArgs
    Inherits EventArgs

Remarks

The GridView.CustomSummaryExists event allows you to prevent certain summaries from being calculated and displayed. Thus, it is raised when a total summary is about to be calculated or when a group summary is about to be calculated for a particular group. Summary kind can be determined using the CustomSummaryExistEventArgs.IsTotalSummary and CustomSummaryExistEventArgs.IsGroupSummary properties of the event argument (a CustomSummaryExistEventArgs object). When processing a group summary, the group whose summary value is about to be calculated can be identified using the CustomSummaryExistEventArgs.GroupRowHandle property. To prevent summary value calculations, set the CustomSummaryExistEventArgs.Exists property to false.

Note: use the CustomSummaryExistEventArgs.Item property to access the summary item providing summary calculation settings.

CustomSummaryExistEventArgs objects are automatically created and passed to GridView.CustomSummaryExists event handlers.

Inheritance

Object
EventArgs
CustomSummaryExistEventArgs
See Also