Links

ContextMenu

Wisej.Web.ContextMenu
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents a context menu associated to a Control.
C#
VB.NET
public class ContextMenu : Menu
Public Class ContextMenu
Inherits Menu

Constructors

ContextMenu()

Initializes a new instance of the ContextMenu class with no menu items specified.

ContextMenu(menuItems)

Initializes a new instance of the ContextMenu class with a specified set of MenuItem objects.
Name
Type
Description
menuItems
An array of MenuItem objects that represent the menu items to add to the shortcut menu.

Properties

RightToLeft

RightToLeft: Returns or sets whether the text displayed by the control is displayed from right to left.

SourceComponent

IWisejComponent: Returns the component that is displaying the shortcut menu.

SourceControl

Control: Returns the control that is displaying the shortcut menu.

Methods

Show(component, position, onclose)

Displays the context menu at the specified position in relation to the specified component.
Parameter
Type
Description
component
Can be any Wisej visual component: i.e. tool button, column header, etc.
position
Placement
A Placement that specifies position of the menu in relation to the component parameter.
onclose
Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.

Show(pos, onclose)

Displays the context menu at the specified position.
Parameter
Type
Description
pos
Point
A Point that specifies the coordinates at which to display the menu.
onclose
Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.

Show(control, position, onclose)

Displays the context menu at the specified position in relation to the specified control.
Parameter
Type
Description
control
Control
A Control that specifies the control with which this shortcut menu is associated.
position
Placement
A Placement that specifies position of the menu in relation to the control parameter.
onclose
Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.
Throws:

Show(control, pos, onclose)

Displays the context menu at the specified position in relation to the specified control.
Parameter
Type
Description
control
Control
A Control that specifies the control with which this shortcut menu is associated.
pos
Point
A Point that specifies the coordinates at which to display the menu. These coordinates are specified relative to the client coordinates of the control specified in the control parameter.
onclose
Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.
Throws:

Show(control, pos, alignment, onclose)

Displays the context menu at the specified position and with the specified alignment in relation to the specified control.
Parameter
Type
Description
control
Control
A Control that specifies the control with which this shortcut menu is associated.
pos
Point
A Point that specifies the coordinates at which to display the menu. These coordinates are specified relative to the client coordinates of the control specified in the control parameter.
alignment
A LeftRightAlignment that specifies the alignment of the control relative to the pos parameter.
onclose
Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.
Throws:

ShowAsync(component, position)

Asynchronously displays the context menu at the specified position in relation to the specified component.
Parameter
Type
Description
component
Can be any Wisej visual component: i.e. tool button, column header, etc.
position
Placement
A Placement that specifies position of the menu in relation to the component parameter.
Returns: Task.

ShowAsync(pos)

Asynchronously displays the context menu at the specified position.
Parameter
Type
Description
pos
Point
A Point that specifies the coordinates at which to display the menu.
Returns: Task.

ShowAsync(control, position)

Asynchronously displays the context menu at the specified position in relation to the specified control.
Parameter
Type
Description
control
Control
A Control that specifies the control with which this shortcut menu is associated.
position
Placement
A Placement that specifies position of the menu in relation to the control parameter.
Returns: Task.
Throws:

ShowAsync(control, pos)

Asynchronously displays the context menu at the specified position in relation to the specified control.
Parameter
Type
Description
control
Control
A Control that specifies the control with which this shortcut menu is associated.
pos
Point
A Point that specifies the coordinates at which to display the menu. These coordinates are specified relative to the client coordinates of the control specified in the control parameter.
Returns: Task.
Throws:

ShowAsync(control, pos, alignment)

Asynchronously displays the context menu at the specified position and with the specified alignment in relation to the specified control.
Parameter
Type
Description
control
Control
A Control that specifies the control with which this shortcut menu is associated.
pos
Point
A Point that specifies the coordinates at which to display the menu. These coordinates are specified relative to the client coordinates of the control specified in the control parameter.
alignment
A LeftRightAlignment that specifies the alignment of the control relative to the pos parameter.
Returns: Task.
Throws:

Update()

Updates the component on the client. Overridden to update the owner control.

Events

Collapse

EventHandler Fired when the context menu collapses.

Load

EventHandler Occurs before the context menu is displayed on the client.
EventHandler Occurs after the context menu is displayed on the client.

Implements

Name
Description
All wisej components implement this interface.
Allows an object to serialize itself.