PivotFieldImageIndexEventArgs.GetHigherLevelFields() Method

Returns the parent field(s) for the field value being currently processed.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public PivotGridField[] GetHigherLevelFields()

VB.NET

Public Function GetHigherLevelFields As PivotGridField()

Returns

Type	Description
PivotGridField[]	An array of PivotGridField objects that are parent fields for the field value currently being processed.

Remarks

This method returns parent fields corresponding to the current field value. To get values of these fields, use the PivotFieldImageIndexEventArgs.GetHigherLevelFieldValue method.

Consider the following example:

• For the ‘1994’ and ‘Andrew Fuller’ field values, the GetHigherLevelFields method returns an empty array.
• For the ‘Qtr4’ field value, the GetHigherLevelFields method returns an array consisting of a single element referring to the Year field. The GetHigherLevelFieldValue method returns the value ‘1994’ for this field.
• For the ‘Confections’ field value in the last row, the GetHigherLevelFields method returns an array consisting of a single element referring to the Sales Person field. The GetHigherLevelFieldValue method returns the value ‘Anne Dodsworth’ for this field.

Note

If you call the GetHigherLevelFields method while an asynchronous operation is being performed, an exception will be thrown. When the operation is in progress, use the PivotFieldImageIndexThreadSafeEventArgs.GetHigherLevelFields method exposed by a thread-safe event parameter instead. To access the thread-safe event parameter, use the PivotFieldImageIndexEventArgs.ThreadSafeArgs property. To determine whether an asynchronous operation is being performed, use the pivot grid’s IThreadSafeAccessible.IsAsyncInProgress property. For more information, see Asynchronous Mode.