ContextMenu

Wisej.Web.ContextMenu

Namespace: Wisej.Web
Assembly: Wisej.Framework (3.2.0.0)
​Component​
​Component​
​BindableComponent​
​Menu​
​ContextMenu​
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
​MenuItem[]​
An array of MenuItem objects that represent the menu items to add to the shortcut menu.
​
ContextMenu(container)
Initializes a new instance of the ToolTip class with a specified container.
Name
Type
Description
container
​IContainer​
An IContainer that represents the container of the ToolTip extender.
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
​IWisejComponent​
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
​Action<ContextMenu>​
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
​Action<ContextMenu>​
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
​Action<ContextMenu>​
Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.​
Throws:
​ArgumentNullException The control parameter is null.
​ArgumentException The control is not visible.
​
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
​Action<ContextMenu>​
Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.​
Throws:
​ArgumentNullException The control parameter is null.
​ArgumentException The handle of the control does not exist or the control is not visible.
​
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
​LeftRightAlignment​
A LeftRightAlignment that specifies the alignment of the control relative to the pos parameter.
onclose
​Action<ContextMenu>​
Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.​
Throws:
​ArgumentNullException The control parameter is null.
​ArgumentException The control is not visible.
​
ShowAsync(component, position)
Asynchronously displays the context menu at the specified position in relation to the specified component.
Parameter
Type
Description
component
​IWisejComponent​
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:
​ArgumentNullException The control parameter is null.
​ArgumentException The control is not visible.
​
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:
​ArgumentNullException The control parameter is null.
​ArgumentException The handle of the control does not exist or the control is not visible.
​
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
​LeftRightAlignment​
A LeftRightAlignment that specifies the alignment of the control relative to the pos parameter.
Returns: Task.
Throws:
​ArgumentNullException The control parameter is null.
​ArgumentException The control is not visible.
​
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.
​
Popup
​EventHandler Occurs after the context menu is displayed on the client.
Implements
Name
Description
​IBindableComponent​
Bindable components implement this interface.
​IWisejComponent​
All wisej components implement this interface.
​IWisejSerializable​
Allows an object to serialize itself.

Name	Type	Description
menuItems	MenuItem[]	An array of MenuItem objects that represent the menu items to add to the shortcut menu.

Name	Type	Description
container	IContainer	An IContainer that represents the container of the ToolTip extender.

Parameter	Type	Description
component	IWisejComponent	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	Action<ContextMenu>	Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.

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

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	Action<ContextMenu>	Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.

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	Action<ContextMenu>	Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.

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	LeftRightAlignment	A LeftRightAlignment that specifies the alignment of the control relative to the pos parameter.
onclose	Action<ContextMenu>	Optional async handler for the close event; called when the context menu has been closed. It's the equivalent of handling the event.

Parameter	Type	Description
component	IWisejComponent	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.

Parameter	Type	Description
pos	Point	A Point that specifies the coordinates at which to display the menu.

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.

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.

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	LeftRightAlignment	A LeftRightAlignment that specifies the alignment of the control relative to the pos parameter.

Name	Description
IBindableComponent	Bindable components implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.

CheckedMenuItem

LinkMenuItem

Last modified 4mo ago

ContextMenu

Constructors

​ContextMenu()

​ContextMenu(menuItems)

​ContextMenu(container)

Properties

​RightToLeft

​SourceComponent

​SourceControl

Methods

​Show(component, position, onclose)

​Show(pos, onclose)

​Show(control, position, onclose)

​Show(control, pos, onclose)

​Show(control, pos, alignment, onclose)

​ShowAsync(component, position)

​ShowAsync(pos)

​ShowAsync(control, position)

​ShowAsync(control, pos)

​ShowAsync(control, pos, alignment)

​Update()

Events

​Collapse

​Load

​Popup

Implements

ContextMenu()

ContextMenu(menuItems)

ContextMenu(container)

RightToLeft

SourceComponent

SourceControl

Show(component, position, onclose)

Show(pos, onclose)

Show(control, position, onclose)

Show(control, pos, onclose)

Show(control, pos, alignment, onclose)

ShowAsync(component, position)

ShowAsync(pos)

ShowAsync(control, position)

ShowAsync(control, pos)

ShowAsync(control, pos, alignment)

Update()

Collapse

Load

Popup