Class CheckBoxRowSelectionController

Represents a class that implements the selection behaviors of SfTreeGrid when ShowCheckBox is true/>.

Inheritance
System.Object
TreeGridBaseSelectionController
TreeGridRowSelectionController
CheckBoxRowSelectionController
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class CheckBoxRowSelectionController : TreeGridRowSelectionController, ITreeGridSelectionController, IDisposable

Constructors

CheckBoxRowSelectionController(SfTreeGrid)

Initializes a new instance of CheckBoxRowSelectionController class.

Declaration
public CheckBoxRowSelectionController(SfTreeGrid treeGrid)
Parameters
Type Name Description
SfTreeGrid treeGrid

The corresponding SfTreeGrid instance.

Methods

HandleKeyDown(KeyEventArgs)

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

Declaration
public override bool HandleKeyDown(KeyEventArgs args)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs args

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

true if the key should be handled in SfTreeGrid; otherwise, false.
Overrides

HandleNodeOperations(NodeOperation)

Processes the selection when the node is expanded/collapsed in SfTreeGrid.

Declaration
protected override void HandleNodeOperations(NodeOperation NodeOperation)
Parameters
Type Name Description
NodeOperation NodeOperation

Contains the value for collection changes during expanding/collapsing action.
Overrides
Remarks

This method refreshes the selection while expanding/collapsing the node in SfTreeGrid.

HandlePointerOperations(GridPointerEventArgs, RowColumnIndex)

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

Declaration
public override 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 of the cell.
Overrides
Remarks

This method is invoked when any of the PointerOperation are performed in SfTreeGrid.

HandleSelectionPropertyChanges(SelectionPropertyChangedHandlerArgs)

Handles selection when the selection property such as SelectedIndex,SelectedItem and SelectionMode value changes occurred.

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

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

This method is invoked when the selection property values such as SelectedIndex,SelectedItem and SelectionMode are changed in SfTreeGrid.

MoveCurrentCell(RowColumnIndex, Boolean)

Moves the current cell to the specified rowColumnIndex.

Declaration
public override 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 should remove or not while moving the current cell.
Overrides
Remarks

This method is not applicable when NavigationMode is Row.

ProcessNodeCollapsed(Int32, Int32)

Processes the row selection when the node is collapsed from view.

Declaration
protected override void ProcessNodeCollapsed(int removeAtIndex, int count)
Parameters
Type Name Description
System.Int32 removeAtIndex

The corresponding index of the node that is collapsed from the view.
System.Int32 count

removed rows count.
Overrides

ProcessNodeExpanded(Int32, Int32)

Processes the row selection when the node is expanded in SfTreeGrid.

Declaration
protected override void ProcessNodeExpanded(int insertIndex, int count)
Parameters
Type Name Description
System.Int32 insertIndex

The corresponding index of the node that is expanded in to view.
System.Int32 count

inserted rows count.
Overrides

ProcessOnDoubleTapped(RowColumnIndex)

Processes the selection when the mouse point is double tapped on the particular cell in SfTreeGrid.

Declaration
protected override void ProcessOnDoubleTapped(RowColumnIndex currentRowColumnIndex)
Parameters
Type Name Description
RowColumnIndex currentRowColumnIndex

The corresponding rowColumnIndex of the mouse point.
Overrides
Remarks

This method invoked to process selection and begin edit the cell when EditTrigger is OnDoubleTap.

ProcessSelectedItemsChanged(NotifyCollectionChangedEventArgs)

Processes the row selection when the SelectedItems property value changes.

Declaration
protected override void ProcessSelectedItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
Type Name Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains data for SelectedItems collection changes.
Overrides

ProcessSelection(RowColumnIndex, RowColumnIndex, SelectionReason)

Processes the row selection for the specified row index.

Declaration
protected override bool ProcessSelection(RowColumnIndex rowColumnIndex, RowColumnIndex previousCurrentCellIndex, SelectionReason reason)
Parameters
Type Name Description
RowColumnIndex rowColumnIndex

The row column index.
RowColumnIndex previousCurrentCellIndex

The previous current cell row column index.
SelectionReason reason

Contains the reason for process selection SelectionReason.
Returns
Type Description
System.Boolean

Returns true if the selection is added to corresponding row and column index; otherwise, false.
Overrides

RefreshSelectedItems()

Refreshes the SelectedItems collection in SfTreeGrid.

Declaration
protected override void RefreshSelectedItems()
Overrides
Remarks

This method refresh the SelectedItems collection when the grid related operations performed.

SelectAll()

Selects all the rows in SfTreeGrid.

Declaration
public override void SelectAll()
Overrides
Remarks

This method only works for Multiple and Extended mode selection.

SelectRows(Int32, Int32)

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

Declaration
public override 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.
Overrides
Remarks

This method only works for Multiple and Extended mode selection.

Implements

System.IDisposable