menu

WinForms

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

    Show / Hide Table of Contents

    Class GridCellHitTestEventArgs

    Provides data about the cancelable CellHitTest event.

    Inheritance
    System.Object
    SyncfusionCancelEventArgs
    GridCellCancelEventArgs
    GridCellHitTestEventArgs
    Inherited Members
    GridCellCancelEventArgs.RowIndex
    GridCellCancelEventArgs.ColIndex
    SyncfusionCancelEventArgs.ToString()
    Namespace: Syncfusion.Windows.Forms.Grid
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public sealed class GridCellHitTestEventArgs : GridCellCancelEventArgs
    Remarks

    GridCellHitTestEventArgs is a custom event argument class used by the CellHitTest event when the grid performs hit testing of a mouse point inside a cell.

    The event method is called before the cell renderer does its own hit-testing. If you want to provide your own hit-test value for the cell, you should assign the resulting value to Result and set System.ComponentModel.CancelEventArgs.Cancel to True.

    Constructors

    GridCellHitTestEventArgs(Int32, Int32, MouseEventArgs, IMouseController, GridCellButton, Int32)

    Initializes a new object.

    Declaration
    public GridCellHitTestEventArgs(int rowIndex, int colIndex, MouseEventArgs mouseEventArgs, IMouseController controller, GridCellButton cellButton, int result)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    System.Windows.Forms.MouseEventArgs mouseEventArgs

    The System.Windows.Forms.MouseEventArgs originating this event.

    IMouseController controller

    The current controller that requested to handle this mouse event.

    GridCellButton cellButton

    The cell button that is the target of the current mouse operation or NULL if the cell itself is the target.

    System.Int32 result

    Non-zero hit context value if you request to handle the mouse event; zero if you vote not to handle the mouse event.

    Properties

    CellButton

    Gets the cell button that is the target of the current mouse operation or NULL if the cell itself is the target.

    Declaration
    [TraceProperty(true)]
    public GridCellButton CellButton { get; }
    Property Value
    Type Description
    GridCellButton

    Controller

    Gets the current controller that requested to handle this mouse event.

    Declaration
    [TraceProperty(true)]
    public IMouseController Controller { get; }
    Property Value
    Type Description
    IMouseController

    MouseEventArgs

    Gets the System.Windows.Forms.MouseEventArgs originating this event.

    Declaration
    [TraceProperty(true)]
    public MouseEventArgs MouseEventArgs { get; }
    Property Value
    Type Description
    System.Windows.Forms.MouseEventArgs

    Result

    Gets or sets the non-zero hit context value if you request to handle the mouse event; zero if you vote not to handle the mouse event.

    Declaration
    [TraceProperty(true)]
    public int Result { get; set; }
    Property Value
    Type Description
    System.Int32

    See Also

    GridCellHitTestEventHandler
    CellHitTest
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved