ASPxPivotGrid.IsFieldValueCollapsed(PivotGridField, Int32) Method

Indicates whether the specified field value is collapsed.

Namespace: DevExpress.Web.ASPxPivotGrid

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

Declaration

public bool IsFieldValueCollapsed(
    PivotGridField field,
    int cellIndex
)
Public Function IsFieldValueCollapsed(
    field As PivotGridField,
    cellIndex As Integer
) As Boolean

Parameters

Name Type Description
field PivotGridField

A PivotGridField object that represents the row or column field.

cellIndex Int32

A zero-based index of a cell in the Data Area that identifies the required field value. Indices are numbered starting from the left edge for column fields, and from the top edge for row fields.

Returns

Type Description
Boolean

true if the specified field value is collapsed; otherwise, false.

Remarks

To determine whether a row field value is collapsed, specify the absolute index of the row via the cellIndex parameter. Use the ASPxPivotGrid.GetAbsoluteRowIndex method to obtain the absolute row index by its index within the current page.

Use the ASPxPivotGrid.IsObjectCollapsed method to obtain whether a row field value is collapsed by its index within the current page.

The following image shows cell indices that numerate rows and columns.

IsFieldValueCollapsed

See Also