Class GridIndexResolver
Represents an extension class that provides an set of index resolver helper methods in SfDataGrid.
Inheritance
Inherited Members
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public static class GridIndexResolverMethods
GetAddNewRowIndex(SfDataGrid)
Gets the corresponding row index of the AddNewRow.
Declaration
public static int GetAddNewRowIndex(this SfDataGrid dataGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns an index of the AddNewRow. |
GetFilterRowIndex(SfDataGrid)
Gets the corresponding row index of the FilterRow.
Declaration
public static int GetFilterRowIndex(this SfDataGrid dataGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns an index of a FilterRow. |
GetGridDetailsViewRecord(SfDataGrid, DetailsViewDataGrid)
Gets the record associated with the specified DetailsViewDataGrid.
Declaration
public static object GetGridDetailsViewRecord(this SfDataGrid dataGrid, DetailsViewDataGrid detailsViewDataGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| DetailsViewDataGrid | detailsViewDataGrid | Specifies the DetailsViewDataGrid to get its corresponding record entry. |
Returns
| Type | Description |
|---|---|
| System.Object | The record associated with the specified DetailsViewDataGrid; returns null, if the DetailsViewDataGrid is null. |
GetGridDetailsViewRowIndex(SfDataGrid, DetailsViewDataGrid)
Gets the row index of the specified DetailsViewDataGrid.
Declaration
public static int GetGridDetailsViewRowIndex(this SfDataGrid dataGrid, DetailsViewDataGrid detailsViewDataGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| DetailsViewDataGrid | detailsViewDataGrid | The DetailsViewDataGrid to get its corresponding row index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the row index of the corresponding DetailsViewDataGrid. |
GetHeaderIndex(SfDataGrid)
Gets the header index of SfDataGrid.
Declaration
public static int GetHeaderIndex(this SfDataGrid grid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | grid | The SfDataGrid. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the header index of the SfDataGrid. |
GetTableSummaryCount(SfDataGrid, TableSummaryRowPosition)
Gets the total number of table summary rows in SfDataGrid according to the specified TableSummaryRowPosition.
Declaration
public static int GetTableSummaryCount(this SfDataGrid grid, TableSummaryRowPosition position)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | grid | The SfDataGrid. |
| TableSummaryRowPosition | position | Specifies the position of table summary row to get its count. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the number of table summary rows in SfDataGrid. |
GetUnBoundRow(SfDataGrid, Int32)
Gets the UnBoundRow for the specified row index.
Declaration
public static GridUnBoundRow GetUnBoundRow(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)
Gets the total number of UnBoundRows in SfDataGrid according to the specified UnBoundRowsPosition.
Declaration
public static int GetUnBoundRowsCount(this SfDataGrid dataGrid, UnBoundRowsPosition position)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | |
| UnBoundRowsPosition | position | Specifies the position of unbound row to get its count. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the total number of UnBoundRows in SfDataGrid. |
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)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. |
IsAddNewIndex(SfDataGrid, Int32)
Determines whether the specified row index is associated with AddNewRow.
Declaration
public static bool IsAddNewIndex(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIndex | The corresponding rowIndex to determine the AddNewRow. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the specified row index is AddNewRow; otherwise , false. |
IsFilterRowIndex(SfDataGrid, Int32)
Determines whether the specified row index is associated with FilterRow.
Declaration
public static bool IsFilterRowIndex(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIndex | The corresponding rowIndex to determine the FilterRow. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the specified row index is FilterRow; otherwise , false. |
IsHeaderTableSummaryRow(SfDataGrid, Int32)
Determines whether the TableSummaryRow is at the top position of SfDataGrid for the specified row index.
Declaration
public static bool IsHeaderTableSummaryRow(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIndex | The corresponding row index to determine the position of TableSummaryRow. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the TableSummaryRow placed at the top position of SfDataGrid. |
IsInDetailsViewIndex(SfDataGrid, Int32)
Determines whether the specified row index is associated with DetailsViewDataGrid row.
Declaration
public static bool IsInDetailsViewIndex(this SfDataGrid dataGrid, int rowIdx)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIdx | The corresponding row index to determine whether the row index in Details View DataGrid. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the specified row index is Details View index; otherwise, false. |
IsTableSummaryIndex(SfDataGrid, Int32)
Determines whether the specified row index is associated with TableSummaryRow.
Declaration
public static bool IsTableSummaryIndex(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIndex | The corresponding rowIndex to determine the TableSummaryRow. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the specified row index is TableSummaryRow; otherwise, false. |
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)
Resolves the start index position in SfDataGrid.
Declaration
public static int ResolveStartIndexBasedOnPosition(this SfDataGrid dataGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns start index position in 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 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)
Resolves the visible column index for the specified column index in SfDataGrid.
Declaration
public static int ResolveToGridVisibleColumnIndex(this SfDataGrid dataGrid, int visibleColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | visibleColumnIndex | The visibleColumnIndex. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the corresponding visible column index for the specified column index. |
ResolveToGroupRecordIndexForDetailsView(SfDataGrid, Int32)
Resolves the group index for the specified row index when the SfDataGrid has Details View.
Declaration
public static int ResolveToGroupRecordIndexForDetailsView(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIndex | The corresponding row index to get group index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the group index of the specified row index when the SfDataGrid has Details View. |
ResolveToRecordIndex(SfDataGrid, Int32)
Resolves the record index corresponding to the specified row index in SfDataGrid.
Declaration
public static int ResolveToRecordIndex(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIndex | Specifies the row index to get its corresponding record index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the record index of the specified row index in SfDataGrid. |
ResolveToRowIndex(SfDataGrid, NodeEntry)
Resolves the row index corresponding to the specified node entry.
Declaration
public static int ResolveToRowIndex(this SfDataGrid DataGrid, NodeEntry nodeEntry)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | DataGrid | |
| NodeEntry | nodeEntry | Specifies the node entry to get its corresponding row index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the row index of the specified node entry. |
ResolveToRowIndex(SfDataGrid, Int32)
Resolves the row index corresponding to the specified record index in SfDataGrid.
Declaration
public static int ResolveToRowIndex(this SfDataGrid dataGrid, int recordIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | recordIndex | Specifies record index to get its corresponding row index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the row index of the specified record index in SfDataGrid. |
ResolveToRowIndex(SfDataGrid, Object)
Resolves the row index corresponding to the specified record.
Declaration
public static int ResolveToRowIndex(this SfDataGrid dataGrid, object recordItem)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Object | recordItem | Specifies the record to get its corresponding row index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the row index of the specified record. |
ResolveToScrollColumnIndex(SfDataGrid, Int32)
Resolves the scroll column index for the specified column index in SfDataGrid.
Declaration
public static int ResolveToScrollColumnIndex(this SfDataGrid dataGrid, int gridColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | gridColumnIndex | The corresponding column index to get the scroll column index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the scroll column index for the specified column index. |
ResolveToStartColumnIndex(SfDataGrid)
Resolves the start column index of the SfDataGrid.
Declaration
public static int ResolveToStartColumnIndex(this SfDataGrid dataGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the start column index of the SfDataGrid. |
ResolveToTableSummaryIndex(SfDataGrid, Int32)
Resolves the table summary index corresponding to the specified row index in SfDataGrid.
Declaration
public static int ResolveToTableSummaryIndex(this SfDataGrid dataGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfDataGrid | dataGrid | The SfDataGrid. |
| System.Int32 | rowIndex | Specifies the corresponding row index to get its table summary index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The table summary index corresponding to the specified row index ; returns -1 , if the VisualContainer of the SfDataGrid is null. |
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. |