Class ExcelSelectionMarkerMouseController

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

Inheritance

System.Object

ExcelSelectionMarkerMouseController

Implements

IMouseController

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.GridHelperClasses

Assembly: Syncfusion.GridHelperClasses.Windows.dll

Syntax

public class ExcelSelectionMarkerMouseController : 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

ExcelSelectionMarkerMouseController(GridControlBase)

Initializes a new instance of the ExcelSelectionMarkerMouseController class.

Declaration

public ExcelSelectionMarkerMouseController(GridControlBase owner)

Parameters

Type	Name	Description
GridControlBase	owner	The grid control

Properties

Cursor

Gets the cursor if previous call to HitTest was successful.

Declaration

public Cursor Cursor { get; }

Property Value

Type
System.Windows.Forms.Cursor

Name

Gets the name of the mouse controller.

Declaration

public string Name { get; }

Property Value

Type
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()

HitTest(MouseEventArgs, IMouseController)

Determines whether your controller wants to handle the mouse events based current context.

Declaration

public int HitTest(MouseEventArgs mouseEventArgs, IMouseController controller)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	mouseEventArgs	A System.Windows.Forms.MouseEventArgs holding event data..
IMouseController	controller	A IMouseController that has indicated to handle the mouse event.

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.

Remarks

The current winner of the vote is specified through the controller parameter. Your implementation of HitTest can decide if it wants to override the existing vote or leave it.

MouseDown(MouseEventArgs)

MouseDown is called when this controller signaled in HitTest that it wants to handle mouse events and the user pressed the mouse button.

Declaration

public void MouseDown(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	e	A System.Windows.Forms.MouseEventArgs holding event data.

Remarks

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.

MouseHover(MouseEventArgs)

MouseHover is called when this controller signaled in HitTest that it wants to handle mouse events. MouseHover is called after MouseHoverEnter.

Declaration

public void MouseHover(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	e	A System.Windows.Forms.MouseEventArgs.MouseEventArgs holding 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)

MouseHoverLeave is called when the hovering ends, either when user has moved mouse away from hittest area or when the user has pressed a mouse button.

Declaration

public void MouseHoverLeave(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

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.

Declaration

public void MouseUp(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	e	A System.Windows.Forms.MouseEventArgs holding event data.

Implements

IMouseController