Class GridIndexResolver
Represents an extension class that provides resolving methods for a SfDataGrid control.
Inheritance
Namespace: Syncfusion.SfDataGrid.XForms
Assembly: Syncfusion.SfDataGrid.XForms.dll
Syntax
public static class GridIndexResolver : ObjectMethods
GetHeaderIndex(SfDataGrid)
Gets the header index in a SfDataGrid control.
Declaration
public static int GetHeaderIndex(this SfDataGrid dataGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The reference of the SfDataGrid. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The header index of the SfDataGrid. |
GetUnboundRowAtRowIndex(SfDataGrid, Int32)
Gets the UnboundRow for the specified row index.
Declaration
public static GridUnboundRow GetUnboundRowAtRowIndex(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIndex | The row index to get the UnboundRow. |
Returns
| Type | Description |
|---|---|
| GridUnboundRow | Returns the corresponding GridUnboundRow for the specified row index. |
GetUnboundRowsCount(SfDataGrid, UnboundRowsPosition, Boolean)
Gets the total number of UnboundRows in SfDataGrid according to the specified UnboundRowsPosition and summary location.
Declaration
public static int GetUnboundRowsCount(this SfDataGrid dataGrid, UnboundRowsPosition position, bool belowSummary = false)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| UnboundRowsPosition | position | Specifies the position of UnboundRows to get its count. |
| System.Boolean | belowSummary | Specifies whether the UnboundRow is placed above or below summary row. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the total number of UnboundRows in SfDataGrid. |
IsUnboundRow(SfDataGrid, Int32)
Determines whether the specified row index is associated with any UnboundRow's.
Declaration
public static bool IsUnboundRow(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIndex | The corresponding rowIndex to determine the UnboundRow. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the specified row index is UnboundRow; otherwise, false. |
ResolveStartIndexBasedOnPosition(SfDataGrid)
Gets the resolved start index based on the position of SfDataGrid control.
Declaration
public static int ResolveStartIndexBasedOnPosition(this SfDataGrid dataGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The reference of the SfDataGrid. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The resolved start index based on the position of the SfDataGrid. |
ResolveStartIndexOfGroup(SfDataGrid, Group)
Resolves the start index of the specified group.
Declaration
public static int ResolveStartIndexOfGroup(this SfDataGrid dataGrid, Group group)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The reference of the SfDataGrid. |
| Group | group | Specifies the group to get its corresponding start index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The start index of the specified group; returns -1; if the column is not grouped in SfDataGrid. |
ResolveToGridVisibleColumnIndex(SfDataGrid, Int32)
Gets the resolved visible column index for the given column index.
Declaration
public static int ResolveToGridVisibleColumnIndex(this SfDataGrid dataGrid, int columnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The reference of the SfDataGrid. |
| System.Int32 | columnIndex | The column index whose visible column index is to be determined. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The resolved visible column index for the given column index. |
ResolveToRecordIndex(SfDataGrid, Int32)
Gets the resolved record index for the given row index.
Declaration
public static int ResolveToRecordIndex(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The reference of the SfDataGrid. |
| System.Int32 | rowIndex | The index of the row. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The resolved record index of the given row index. |
ResolveToRowIndex(SfDataGrid, Int32)
Gets the resolved row index for the given record index.
Declaration
public static int ResolveToRowIndex(this SfDataGrid dataGrid, int recordIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The reference of the SfDataGrid. |
| System.Int32 | recordIndex | The record index whose row index is to be obtained. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The resolved row index form the given record index. |
ResolveToRowIndex(SfDataGrid, Object)
Gets the resolved row index for the given rowData.
Declaration
public static int ResolveToRowIndex(this SfDataGrid dataGrid, object rowData)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The reference of the SfDataGrid. |
| System.Object | rowData | The row data whose row index is to be obtained. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The resolved row index of the given row data. |
ResolveToScrollColumnIndex(SfDataGrid, Int32)
Gets the resolved scroll column index for the given column index.
Declaration
public static int ResolveToScrollColumnIndex(this SfDataGrid dataGrid, int gridColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The reference of the SfDataGrid. |
| System.Int32 | gridColumnIndex | The column index which is to be resolved to the scroll column index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The resolved scroll column index for the given column index. |
ResolveToStartColumnIndex(SfDataGrid)
Gets the resolved start column index in a SfDataGrid control.
Declaration
public static int ResolveToStartColumnIndex(this SfDataGrid dataGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The reference of the SfDataGrid. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The resolved start column index of the SfDataGrid. |
ResolveUnboundRowToRowIndex(SfDataGrid, GridUnboundRow)
Resolves row index for the specified GridUnboundRow.
Declaration
public static int ResolveUnboundRowToRowIndex(this SfDataGrid dataGrid, GridUnboundRow unboundRow)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| GridUnboundRow | unboundRow | Specifies the UnboundRow to get its corresponding row index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the row index of the specified UnboundRow. |