Class GroupDragStackedHeaderMouseController

Defines an abstract base class used by GridTableControlDragHeaderMouseController and GroupDropAreaDragHeaderMouseController. It implements the IMouseController interface to be used with MouseControllerDispatcher and provides common functions for hit-testing and drag and drop functionality used by both derived classes.

Inheritance

System.Object

GroupDragStackedHeaderMouseController

Implements

IMouseController

IGridFocusHelper

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.Windows.Forms.Grid.Grouping

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public class GroupDragStackedHeaderMouseController : IMouseController, IGridFocusHelper

Constructors

GroupDragStackedHeaderMouseController()

Initializes a new instance of the GroupDragStackedHeaderMouseController class.

Declaration

public GroupDragStackedHeaderMouseController()

GroupDragStackedHeaderMouseController(GridTableControl)

Initializes a new instance of the GroupDragStackedHeaderMouseController class specified with the instance of the GridTableControl class.

Declaration

public GroupDragStackedHeaderMouseController(GridTableControl grid)

Parameters

Type	Name	Description
GridTableControl	grid	The table control associated with dragging stacked headers.

Properties

ClickCellsController

Gets the GridClickCellsMouseController which is used to forward mouse events to cell renderers.

Declaration

public GridClickCellsMouseController ClickCellsController { get; }

Property Value

Type	Description
GridClickCellsMouseController

Cursor

Gets the cursor value to be displayed.

Declaration

public virtual Cursor Cursor { get; }

Property Value

Type	Description
System.Windows.Forms.Cursor

DragHeaderVisible

Gets or sets a value indicating whether the drag header should be visible or not. Used internally.

Declaration

public bool DragHeaderVisible { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Returns boolean value to indicate drag header visible. creates the DragWindow while dragging and close the DragWindow while dropping.

Name

Gets the name of the mouse controller.

Declaration

public virtual string Name { get; }

Property Value

Type	Description
System.String

Table

Gets table associated with the grid.

Declaration

public GridTable Table { get; }

Property Value

Type	Description
GridTable

TableDescriptor

Gets the table GridTableDescriptor property values associated with the grid.

Declaration

public GridTableDescriptor TableDescriptor { get; }

Property Value

Type	Description
GridTableDescriptor

Methods

CancelMode()

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

Declaration

public virtual void CancelMode()

CheckMouseButtons(MouseEventArgs)

Determines a value that indicates whether the mouse buttons are clicked or not.

Declaration

protected virtual bool CheckMouseButtons(MouseEventArgs e)

Parameters

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

Returns

Type	Description
System.Boolean	If True the mouse buttons are clicked; Otherwise False.

GetAllowFixFocus()

Gets a value indicating whether to allow fix focus or not.

Declaration

public virtual bool GetAllowFixFocus()

Returns

Type	Description
System.Boolean	Returns False.

GetGridTableControl()

Returns the grid it is bound to.

Declaration

protected virtual GridTableControl GetGridTableControl()

Returns

Type	Description
GridTableControl	The GridTableControl

GetRedArrowIndicatorLocation(GridStackedHeaderSpan)

Gets the red arrow indicator location. Used internally.

Declaration

public Point GetRedArrowIndicatorLocation(GridStackedHeaderSpan cd)

Parameters

Type	Name	Description
Syncfusion.Windows.Forms.Grid.Grouping.GridStackedHeaderSpan	cd	The instance of the Syncfusion.Windows.Forms.Grid.Grouping.GridStackedHeaderSpan class that is associated with the drag window.

Returns

Type	Description
System.Drawing.Point	The point values of the red arrow indicator.

HitTest(MouseEventArgs, IMouseController)

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

Declaration

public virtual int HitTest(MouseEventArgs e, IMouseController controller)

Parameters

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

MouseDown(MouseEventArgs)

Triggered when the System.Windows.Forms.MouseDown event is done and the controller signaled in HitTest that it wants to handle mouse events and the user pressed the mouse button.

Declaration

public virtual void MouseDown(MouseEventArgs e)

Parameters

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

MouseHover(MouseEventArgs)

Triggered after MouseHoverEnter is called.

Declaration

public virtual void MouseHover(MouseEventArgs e)

Parameters

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

MouseHoverEnter()

Triggered before the first time MouseHover is called.

Declaration

public virtual void MouseHoverEnter()

MouseHoverLeave(EventArgs)

Triggered when hovering ends either because user dragged mouse out of the hit-test area or when context changes (e.g. user pressed the mouse button).

Declaration

public virtual void MouseHoverLeave(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgs contains the event data.

MouseMove(MouseEventArgs)

Triggered when the System.Windows.Forms.MouseMoveevent is done for the active controller after a MouseDown message when the user moves the mouse pointer.

Declaration

public virtual void MouseMove(MouseEventArgs e)

Parameters

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

MouseUp(MouseEventArgs)

Triggered when the System.Windows.Forms.MouseUp event is done for the active controller after a MouseDown message when the user releases the mouse button.

Declaration

public virtual void MouseUp(MouseEventArgs e)

Parameters

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

ResetClickCellsController()

Clears out pending state of ClickCellsController, possibly sending MouseHoverLeave or CancelMode notification to cell renderer.

Declaration

public void ResetClickCellsController()

ShouldShowDragBitmap()

Determines a value indicating whether to show the dragger bitmap or not. Used internally.

Declaration

public bool ShouldShowDragBitmap()

Returns

Type	Description
System.Boolean	True then the bitmap is displayed; Otherwise False.

ShouldShowRedArrowIndicator()

Determines a value whether to show red arrow indicator or not.

Declaration

public bool ShouldShowRedArrowIndicator()

Returns

Type	Description
System.Boolean	True if the indicator should be shown; Otherwise False.

UpdateRedArrowIndicator()

Updates the red arrow indicator. Used internally.

Declaration

public void UpdateRedArrowIndicator()

Implements

IMouseController

IGridFocusHelper