WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridCellButtonClickedEventArgs - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridCellButtonClickedEventArgs

    Provides data about the cancelable CellButtonClicked event when the user clicks on a cell button element inside a cell.

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

    GridCellButtonClickedEventArgs is a custom event argument class used by the CellButtonClicked event when the user clicks on a cell button element inside a cell.

    The event method is called before the cell renderer processes the event (and moves the current cell, drops down a list box, etc.). If you want to abort the current operation at run-time you should assign True to System.Windows.Forms.Control.CancelEventArgs.Cancel.

    Otherwise the OnButtonClicked(Int32, Int32, Int32) method of the associated cell renderer is called which will then trigger any actions related to the button.

    Constructors

    GridCellButtonClickedEventArgs(Int32, Int32, Int32, GridCellButton)

    Initializes a new instances for GridCellButtonClickedEventArgs

    Declaration
    public GridCellButtonClickedEventArgs(int rowIndex, int colIndex, int buttonIndex, GridCellButton button)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    System.Int32 buttonIndex

    The index of the clicked cell button element.

    GridCellButton button

    A reference to the GridCellButton for the clicked button.

    Properties

    Button

    Gets a reference to the GridCellButton for the clicked button.

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

    ButtonIndex

    Gets the index of the clicked cell button element.

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

    See Also

    GridCellButtonClickedEventHandler
    CellButtonClicked
    OnButtonClicked(System.Int32, System.Int32, System.Int32)
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved