Interface ITreeGridSelectionController

Provides the common functionality of selection behavior in SfTreeGrid.

Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.SfGrid.UWP.dll
Syntax
public interface ITreeGridSelectionController : IDisposable

Properties

CurrentCellManager

Gets the reference to the TreeGridCurrentCellManager instance which holds the current cell information.

Declaration
TreeGridCurrentCellManager CurrentCellManager { get; }
Property Value
Type
TreeGridCurrentCellManager

SelectedRows

Returns the collection of TreeGridRowInfo that contains the information of selected rows.

Declaration
TreeGridSelectedRowsCollection SelectedRows { get; }
Property Value
Type
TreeGridSelectedRowsCollection

Methods

ClearSelections(Boolean)

Clears all the selected rows in SfTreeGrid.

Declaration
void ClearSelections(bool exceptCurrentRow)
Parameters
Type Name Description
System.Boolean exceptCurrentRow

Decides whether the current row or cell selection should be removed while clearing the selections from SfTreeGrid.

HandleCollectionChanged(NotifyCollectionChangedEventArgs, TreeGridCollectionChangedReason)

Handles the selection when the collection is changed.

Declaration
void HandleCollectionChanged(NotifyCollectionChangedEventArgs e, TreeGridCollectionChangedReason reason)
Parameters
Type Name Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs
TreeGridCollectionChangedReason reason

Contains the TreeGridCollectionChangedReason for collection changes.

HandleGridOperations(TreeGridOperationsHandlerArgs)

Handles the selection when any of the TreeGridOperation such as Sorting are performed in SfTreeGrid.

Declaration
void HandleGridOperations(TreeGridOperationsHandlerArgs args)
Parameters
Type Name Description
TreeGridOperationsHandlerArgs args

The TreeGridOperationsHandlerArgs that contains the type of grid operations and its arguments.

HandleKeyDown(KeyRoutedEventArgs)

Handles the selection when the keyboard interactions that are performed in SfTreeGrid.

Declaration
bool HandleKeyDown(KeyRoutedEventArgs args)
Parameters
Type Name Description
Windows.UI.Xaml.Input.KeyRoutedEventArgs args

Contains information about the key that was pressed.
Returns
Type Description
System.Boolean

true if the key was processed; otherwise, false.

HandleNodeExpandCollapse(Int32, Int32, Boolean)

Handles the when the node is expanded or collapsed in SfTreeGrid.

Declaration
void HandleNodeExpandCollapse(int index, int count, bool isExpanded)
Parameters
Type Name Description
System.Int32 index

The corresponding index of the node.
System.Int32 count

The number of rows that are collapsed or expanded.
System.Boolean isExpanded

Specifies whether the node is expanded or not.

HandlePointerOperations(GridPointerEventArgs, RowColumnIndex)

Handles the selection when any of the PointerOperation such as pressed,released,moved,and etc that are performed in SfTreeGrid.

Declaration
void HandlePointerOperations(GridPointerEventArgs args, RowColumnIndex rowColumnIndex)
Parameters
Type Name Description
GridPointerEventArgs args

The GridPointerEventArgs that contains the type of pointer operations and its arguments.
RowColumnIndex rowColumnIndex

The corresponding rowColumnIndex.

HandleSelectionPropertyChanges(SelectionPropertyChangedHandlerArgs)

Handles the selection when any of the selection property such as SelectedIndex,SelectedItem and SelectionMode values changed.

Declaration
void HandleSelectionPropertyChanges(SelectionPropertyChangedHandlerArgs handle)
Parameters
Type Name Description
SelectionPropertyChangedHandlerArgs handle

The SelectionPropertyChangedHandlerArgs that contains the corresponding property name and its value changes.

MoveCurrentCell(RowColumnIndex, Boolean)

Moves the current cell to the specified rowColumnIndex.

Declaration
void MoveCurrentCell(RowColumnIndex rowColumnIndex, bool needToClearSelection = true)
Parameters
Type Name Description
RowColumnIndex rowColumnIndex

Specifies the corresponding rowColumnIndex to move the current cell.
System.Boolean needToClearSelection

Decides whether the current row selection need to be cleared while moving the current cell.

SelectAll()

Selects all the rows in SfTreeGrid.

Declaration
void SelectAll()

SelectRows(Int32, Int32)

Selects the rows corresponding to the specified start and end index of the row.

Declaration
void SelectRows(int startRowIndex, int endRowIndex)
Parameters
Type Name Description
System.Int32 startRowIndex

The start index of the row.
System.Int32 endRowIndex

The end index of the row.

Extension Methods