PivotCustomFieldValueCellsEventArgs Class

Provides data for the PivotGridControl.CustomFieldValueCells event.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public class PivotCustomFieldValueCellsEventArgs :
    PivotCustomFieldValueCellsEventArgsBase<PivotGridField, FieldValueCell>
Public Class PivotCustomFieldValueCellsEventArgs
    Inherits PivotCustomFieldValueCellsEventArgsBase(Of PivotGridField, FieldValueCell)

Remarks

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

The PivotCustomFieldValueCellsEventArgs class provides the PivotCustomFieldValueCellsEventArgsBase<T1, T2>.GetCell method used 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 PivotCustomFieldValueCellsEventArgsBase<T1, T2>.FindCell method to obtain the header whose column/row matches a specific condition.

Members of the PivotCustomFieldValueCellsEventArgs class allow you to specify the location of grand total headers. To do this, use the PivotCustomFieldValueCellsEventArgsBase.SetGrandTotalLocation method. To obtain the current location of grand total headers, use the PivotCustomFieldValueCellsEventArgsBase.GetGrandTotalLocation method.

When handling the PivotGridControl.CustomFieldValueCells event, you can also remove individual cells with their nested columns and rows. To do this, use the PivotCustomFieldValueCellsEventArgsBase.Remove method.

The PivotCustomFieldValueCellsEventArgsBase<T1, T2>.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.

See Also