Class TreeGridSelectionHelper
Inheritance
Namespace: Syncfusion.UI.Xaml.TreeGrid.Helpers
Assembly: Syncfusion.SfGrid.UWP.dll
Syntax
public static class TreeGridSelectionHelper : ObjectMethods
AllowFocus(SfTreeGrid, RowColumnIndex)
Determines whether the corresponding cell in a column is focusable or not.
Declaration
public static bool AllowFocus(this SfTreeGrid treeGrid, RowColumnIndex rowColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | treeGrid | The SfTreeGrid. |
| RowColumnIndex | rowColumnIndex | The corresponding rowcolumnindex to check whether the cells in a column is focusable or not. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the cells in a column is focusable; otherwise, false. |
GetFirstColumnIndex(SfTreeGrid, FlowDirection)
Gets the index of the first column corresponding to the specified flow direction.
Declaration
public static int GetFirstColumnIndex(this SfTreeGrid treeGrid, FlowDirection flowdirection)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | treeGrid | The corresponding treeGrid to get the index of first column. |
| Windows.UI.Xaml.FlowDirection | flowdirection | Corresponding direction to get the index of first column. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the index of first column. |
GetFirstDataRowIndex(SfTreeGrid)
Gets the index of the DataRow positioned at start of the SfTreeGrid.
Declaration
public static int GetFirstDataRowIndex(this SfTreeGrid treeGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | treeGrid | The corresponding treeGrid to get index of first DataRow. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the index of first DataRow in SfTreeGrid.If the node count is zero, return -1. |
GetLastColumnIndex(SfTreeGrid, FlowDirection)
Gets the index of the last column corresponding to the specified flow direction.
Declaration
public static int GetLastColumnIndex(this SfTreeGrid treeGrid, FlowDirection flowdirection)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | treeGrid | The corresponding treeGrid to get the index of last column. |
| Windows.UI.Xaml.FlowDirection | flowdirection | Corresponding direction to get the index of last column. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the index of last column. |
GetLastDataRowIndex(SfTreeGrid)
Gets the index of the DataRow positioned at end of the SfTreeGrid.
Declaration
public static int GetLastDataRowIndex(this SfTreeGrid treeGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | treeGrid | The corresponding treeGrid to get index of last DataRow. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the index of last DataRow in SfTreeGrid. |
GetNextPageIndex(SfTreeGrid)
Gets the index of the row positioned at the end of next page that is not currently in view of SfTreeGrid.
Declaration
public static int GetNextPageIndex(this SfTreeGrid treeGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | treeGrid |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the end row index of next page. |
GetNextRowInfo(SfTreeGrid, Int32)
Gets the next row info at the specified row index in SfTreeGrid.
Declaration
public static TreeGridRowInfo GetNextRowInfo(this SfTreeGrid TreeGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | TreeGrid | The corresponding TreeGrid to get next row info. |
| System.Int32 | rowIndex | The corresponding index of row to get next row info |
Returns
| Type | Description |
|---|---|
| TreeGridRowInfo | Returns the next row info of the specified row index. |
GetPreviousPageIndex(SfTreeGrid)
Gets the index of the row positioned at the start of the previous page that is not currently in view of SfTreeGrid.
Declaration
public static int GetPreviousPageIndex(this SfTreeGrid treeGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | treeGrid |
Returns
| Type | Description |
|---|---|
| System.Int32 | The start index of previous page. |
GetPreviousRowInfo(SfTreeGrid, Int32)
Gets the previous row info at the specified row index of SfTreeGrid.
Declaration
public static TreeGridRowInfo GetPreviousRowInfo(this SfTreeGrid TreeGrid, int rowIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | TreeGrid | The corresponding TreeGrid to get previous row info. |
| System.Int32 | rowIndex | The corresponding index of row to get previous row info. |
Returns
| Type | Description |
|---|---|
| TreeGridRowInfo | Returns the previous row info of specified row index. |
GetTreeDataColumnBase(SfTreeGrid, RowColumnIndex)
Gets the TreeDataColumnBase for the given RowColumnIndex.
Declaration
public static TreeDataColumnBase GetTreeDataColumnBase(this SfTreeGrid treeGrid, RowColumnIndex rowColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | treeGrid | The corresponding treeGrid to get TreeDataColumnBase. |
| RowColumnIndex | rowColumnIndex | The corresponding rowcolumnindex to get the TreeDataColumnBase. |
Returns
| Type | Description |
|---|---|
| TreeDataColumnBase | Returns the corresponding TreeDataColumnBase for the specified rowcolumnindex. |
UpdateRowHeaderState(SfTreeGrid)
Updates the visual state of the RowHeader based on the current cell or row changed.
Declaration
public static void UpdateRowHeaderState(this SfTreeGrid treeGrid)Parameters
| Type | Name | Description |
|---|---|---|
| SfTreeGrid | treeGrid | The corresponding treeGrid to update the visual state of RowHeader. |