Class GroupDragHeaderMouseControllerBase

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

GroupDragHeaderMouseControllerBase

GridTableControlDragHeaderMouseController

GroupDropAreaDragHeaderMouseController

Implements

IMouseController

IGridFocusHelper

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

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public abstract class GroupDragHeaderMouseControllerBase : IMouseController, IGridFocusHelper

Constructors

GroupDragHeaderMouseControllerBase()

Initializes a new instance of the GroupDragHeaderMouseControllerBase class.

Declaration

public GroupDragHeaderMouseControllerBase()

GroupDragHeaderMouseControllerBase(GridTableControl)

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

Declaration

public GroupDragHeaderMouseControllerBase(GridTableControl grid)

Parameters

Type	Name	Description
GridTableControl	grid	The instance of the GridTableControl class.

Properties

ClickCellsController

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

Declaration

public GridClickCellsMouseController ClickCellsController { get; }

Property Value

Type
GridClickCellsMouseController

Cursor

Gets the cursor to be displayed.

Declaration

public virtual Cursor Cursor { get; }

Property Value

Type
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
System.Boolean

Remarks

Returns boolean value to indicate drag header visible. Creates the DragWindow while dragging and closes the DragWindow while dropping.

GridGroupDropArea

Gets the instance of the GridGroupDropArea associated with the grid.

Declaration

public GridGroupDropArea GridGroupDropArea { get; }

Property Value

Type
GridGroupDropArea

Name

Gets the name of the mouse controller.

Declaration

public virtual string Name { get; }

Property Value

Type
System.String

Table

Gets the instance of the GridTable associated with the grid.

Declaration

public GridTable Table { get; }

Property Value

Type
GridTable

TableDescriptor

Gets the instance of the GridTableDescriptor associated with the grid.

Declaration

public GridTableDescriptor TableDescriptor { get; }

Property Value

Type
GridTableDescriptor

Methods

CancelMode()

Triggered when the current mouse operation is canceled.

Declaration

public virtual void CancelMode()

CheckMouseButtons(MouseEventArgs)

Determines a value indicating whether the mouse button had 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	True if the mouse button is clicked; Otherwise False.

GetAllowFixFocus()

Determines a value indicating whether the allow fixfocus is enabled or not.

Declaration

public virtual bool GetAllowFixFocus()

Returns

Type	Description
System.Boolean	Returns False.

GetColumnDescriptorAtMousePosition()

Gets column descriptor under the mouse position. Gets null if there is no header drawn below mouse.

Declaration

public GridColumnDescriptor GetColumnDescriptorAtMousePosition()

Returns

Type	Description
GridColumnDescriptor	The column descriptor.

GetGridTableControl()

Gets the grid table control which is bound to the group drop area.

Declaration

protected virtual GridTableControl GetGridTableControl()

Returns

Type	Description
GridTableControl	The instance of the GridTableControl class.

GetRedArrowIndicatorLocation(Boolean, GridColumnDescriptor)

Gets the red arrow indicator location. Used internally.

Declaration

public Point GetRedArrowIndicatorLocation(bool inGroupDropArea, GridColumnDescriptor cd)

Parameters

Type	Name	Description
System.Boolean	inGroupDropArea	True if the position is in group drop area.
GridColumnDescriptor	cd	The instance of the GridColumnDescriptor class that gets associated with the grid.

Returns

Type	Description
System.Drawing.Point	The point value.

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.

IsMouseOverGroupDropArea()

Determines a value indicating whether the mouse over event is performed on the group drop area or not.

Declaration

public bool IsMouseOverGroupDropArea()

Returns

Type	Description
System.Boolean	True if mouse is over GroupDropArea; Otherwise False.

MouseDown(MouseEventArgs)

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

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 the System.Windows.Forms.Control.MouseHover event is done.

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 the mouse hover ends either the 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.Control.MouseMove event 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.Control.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 the bitmap for dragging should be shown or not. Used internally.

Declaration

public bool ShouldShowDragBitmap()

Returns

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

ShouldShowRedArrowIndicator()

Determines a value indicating whether on mouse position the red arrow indicator should be shown or not.

Declaration

public bool ShouldShowRedArrowIndicator()

Returns

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

ShouldShowRemoveCursor()

Determines a value indicating whether the mouse position of removing cursor should be shown or not.

Declaration

public bool ShouldShowRemoveCursor()

Returns

Type	Description
System.Boolean	True if remove cursor should be shown; Otherwise False.

UpdateRedArrowIndicator()

Creates the red arrow indicator and update the location of red arrow indicator to show while dragging. Internal only.

Declaration

public void UpdateRedArrowIndicator()

Implements

IMouseController

IGridFocusHelper