PivotGridSettings.CustomFieldValueCells Property

Allows you to customize field value cells.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v19.2.dll

Declaration

public EventHandler<PivotCustomFieldValueCellsEventArgs> CustomFieldValueCells { get; set; }
Public Property CustomFieldValueCells As EventHandler(Of PivotCustomFieldValueCellsEventArgs)

Property Value

Type Description
EventHandler<PivotCustomFieldValueCellsEventArgs>

A EventHandler<TEventArgs><PivotCustomFieldValueCellsEventArgs,> delegate method allowing you to implement custom processing.

Remarks

The CustomFieldValueCells event occurs when the layout of the PivotGrid is changed, allowing you to customize column and row headers: field value cells, data field, total and grand total headers.

Use the event parameter's PivotCustomFieldValueCellsEventArgs.GetCell method to obtain data related to an individual cell, by its index. This method returns a FieldValueCell object, which provides the data. Use the PivotCustomFieldValueCellsEventArgsBase.GetCellCount method to obtain the total number of field value cells. Column/row headers can also be identified by their column/row. Use the PivotCustomFieldValueCellsEventArgs.FindCell method to obtain the header whose column/row matches a specific condition.

The CustomFieldValueCells event allows you to specify the location of grand total headers using the PivotCustomFieldValueCellsEventArgsBase.SetGrandTotalLocation method. To obtain the current location of grand total headers, use the PivotCustomFieldValueCellsEventArgsBase.GetGrandTotalLocation method.

When handling the CustomFieldValueCells event, you can also remove individual cells with their nested columns and rows via the PivotCustomFieldValueCellsEventArgsBase.Remove method.

The PivotCustomFieldValueCellsEventArgs.Split method allows you to split field value cells that have more than one nested cell. This method splits cells that match the specified condition (or, optionally, only the first matching cell) in a custom manner defined by the FieldValueSplitData objects.

Note

Custom values provided via the PivotGridSettings.CustomCellValue, PivotGridSettings.CustomSummary and PivotGridSettings.CustomCellDisplayText events are not available when handling the CustomFieldValueCells event, because it is raised prior to these events.

See Also