menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ContextMenuOpenEventArgs<T> - API Reference

    Show / Hide Table of Contents

    Class ContextMenuOpenEventArgs<T>

    Provides information about an ContextMenuOpen event.

    Inheritance
    System.Object
    GridEventBaseArgs
    ContextMenuOpenEventArgs<T>
    Inherited Members
    GridEventBaseArgs.PreventRender
    Namespace: Syncfusion.Blazor.Grids
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class ContextMenuOpenEventArgs<T> : GridEventBaseArgs
    Type Parameters
    Name Description
    T

    TValue of the grid component.

    Constructors

    ContextMenuOpenEventArgs()

    Declaration
    public ContextMenuOpenEventArgs()

    Properties

    Cancel

    Gets or sets a value indicating whether to prevent the context menu from rendering in the grid.

    Declaration
    public bool Cancel { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false. If the Cancel property is set to true, then the context menu will not be rendered.

    Column

    Gets the GridColumn where the context menu is currently open in the grid.

    Declaration
    public GridColumn Column { get; }
    Property Value
    Type Description
    GridColumn

    The grid column instance where the context menu is currently open.

    ContextMenu

    Gets the instance of the SfContextMenu<TValue> component used to display the context menu.

    Declaration
    public SfContextMenu<MenuItem> ContextMenu { get; }
    Property Value
    Type Description
    SfContextMenu<MenuItem>

    The SfContextMenu<TValue> instance used to display the context menu.

    ContextMenuObj

    Gets the instance of the SfContextMenu<TValue> component used to display the context menu.

    Declaration
    public SfContextMenu<MenuItem> ContextMenuObj { get; }
    Property Value
    Type Description
    SfContextMenu<MenuItem>

    The SfContextMenu<TValue> instance used to display the context menu.

    Element

    Gets the Microsoft.AspNetCore.Components.ElementReference of the current target element where the context menu is opened.

    Declaration
    public ElementReference Element { get; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.ElementReference

    Event

    Gets the details about either a Microsoft.AspNetCore.Components.Web.MouseEventArgs or Microsoft.AspNetCore.Components.Web.KeyboardEventArgs event.

    Declaration
    public object Event { get; }
    Property Value
    Type Description
    System.Object

    The event object. It can be either a mouse event or keyboard event.

    Items

    Gets or sets the list of MenuItemModel that are displayed in the context menu.

    Declaration
    public List<MenuItemModel> Items { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<MenuItemModel>

    The list of menu items that are displayed in the context menu.

    Left

    Gets the left position of the context menu relative to the document or container.

    Declaration
    public double Left { get; set; }
    Property Value
    Type Description
    System.Double

    The left position of the context menu relative to the document or container.

    Name

    Gets the name of the event that is raised when the context menu is opened.

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

    The name of the event that is raised when the context menu is opened.

    ParentItem

    Gets or sets the parent MenuItemModel of the currently clicked sub menu item.

    Declaration
    public MenuItemModel ParentItem { get; set; }
    Property Value
    Type Description
    MenuItemModel

    The parent menu item of the currently clicked sub menu item. For items with no parent items, the value will be null.

    RowInfo

    Gets information about the row that was right-clicked to open the context menu, including the row index, cell index, and row data.

    Declaration
    public RowInfo<T> RowInfo { get; }
    Property Value
    Type Description
    RowInfo<T>

    Information about the row that was right-clicked to open the context menu, including the row index, cell index, and row data.

    Remarks
    • Cell: Cell Dom elements of the current cell.
    • CellIndex: The cell index value of the current cell.
    • Column: The current target column.
    • Row: The current traget Row details.
    • RowData: The current target row data.
    • RowIndex:The current target row index.

    Target

    Gets the ContextMenuTarget when clicking to open context menu.

    Declaration
    public ContextMenuTarget Target { get; }
    Property Value
    Type Description
    ContextMenuTarget

    Top

    Gets the top position of the context menu.

    Declaration
    public double Top { get; set; }
    Property Value
    Type Description
    System.Double

    The top position of the context menu.

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