Enables you to calculate summary values manually.
public event CustomSummaryEventHandler CustomSummaryCalculate
Public Event CustomSummaryCalculate As CustomSummaryEventHandler
The CustomSummaryCalculate event's data class is CustomSummaryEventArgs. The following properties provide information specific to this event:
|FieldValue||Gets the processed field value.|
|GroupLevel||Gets the nested level of the group whose summary value is being calculated.|
|GroupRowHandle||Gets a value identifying the group row whose child data rows are involved in summary calculation.|
|IsGroupSummary||Gets whether a group summary value is being calculated.|
|IsTotalSummary||Gets whether a total summary value is being calculated.|
|Item||Gets a summary item whose value is being calculated.|
|Row||Gets the currently processed row.|
|RowHandle||Gets the handle of the processed row.|
|SummaryProcess||Gets a value indicating calculation stage.|
|TotalValue||Gets or sets the total summary value.|
|TotalValueReady||Gets or sets whether the Calculation stage of the custom summary calculation process should be skipped.|
The event data class exposes the following methods:
|GetGroupSummary(Int32, Object)||Returns the value of the specified group summary for the specified group row.|
|GetValue(String)||Returns the value in the specified field|
Total summaries and group summaries provide five predefined aggregate functions. These functions allow you to calculate the number of rows, the maximum and minimum values, the sum and the average value. If you need to calculate a summary value using an aggregate function not included in the predefined set, set the summary item’s ASPxSummaryItemBase.SummaryType property to Custom and handle the CustomSummaryCalculate event.
The CustomSummaryCalculate event fires for each row involved in summary calculation. When calculating a total summary value, the event is raised for each data row (column or record). When calculating a group summary value for the ASPxGridView, the event fires for each data row within the currently processed group.
Additionally, the event is raised before and after processing rows. This can be used to perform any initialization and finalization.
- The custom summary calculation option is not available in server mode. Please refer to the Data Binding to Large Data via XPO help topic for more information.
- The CustomSummaryCalculate event is not raised on callbacks if the grid’s data is not updated.
You can use the GetValue method to get the required value in the CustomSummaryCalculate event handler.