PivotFieldImageIndexEventArgs.GetFieldValue(PivotGridField, Int32) Method
Returns a field value that belongs to the specified field and corresponds to a data cell with the specified column or row index.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v24.1.dll
NuGet Package: DevExpress.Win.PivotGrid
Declaration
Parameters
Name | Type | Description |
---|---|---|
field | PivotGridField | A PivotGridField object that specifies a column or row field, whose value should be obtained. |
cellIndex | Int32 | A zero-based index of a cell 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 |
---|---|
Object | The field value that belongs to the specified field and corresponds to a data cell with the specified column or row index. |
Remarks
The following image shows cell indexes numerating rows (columns are numerated in the same manner):
Specific column/row field values contain nested field values. The indexes of the nested field values lie in the range [PivotFieldImageIndexEventArgs.MinIndex; PivotFieldImageIndexEventArgs.MaxIndex].
Consider the following calls to the GetFieldValue method for the control shown in the image above:
- GetFieldValue(fieldCountry, 2) returns “Belgium”.
- GetFieldValue(fieldCountry, 3) returns “Belgium”.
- GetFieldValue(fieldCity, 3) returns “Charleroi”.
- GetFieldValue(fieldCountry, 4) returns “Belgium”.
Note
An ArgumentException is raised when the field parameter is set to null.
Note
If you call the GetFieldValue method while an asynchronous operation is being performed, an exception will be thrown. To determine whether the operation is in progress, use the pivot grid’s IThreadSafeAccessible.IsAsyncInProgress property. For more information, see Asynchronous Mode.