Skip to main content

ASPxPivotGrid.IsObjectCollapsed(PivotGridField, Int32) Method

Returns whether the specified column field value or row field value is collapsed.

Namespace: DevExpress.Web.ASPxPivotGrid

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

NuGet Package: DevExpress.Web

#Declaration

public bool IsObjectCollapsed(
    PivotGridField field,
    int lastLevelIndex
)

#Parameters

Name Type Description
field PivotGridField

A PivotGridField object that identifies a column field or row field.

lastLevelIndex Int32

A zero-based index of a cell in the data area that identifies the required field value. Indexes 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 column field value or row field value is collapsed; otherwise, false.

#Remarks

To obtain whether a row field value is collapsed, use the lastLevelIndex parameter to specify the index of the corresponding row within the current page.

Use the ASPxPivotGrid.IsFieldValueCollapsed method to obtain whether a row field value is collapsed by its absolute index.

The following image shows cell indexes numerating rows (columns are numerated in the same manner):

CellIndexes

In this example, the IsObjectCollapsed method will return:

  • False for the Country field and cell’s index=0;
  • True for the Country field and cell’s index=1;
  • True for the City field and cell’s index=1;
See Also