Class GridSelectCellsMouseController

Implements the mouse controller for selecting grid cells.

Inheritance

System.Object

GridSelectCellsMouseController

RichTextSelection

Implements

IMouseController

System.IDisposable

Namespace: Syncfusion.Windows.Controls.Grid

Assembly: Syncfusion.Grid.Wpf.dll

Syntax

public class GridSelectCellsMouseController : Object, IMouseController, IDisposable

Constructors

GridSelectCellsMouseController(GridControlBase)

Initializes a new GridSelectCellsMouseController.

Declaration

public GridSelectCellsMouseController(GridControlBase grid)

Parameters

Type	Name	Description
GridControlBase	grid	The grid control.

Properties

AdjustedRangeFunc

Gets or sets a value that adjusts the selection behavior depends on the given selection type.

Declaration

public Func<GridSelectCellsMouseController.SelectionType, int, int, GridRangeInfo, GridRangeInfo> AdjustedRangeFunc { get; set; }

Property Value

Type
System.Func<GridSelectCellsMouseController.SelectionType, System.Int32, System.Int32, GridRangeInfo, GridRangeInfo>

CurrentCell

Declaration

protected GridCurrentCell CurrentCell { get; }

Property Value

Type
GridCurrentCell

Cursor

Declaration

public Cursor Cursor { get; set; }

Property Value

Type
System.Windows.Input.Cursor

Model

Declaration

protected GridModel Model { get; }

Property Value

Type
GridModel

MouseControllerDispatcher

Declaration

protected MouseControllerDispatcher MouseControllerDispatcher { get; }

Property Value

Type
MouseControllerDispatcher

MultiExtendedShouldMoveCurrentCell

Specifies whether the current cell should be moved when doing MultiExtended selection.

Declaration

public bool MultiExtendedShouldMoveCurrentCell { get; set; }

Property Value

Type	Description
System.Boolean	True if the current cell should be moved; false otherwise.

Name

Gets the name of the mouse controller.

Declaration

public string Name { get; }

Property Value

Type
System.String

SupportsCancelMouseCapture

Allows to cancel the mouse capture.

Declaration

public bool SupportsCancelMouseCapture { get; }

Property Value

Type
System.Boolean

SupportsMouseTracking

Allows to track the mouse.

Declaration

public bool SupportsMouseTracking { get; }

Property Value

Type
System.Boolean

Methods

AutoScrollerValueChanged(Object, AutoScrollerValueChangedEventArgs)

Declaration

protected virtual void AutoScrollerValueChanged(object sender, AutoScrollerValueChangedEventArgs args)

Parameters

Type	Name	Description
System.Object	sender
AutoScrollerValueChangedEventArgs	args

CancelMode()

Cancels the grid selection.

Declaration

public void CancelMode()

Dispose()

Releases all the resources used by this component.

Declaration

public void Dispose()

ExtendSelection(GridDirectionType, Int32, GridActivateCurrentCellOptions, out Int32, out Int32)

Declaration

public void ExtendSelection(GridDirectionType direction, int num, GridActivateCurrentCellOptions options, out int rowindex, out int colindex)

Parameters

Type	Name	Description
GridDirectionType	direction
System.Int32	num
GridActivateCurrentCellOptions	options
System.Int32	rowindex
System.Int32	colindex

GridCurrentCellExternalMove(GridDirectionType, Int32, Boolean)

Declaration

protected virtual bool GridCurrentCellExternalMove(GridDirectionType direction, int num, bool extendSelection)

Parameters

Type	Name	Description
GridDirectionType	direction
System.Int32	num
System.Boolean	extendSelection

Returns

Type
System.Boolean

HitTest(MouseControllerEventArgs, IMouseController)

Checks if the mouse is over a UIElement inside a cell and if yes, it will let that UI element handle the mouse events when the user hovers mouse.

Declaration

public int HitTest(MouseControllerEventArgs mouseEventArgs, IMouseController controller)

Parameters

Type	Name	Description
MouseControllerEventArgs	mouseEventArgs	A MouseControllerEventArgs with data about the mouse event.
IMouseController	controller	The current controller requested to handle this mouse event.

Returns

Type	Description
System.Int32	Non-zero hit context value if you request to handle the mouse event; zero if you vote not to handle the mouse event.

IsHeaderRow(RowColumnIndex)

Check if the row is header row in GridDataControl

Declaration

protected virtual bool IsHeaderRow(RowColumnIndex end)

Parameters

Type	Name	Description
RowColumnIndex	end

Returns

Type
System.Boolean

MouseDown(MouseControllerEventArgs)

Occurs when the mouse is pressed in a grid cell.

Declaration

public virtual void MouseDown(MouseControllerEventArgs e)

Parameters

Type	Name	Description
MouseControllerEventArgs	e	The MouseControllerEventArgs that holds the event data.

MouseHover(MouseControllerEventArgs)

Occurs when the mouse is moved over a grid cell.

Declaration

public void MouseHover(MouseControllerEventArgs e)

Parameters

Type	Name	Description
MouseControllerEventArgs	e	The MouseControllerEventArgs that holds the event data.

MouseHoverEnter(MouseEventArgs)

Occurs when the mouse enters a grid cell.

Declaration

public void MouseHoverEnter(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e	The System.Windows.Input.MouseEventArgs that holds the event data.

MouseHoverLeave(MouseEventArgs)

Occurs when the mouse leaves the cell.

Declaration

public void MouseHoverLeave(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e	The System.Windows.Input.MouseEventArgs that holds the event data.

MouseMove(MouseControllerEventArgs)

Occurs when the mouse moves over a grid cell.

Declaration

public virtual void MouseMove(MouseControllerEventArgs e)

Parameters

Type	Name	Description
MouseControllerEventArgs	e	The MouseControllerEventArgs that holds the event data.

MouseUp(MouseControllerEventArgs)

Occurs when the mouse button is released in a grid cell.

Declaration

public virtual void MouseUp(MouseControllerEventArgs e)

Parameters

Type	Name	Description
MouseControllerEventArgs	e	The MouseControllerEventArgs that holds the event data.

ProcessSetCurrentCell(Int32, Int32, GridActivateCurrentCellOptions)

Declaration

protected virtual void ProcessSetCurrentCell(int rowIndex, int colIndex, GridActivateCurrentCellOptions flags)

Parameters

Type	Name	Description
System.Int32	rowIndex
System.Int32	colIndex
GridActivateCurrentCellOptions	flags

RestoreMode()

Restores the grid selection.

Declaration

public void RestoreMode()

ToString()

Returns the equivalent string representation of the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the current object.

Implements

IMouseController

System.IDisposable