Class FormulaRangeSelectionController

A helper class to set up formula range selection implementing IMouseController interface to be used with MouseControllerDispatcher.

Inheritance
System.Object
FormulaRangeSelectionController
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.GridHelperClasses
Assembly: Syncfusion.GridHelperClasses.Windows.dll
Syntax
public class FormulaRangeSelectionController : IMouseController
Remarks

Any Mouse Controller needs to implement the IMouseController interface.

In its implementation of MouseController.HitTest, the mouse controller should determine whether your controller wants to handle the mouse events based current context.

Constructors

FormulaRangeSelectionController(GridControlBase)

Initializes a new instance of the FormulaRangeSelectionController class.

Declaration
public FormulaRangeSelectionController(GridControlBase grid)
Parameters
Type Name Description
GridControlBase grid

The GridControlBase.

Properties

Cursor

Gets or sets the cursor that is displayed when the mouse pointer is over the selection area while selecting.

Declaration
public Cursor Cursor { get; }
Property Value
Type Description
System.Windows.Forms.Cursor

KeyBoardRequiresControlKey

Gets or sets a value Indicating whether the user needs to press control while selecting the range with the arrow keys.

Declaration
public bool KeyBoardRequiresControlKey { get; set; }
Property Value
Type Description
System.Boolean

MouseRequiresControlKey

Gets or sets a value Indicating whether the user needs to press control while selecting the range with the mouse.

Declaration
public bool MouseRequiresControlKey { get; set; }
Property Value
Type Description
System.Boolean

Name

Gets or sets the name of the control.

Declaration
public string Name { get; }
Property Value
Type Description
System.String

ResetSelectionAfterPlacement

Gets or sets a value Indicating whether the placed text should remain selected when control is returned to the user after selecting cells.

Declaration
public bool ResetSelectionAfterPlacement { get; set; }
Property Value
Type Description
System.Boolean

SelectionColor

Gets or sets a Color used to mark the cells being selected.

Declaration
public Color SelectionColor { get; set; }
Property Value
Type Description
System.Drawing.Color

ValidPrecedingChars

Gets or sets a valid preceding characters. Default value is ValidPrecedingChars = "+-/*=(,:"

Declaration
public string ValidPrecedingChars { get; set; }
Property Value
Type Description
System.String

Methods

CancelMode()

CancelMode is called for the active controller after a MouseDown message when the mouse operation is cancelled.

Declaration
public void CancelMode()

CanDoKeySelection(GridCurrentCell)

Determines whether key selection in current cell has to be enabled.

Declaration
protected virtual bool CanDoKeySelection(GridCurrentCell cc)
Parameters
Type Name Description
GridCurrentCell cc

A current cell in grid.
Returns
Type Description
System.Boolean

A Boolean value.

CanDoSelection(GridCurrentCell)

Determines whether selection in current cell has to be enabled for specified current cell.

Declaration
protected virtual bool CanDoSelection(GridCurrentCell cc)
Parameters
Type Name Description
GridCurrentCell cc

A current cell in grid.
Returns
Type Description
System.Boolean

A Boolean value.

HitTest(MouseEventArgs, IMouseController)

HitTest is called to determine whether your controller wants to handle the mouse events based current context.

Declaration
public int HitTest(MouseEventArgs e, IMouseController controller)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs holding event data.
IMouseController controller

The mouse controller of a grid.
Returns
Type Description
System.Int32

A non-zero value if the button can and wants to handle the mouse event; 0 if the mouse event is unrelated for this button.

MouseDown(MouseEventArgs)

MouseDown is called and this controller will become the active controller and receive all subsequent mouse message until the mouse button is released or the mouse operation is cancelled.

Declaration
public void MouseDown(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs holding event data.

MouseHover(MouseEventArgs)

Performs the mouse hovering action.

Declaration
public void MouseHover(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

The System.EventArgs that contains the event data.

MouseHoverEnter()

MouseHoverEnter is called when this controller signaled in HitTest that it wants to handle mouse events. MouseHoverEnter is called before the first time MouseHover is called.

Declaration
public void MouseHoverEnter()

MouseHoverLeave(EventArgs)

Called when the hovering ends, either when user has moved mouse away from hit test area or when the user has pressed a mouse button.

Declaration
public void MouseHoverLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs that contains the event data.

MouseMove(MouseEventArgs)

MouseMove is called for the active controller after a MouseDown message when the user moves the mouse pointer.

Declaration
public void MouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs holding event data.

MouseUp(MouseEventArgs)

MouseUp is called for the active controller after a MouseDown message when the user releases the mouse button. User has release mouse button. Stop automatic scrolling.

Declaration
public void MouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs holding event data.

Implements