menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridDragSelectMouseController - API Reference

    Show / Hide Table of Contents

    Class GridDragSelectMouseController

    Implements the dragging of selected rows or columns in a grid control.

    Inheritance
    System.Object
    NonFinalizeDisposable
    GridSubComponent
    GridMouseController
    GridDragSelectMouseController
    Implements
    System.IDisposable
    IMouseController
    IGridFocusHelper
    Inherited Members
    GridSubComponent.Grid
    NonFinalizeDisposable.Dispose()
    NonFinalizeDisposable.Dispose(Boolean)
    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
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public class GridDragSelectMouseController : GridMouseController, IDisposable, IMouseController, IGridFocusHelper

    Constructors

    GridDragSelectMouseController(GridControlBase)

    Initializes a new instance for GridDragSelectMouseController and attaches it to a grid.

    Declaration
    public GridDragSelectMouseController(GridControlBase Grid)
    Parameters
    Type Name Description
    GridControlBase Grid

    The grid control.

    Properties

    Cursor

    The cursor to be displayed.

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

    Name

    The name of this mouse controller.

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

    Methods

    CancelMode()

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

    Declaration
    public override void CancelMode()
    Overrides
    GridMouseController.CancelMode()

    GetAllowFixFocus()

    Override this method in your GridMouseController and return False if it would interfere with your controller's state when the current cell would be focused and possibly scrolled into view.

    Declaration
    public override bool GetAllowFixFocus()
    Returns
    Type Description
    System.Boolean

    A System.Boolean (True by default) that indicates if the grid is allowed to set the focus onto the current cells System.Windows.Forms.Control.

    Overrides
    GridMouseController.GetAllowFixFocus()

    HitTest(MouseEventArgs, IMouseController)

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

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

    A MouseEventArgs holding event data.

    IMouseController controller

    A mouse controller.

    Returns
    Type Description
    System.Int32

    A non-zero value if the controller can and wants to handle the mouse event; 0 otherwise.

    Overrides
    GridMouseController.HitTest(MouseEventArgs, IMouseController)
    Remarks

    The current winner of the vote is specified through the controller paramter. 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 override void MouseDown(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseEventArgs e

    A MouseEventArgs holding event data.

    Overrides
    GridMouseController.MouseDown(MouseEventArgs)
    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 override void MouseHover(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseEventArgs e

    A MouseEventArgs holding event data.

    Overrides
    GridMouseController.MouseHover(MouseEventArgs)

    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 override void MouseHoverEnter()
    Overrides
    GridMouseController.MouseHoverEnter()

    MouseHoverLeave(EventArgs)

    MouseHoverLeave is called 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 override void MouseHoverLeave(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    A reference to System.EventArgs holding event data.

    Overrides
    GridMouseController.MouseHoverLeave(EventArgs)

    MouseMove(MouseEventArgs)

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

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

    A MouseEventArgs holding event data.

    Overrides
    GridMouseController.MouseMove(MouseEventArgs)

    MouseUp(MouseEventArgs)

    MouseUp is called for the active controller after a MouseDown message when the user releases the mouse button.

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

    A MouseEventArgs holding event data.

    Overrides
    GridMouseController.MouseUp(MouseEventArgs)

    Implements

    System.IDisposable
    IMouseController
    IGridFocusHelper
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved