Class SfContextMenu<TValue>

ContextMenu is a graphical user interface that appears on the user right click/touch hold operation.

Inheritance
System.Object
SfBaseComponent
Syncfusion.Blazor.Navigations.Internal.SfMenuBase<TValue>
SfContextMenu<TValue>
Inherited Members
Namespace: Syncfusion.Blazor.Navigations
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfContextMenu<TValue> : SfMenuBase<TValue>, IMenu
Type Parameters
Name Description
TValue
Examples

In the below code example, showcases a basic context menu.

<SfContextMenu Target="#contextmenutarget" TValue="MenuItem">
<MenuItems>
<MenuItem Text="Cut" IconCss="e-cm-icons e-cut"></MenuItem>
<MenuItem Text="Copy" IconCss="e-cm-icons e-copy"></MenuItem>
<MenuItem Text="Paste" IconCss="e-cm-icons e-paste"></MenuItem>
</MenuItems>
</SfContextMenu>

In the below code example, showcases a basic context menu.

<SfContextMenu Target="#contextmenutarget" TValue="MenuItem">
<MenuItems>
<MenuItem Text="Cut" IconCss="e-cm-icons e-cut"></MenuItem>
<MenuItem Text="Copy" IconCss="e-cm-icons e-copy"></MenuItem>
<MenuItem Text="Paste" IconCss="e-cm-icons e-paste"></MenuItem>
</MenuItems>
</SfContextMenu>

Constructors

SfContextMenu()

Declaration
public SfContextMenu()

Properties

CloseActionEvents

Gets or sets a value that indicates an event to close the context menu.

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

Accepts a string value. The default value is mousedown, touchstart.
Remarks

The list of events supports to close the context menu are mousedown, mouseup, click, touchstart, mouseleave, touchend. The event must be different from OpenActionEvents.

Examples

In the below code example, contextmenu event is set to close the context menu.

<div id="target">Right click or touch hold to open the context menu.</div>
<SfContextMenu Target="#target" TValue="MenuItem" CloseActionEvents=”CloseAction”>
<MenuItems>
    <MenuItem Text="Cut"></MenuItem>
    <MenuItem Text="Copy"></MenuItem>
    <MenuItem Text="Paste"></MenuItem>
</MenuItems>
</SfContextMenu>
@code {
    private string CloseAction = “mousedown touchstart”;
}

Filter

Gets or sets a value that indicates the filter selector in which element the context menu should be opened inside the sepcified target.

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

OpenActionEvents

Gets or sets a value that indicates an event to open the context menu.

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

Accepts a string value. The default value is contextmenu.
Remarks

The list of events supports to open the context menu are contextmenu, mousedown, mouseup, touchstart, mouseleave etc. The event must be different from CloseActionEvents.

Examples

In the below code example, contextmenu event is set to open the context menu.

<div id="target">Right click or touch hold to open the context menu.</div>
<SfContextMenu Target="#target" TValue="MenuItem" OpenActionEvents=”OpenAction”>
<MenuItems>
    <MenuItem Text="Cut"></MenuItem>
    <MenuItem Text="Copy"></MenuItem>
    <MenuItem Text="Paste"></MenuItem>
</MenuItems>
</SfContextMenu>
@code {
    private string OpenAction = “contextmenu”;
}

ShowOn

Gets or sets a value that indicates an event to open the context menu.

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

Target

Gets or sets a value that indicates the target element selector in which the context menu should be opened.

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

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

Close()

Closes the context menu if it is opened.

Declaration
public void Close()

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.Navigations.Internal.SfMenuBase<TValue>.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.Navigations.Internal.SfMenuBase<TValue>.OnInitializedAsync()

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.Navigations.Internal.SfMenuBase<TValue>.OnParametersSetAsync()

Open(Nullable<Double>, Nullable<Double>, Boolean)

Opens the context menu in specified position. If the positions are not specified, the context menu will open at its rendered position.

Declaration
public void Open(Nullable<double> clientX = null, Nullable<double> clientY = null, bool enableCollision = false)
Parameters
Type Name Description
System.Nullable<System.Double> clientX

Specifies the horizontal position of the context menu.
System.Nullable<System.Double> clientY

Specifies the vertical position of the context menu.
System.Boolean enableCollision

Specifies the collision detection of the context menu.