ASPxPivotGrid.GetFieldValueByIndex(PivotGridField, Int32) Method

Returns the specified field’s value by its index.

Namespace: DevExpress.Web.ASPxPivotGrid

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

NuGet Package: DevExpress.Web

Declaration

C#

public object GetFieldValueByIndex(
    PivotGridField field,
    int fieldValueIndex
)

VB.NET

Public Function GetFieldValueByIndex(
    field As PivotGridField,
    fieldValueIndex As Integer
) As Object

Parameters

Name	Type	Description
field	PivotGridField	A PivotGridField object that represents the field which contains the required value.
fieldValueIndex	Int32	An integer value that identifies the required field value.

Returns

Type	Description
Object	An object that represents the specified field’s value.

Remarks

The GetFieldValueByIndex method can be used when handling the client-side ASPxClientPivotGrid.PopupMenuItemClick event.

Tip

Consider using the ASPxPivotGrid.GetFieldValueInfo method instead. It allows you to differentiate between the column and row areas when passing the field value index.

To obtain the field value for which the popup menu has been invoked, follow the steps below:

• handle the ASPxClientPivotGrid.PopupMenuItemClick event;
• send a callback to the server by calling the ASPxClientPivotGrid.PerformCallback method. Pass the field identifier (ASPxClientPivotMenuItemClickEventArgs.FieldID) and field value index (ASPxClientPivotMenuItemClickEventArgs.FieldValueIndex) as a string of arguments;
• handle the server-side ASPxPivotGrid.CustomCallback event, parse the passed information and obtain the required field value via the ASPxPivotGrid.GetFieldValueByIndex method.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetFieldValueByIndex(PivotGridField, Int32) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-show-a-popup-context-menus-custom-items-only-for-certain-fields-in-an-mvc-solution-t431251/CS/MvcApplication1/Helper/PivotEventHelper.cs#L18

MVCxPivotGridField clickedField = (MVCxPivotGridField)pivot.Fields[fieldID];
object filterValue = pivot.GetFieldValueByIndex(clickedField, itemIndex);
clickedField.FilterValues.ValuesIncluded = new Object[] { filterValue };