Back to Devexpress

GridMenuItemClickEventArgs.SummaryType Property

windowsforms-devexpress-dot-xtragrid-dot-views-dot-grid-dot-gridmenuitemclickeventargs.md

latest2.7 KB
Original Source

GridMenuItemClickEventArgs.SummaryType Property

Gets the summary type which is about to be applied.

Namespace : DevExpress.XtraGrid.Views.Grid

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
public SummaryItemType SummaryType { get; set; }
vb
Public Property SummaryType As SummaryItemType

Property Value

TypeDescription
SummaryItemType

A SummaryItemType enumeration value representing the summary item type.

|

Available values:

NameDescription
Sum

The sum of all values in a column.

| | Min |

The minimum value in a column.

| | Max |

The maximum value in a column.

| | Count |

The record count.

| | Average |

The average value of a column.

| | Custom |

Specifies whether calculations should be performed manually using a specially designed event.

| | None |

Disables summary value calculation.

|

Remarks

The SummaryType property returns a valid value only if a footer cell menu item was clicked. If clicking an item of a column header or group panel menu, the SummaryType property value returns SummaryItemType.Custom.

The SummaryType property corresponds to a summary item’s GridSummaryItem.SummaryType property. It specifies the type of the aggregate function applied to column values. You can change the SummaryType property’s value to override the summary type selected by the end-user. Note that in this case you will also need to update the GridMenuItemClickEventArgs.SummaryFormat property value.

See Also

SummaryType

GridMenuItemClickEventArgs Class

GridMenuItemClickEventArgs Members

DevExpress.XtraGrid.Views.Grid Namespace