PivotGridControl.GetRowIndex(Object[]) Method

Returns the index of the specified row.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.2.dll

Declaration

C#

public int GetRowIndex(
    object[] values
)

VB.NET

Public Function GetRowIndex(
    values As Object()
) As Integer

Parameters

Name	Type	Description
values	Object[]	An array of row field values that identify the row.

Returns

Type	Description
Int32	An integer value that specifies the row index. -1 if the specified row has not been not found.

Remarks

Pivot Grid columns and rows are indexed as shown below:

If the specified field value array identifies several rows, the GetRowIndex method returns the smallest index.

The following table demonstrates how to use the GetRowIndex method to obtain row indexes.

C#	Visual Basic	Return Value
pivotGridControl.GetRowIndex(new object[] {"Brazil"});	pivotGridControl.GetRowIndex(New Object() {"Brazil"})	2
pivotGridControl.GetRowIndex(new object[] {"Brazil", "Rio de Janeiro"});	pivotGridControl.GetRowIndex(New Object() {"Brazil", "Rio de Janeiro"})	0
pivotGridControl.GetRowIndex(new object[] {"France", "Marseille"});	pivotGridControl.GetRowIndex(New Object() {"France", "Marseille"})	3

To obtain the index of a particular column, use the PivotGridControl.GetColumnIndex method.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetRowIndex(Object[]) 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-add-custom-field-values-rows-columns-that-are-not-present-in-a-datasource-e4493/CS/CustomDatesPivot/Form1.cs#L50

{
    int index = pivotGridControl1.GetRowIndex(new object[]{null});
    if (index!= -1)

VB.NET

how-to-add-custom-field-values-rows-columns-that-are-not-present-in-a-datasource-e4493/VB/CustomDatesPivot/Form1.vb#L45

Private Sub pivotGridControl1_CustomFieldValueCells(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PivotCustomFieldValueCellsEventArgs) Handles pivotGridControl1.CustomFieldValueCells
    Dim index As Integer = pivotGridControl1.GetRowIndex(New Object(){Nothing})
    If index<> -1 Then