PivotCustomDrawBaseThreadSafeEventArgs.GetFieldByArea(PivotArea, Int32) Method

Returns a field located at the specified visual position in the specified area.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public IThreadSafeField GetFieldByArea(
    PivotArea area,
    int index
)
Public Function GetFieldByArea(
    area As PivotArea,
    index As Integer
) As IThreadSafeField

Parameters

Name Type Description
area PivotArea

A PivotArea value that identifies the area containing the required field.

index Int32

An integer value that specifies the visible index of the field within the specified area.

Returns

Type Description
IThreadSafeField

An object that implements the IThreadSafeField interface. Provides thread safe read-only access to basic field settings.

Remarks

If the specified field index is out of range, the GetFieldByArea method returns null (Nothing in Visual Basic). To obtain the number of fields in a particular area, use the pivot grid's IThreadSafeAccessible.GetFieldCountByArea method.

NOTE

Hidden fields cannot be addressed by the GetFieldByArea method.

To obtain a list of fields located in a specific area, use the PivotCustomDrawBaseThreadSafeEventArgs.GetFieldsByArea method.

See Also