Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Wisej.Web.CheckedMenuItem
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents an individual menu item that is displayed within a MainMenu or ContextMenu and always shows a checkbox next to the label.
| Name | Description |
|---|---|
All wisej components implement this interface.
Allows an object to serialize itself.
Wisej.Web.LinkMenuItem
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents an individual menu item that is displayed within a MainMenu or ContextMenu rendered using the <a> link element to let the browser process the specified HRef URL.
String: Returns or sets the URL to navigate to when this item is clicked. (Default: "")
String: Returns or sets where to open the URL specified in HRef. (Default: "")
EventHandler Fired when the HRef property value changes.
Wisej.Web.ContextMenu
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents a context menu associated to a Control.
Initializes a new instance of the ContextMenu class with no menu items specified.
Initializes a new instance of the ContextMenu class with a specified set of MenuItem objects.
| Name | Type | Description |
|---|---|---|
Initializes a new instance of the ToolTip class with a specified container.
RightToLeft: Returns or sets whether the text displayed by the control is displayed from right to left.
IWisejComponent: Returns the component that is displaying the shortcut menu.
Control: Returns the control that is displaying the shortcut menu.
Displays the context menu at the specified position in relation to the specified component.
Displays the context menu at the specified position.
Displays the context menu at the specified position in relation to the specified control.
Throws:
ArgumentNullException The control parameter is null.
ArgumentException The control is not visible.
Displays the context menu at the specified position in relation to the specified control.
Throws:
ArgumentNullException The control parameter is null.
ArgumentException The handle of the control does not exist or the control is not visible.
Displays the context menu at the specified position and with the specified alignment in relation to the specified control.
Throws:
ArgumentNullException The control parameter is null.
ArgumentException The control is not visible.
Asynchronously displays the context menu at the specified position in relation to the specified component.
Returns: Task.
Asynchronously displays the context menu at the specified position.
Returns: Task.
Asynchronously displays the context menu at the specified position in relation to the specified control.
Returns: Task.
Throws:
ArgumentNullException The control parameter is null.
ArgumentException The control is not visible.
Asynchronously displays the context menu at the specified position in relation to the specified control.
Returns: Task.
Throws:
ArgumentNullException The control parameter is null.
ArgumentException The handle of the control does not exist or the control is not visible.
Asynchronously displays the context menu at the specified position and with the specified alignment in relation to the specified control.
Returns: Task.
Throws:
ArgumentNullException The control parameter is null.
ArgumentException The control is not visible.
Updates the component on the client. Overridden to update the owner control.
EventHandler Fired when the context menu collapses.
EventHandler Occurs before the context menu is displayed on the client.
EventHandler Occurs after the context menu is displayed on the client.
Wisej.Web.MainMenu
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents the main menu in a Form.
Initializes a new instance of the MainMenu class without any specified menu items.
Initializes a new instance of the MainMenu class with the specified container.
| Name | Type | Description |
|---|---|---|
Initializes a new instance of the MainMenu with a specified set of MenuItem objects.
Boolean: Enables the overflow handling which automatically removes items that don't fit in the MainMenu and adds them to a drop-down button. (Default: True)
Color: Returns or sets the background color of the main menu bar.
Boolean: Returns or sets whether clicking menu items causes validation to be performed on the active control. (Default: False)
Boolean: Returns or sets whether the menu is visible. (Default: True)
Font: Returns or sets the font of the main menu bar.
Color: Returns or sets the text color of the main menu bar.
RightToLeft: Returns or sets whether the text displayed by the control is displayed from right to left.
Boolean: Returns or sets whether the menu is visible. (Default: True)
Creates a new MainMenu that is a duplicate of the current MainMenu.
Returns: MainMenu. A MainMenu that represents the cloned menu.
Returns the Form that contains this menu.
Returns: Form. A Form that is the container for this menu. Returns null if the MainMenu is not currently hosted on a form.
Hides the main menu.
Shows the main menu.
Updates the component on the client. Overridden to update the owner form.
EventHandler Fired when the BackColor property value changes.
EventHandler Fired when the value of the CausesValidation property changes.
EventHandler Fired when the Enabled property value has changed.
EventHandler Fired when the Font property value changes.
EventHandler Fired when the ForeColor property value changes.
EventHandler Fired when the Visible property value changes.
Wisej.Web.MenuItem
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents an individual item that is displayed within a or .
Initializes a with a blank caption.
Initializes a new instance of the class with a specified caption for the menu item.
| Name | Type | Description |
|---|
Initializes a new instance of the class with a specified caption, event handler, and associated shortcut key for the menu item.
Initializes a new instance of the class with a specified caption and an array of submenu items defined for the menu item.
Throws:
Throws:
Updates the component on the client.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
Wisej.Web.MenuBar
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents a menu bar component.
Initializes a new instance of the class.
: Enables the overflow handling which automatically removes items that don't fit in the and adds them to a drop-down menu button. (Default: True)
| Name | Description |
|---|---|
| Name | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Name | Description |
|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Description |
|---|---|
Initializes a new instance of the class with a specified caption and event handler for the event of the menu item.
| Name | Type | Description |
|---|
| Name | Type | Description |
|---|
| Name | Type | Description |
|---|
Initializes a new instance of the class with a specified caption; defined event-handlers for the , and events; a shortcut key; a merge type; and order specified for the menu item.
| Name | Type | Description |
|---|
: Returns or sets a value indicating that the control can display HTML in the Text property. (Default: False)
: Returns or sets whether the application blocks the browser with a modal mask when this menu item is clicked and until the server is done processing the execution request. (Default: False)
: Returns or sets the background color of the menu item.
: Returns or sets the case of the text to display to the user. (Default: Normal)
: Returns or sets whether a check mark appears next to the text of the menu item. (Default: False)
The is a top-level menu or has children.
: Returns or sets whether the menu item is enabled. (Default: True)
: Returns or sets the font of the menu item.
: Returns or sets the text color of the menu item.
: Returns the that owns the .
: Returns or sets the icon that is displayed by .
: Returns or sets the theme name or URL for the icon to display in the .
: Returns or sets a value indicating the position of the menu item in its parent menu.
The assigned value is less than zero or greater than the item count.
: Returns a value indicating whether the menu item contains child menu items.
: Returns or sets whether the menu item will be populated with a list of the Multiple Document Interface (MDI) child windows that are displayed within the associated form. (Default: False)
: Returns or sets a value indicating the relative position of the menu item when it is merged with another. (Default: 0)
: Returns or sets a value indicating the behavior of this menu item when its menu is merged with another. (Default: Add)
: The parent menu that contains this menu item
: Returns or sets whether the , if checked, displays a radio-button instead of a check mark. (Default: False)
: Returns or sets a value indicating the shortcut key associated with the menu item. (Default: None)
: Returns or sets whether the shortcut key that is associated with the menu item is displayed next to the menu item caption. (Default: True)
: Returns or sets how the menu item is resized when in a or (Default: Auto)
: Returns the that owns the .
: Returns or sets a value indicating the text of the menu item. Use "-" to display the menu separator.
: Returns or sets whether the menu item is visible. (Default: True)
Creates a copy of the current .
Returns: . A that represents the duplicated menu item.
Merges this with another and returns the resulting merged .
Returns: . A that represents the merged menu item.
Generates a event for the , simulating a click by a user.
Fires the event for this menu item.
Fired when the property value changes.
Fired when the property value changes.
Fired when the menu item is clicked or selected using a shortcut key or access key defined for the menu item.
Fired when the property value changes.
Fired when the property value changes.
Occurs before a menu item's list of menu items is displayed.
Fired when the user places the pointer over a menu item.
Fired when the property value changes.
| Name | Description |
|---|
| Name | Description |
|---|
: Returns or sets the border style of the control. (Default: None)
: Returns or sets whether the control causes validation to be performed on controls that require to be validated when this control receives focus. (Default: False)
: (Default: None)
: Returns the collection of objects associated with the menu.
Fired when a new menu item is added to the .
Fired when a menu item is clicked.
Fired when a menu item is removed from the .
| Name | Description |
|---|
All wisej components implement this interface.
Allows an object to serialize itself.
container
An IContainer that represents the container of the ToolTip extender.
component
Can be any Wisej visual component: i.e. tool button, column header, etc.
position
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.
pos
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.
control
A Control that specifies the control with which this shortcut menu is associated.
position
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.
control
A Control that specifies the control with which this shortcut menu is associated.
pos
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.
control
A Control that specifies the control with which this shortcut menu is associated.
pos
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.
component
Can be any Wisej visual component: i.e. tool button, column header, etc.
position
A Placement that specifies position of the menu in relation to the component parameter.
pos
A Point that specifies the coordinates at which to display the menu.
control
A Control that specifies the control with which this shortcut menu is associated.
position
A Placement that specifies position of the menu in relation to the control parameter.
control
A Control that specifies the control with which this shortcut menu is associated.
pos
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.
control
A Control that specifies the control with which this shortcut menu is associated.
pos
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.
All wisej components implement this interface.
Allows an object to serialize itself.
items
All wisej components implement this interface.
Allows an object to serialize itself.
Auto
The width of the MenuItem is determined by its contents.
Fill
text | The caption for the menu item. |
onClick |
text | The caption for the menu item. |
onClick |
shortcut |
text | The caption for the menu item. |
items |
mergeType |
mergeOrder | The relative position that this menu item will take in a merged menu. |
shortcut |
text | The caption for the menu item. |
onClick |
onPopup |
onSelect |
items |
All wisej components implement this interface. |
Allows an object to serialize itself. |
Bindable components implement this interface. |
Controls that support drag & drop operations implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
menuItems
An array of MenuItem objects that represent the menu items to add to the shortcut menu.
container
An IContainer representing the container of the MainMenu.
text | The caption for the menu item. |
sender | The source of the event. |
e | A that contains the event data. |
Fired when a menu item is clicked. |
Fired when a new menu item is added to the . |
Fired when a menu item is removed from the . |
Fired when a menu item is clicked. |
Fired when a new menu item is added to the . |
Fired when a menu item is removed from the . |
Add | The is added to the collection of existing objects in a merged menu. |
MergeItems | All submenu items of this are merged with those of existing objects at the same position in a merged menu. |
Remove | The is not included in a merged menu. |
Replace | The replaces an existing at the same position in a merged menu. |
Returns or sets a value indicating the behavior of this menu item when its menu is merged with another. |
Wisej.Web.Menu
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents the base functionality for all menus.
String: Returns or sets the description that will be reported to accessibility client applications. It is assigned to the "alt" attribute of the browser element. (Default: null)
String: Returns or sets the name of the control for use by accessibility client applications. It is assigned to the "name" attribute of the browser element. (Default: null)
AccessibleRole: Returns or sets the accessible role of the menu item that will be reported to accessibility client applications. It is assigned to the "role" attribute of the browser element. (Default: Default)
Boolean: Returns a value indicating whether this menu contains any menu items. This property is read-only.
MenuItem: Returns the child menu item that is used to display a list of multiple document interface (MDI) child forms.
MenuItemCollection: Returns the collection of MenuItem objects associated with the menu.
String: Returns or sets the name of the Menu.
Object: Returns or sets user-defined data associated with the control. (Default: null)
Returns the ContextMenu that contains this menu.
Returns: ContextMenu. The ContextMenu that contains this menu. The default is null.
Returns the MainMenu that contains this menu.
Returns: MainMenu. The MainMenu that contains this menu.
Returns the MenuBar that contains this menu.
Returns: MenuBar. The MenuBar that contains this menu.
Merges the MenuItem objects of one menu with the current menu.
Throws:
ArgumentException It was attempted to merge the menu with itself.
MenuItemEventHandler Fired when a new menu item is added to the MenuItemCollection.
MenuItemEventHandler Fired when a menu item is clicked.
MenuItemEventHandler Fired when a menu item is removed from the MenuItemCollection.
Wisej.Web.Menu MenuItemCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents a collection of MenuItem objects.
Initializes a new instance of MenuItemCollection.
| Name | Type | Description |
|---|---|---|
Int32: Returns the number of items in the collection.
Boolean: Returns a value indicating whether this collection can be modified.
MenuItem: Retrieves the item at the specified index within the collection.
Throws:
ArgumentOutOfRangeException The index was less than zero; or the index was greater of equal to the count of items in the collection.
MenuItem: Retrieves the item at the specified index within the collection.
Adds an item to the list of items.
Returns: MenuItem.
Adds an item to the list of items.
Returns: MenuItem.
Adds an item to the list of items.
Returns: MenuItem.
Adds an item to the list of items.
Returns: Int32.
Adds an item to the list of items.
Returns: Int32.
Adds a collection of items to the list.
Removes all items from the Menu.
Removes and disposes all items from the Menu.
Determines if the specified item is located within the collection.
Returns: Boolean. true if the item is located within the collection; otherwise, false.
Determines if the specified item is located within the collection.
Returns: Boolean. true if the item is located within the collection; otherwise, false.
Copies the entire collection into an existing array of objects at a specified location within the array.
Finds all the items with a specific key.
Returns: MenuItem[].
Returns an enumerator that can be used to iterate through the item collection.
Returns: IEnumerator. A IEnumerator that represents the item collection.
Retrieves the index within the collection of the specified item.
Returns: Int32. The zero-based index where the item is located within the collection; otherwise, -1.
Throws:
ArgumentNullException The value parameter was null.
Retrieves the index within the collection of the specified item.
Returns: Int32. The zero-based index where the item is located within the collection; otherwise, -1.
Removes the specified item from the list.
Removes an item at the specified index.
Throws:
ArgumentOutOfRangeException The index parameter was less than zero, or the index parameter was greater than or equal to the count of items in the collection.
Removes the item with the specified key.
The that handles the event for this menu item.
The that handles the event for this menu item.
One of the values.
An array of objects that contains the submenu items for this menu item.
One of the values.
One of the values.
The that handles the event for this menu item.
The that handles the event for this menu item.
The that handles the event for this menu item.
An array of objects that contains the submenu items for this menu item.
Represents an individual menu item that is displayed within a or and always shows a checkbox next to the label.
Represents an individual menu item that is displayed within a or rendered using the <a> link element to let the browser process the specified URL.
All wisej controls derived from the class must implement this interface.
| Parameter | Type | Description |
|---|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
source
The Menu whose menu items are merged with the menu items of the current menu.
Represents an individual menu item that is displayed within a MainMenu or ContextMenu and always shows a checkbox next to the label.
Represents a context menu associated to a Control.
Represents an individual menu item that is displayed within a MainMenu or ContextMenu rendered using the <a> link element to let the browser process the specified HRef URL.
Represents the main menu in a Form.
Represents an individual item that is displayed within a MainMenu or ContextMenu.
All wisej components implement this interface.
Allows an object to serialize itself.
caption
The text of the new menu item.
caption
The text of the new menu item.
onClick
An event handler for the click event.
caption
The text of the new menu item.
items
List of child menu items.
item
The new menu item.
index
The index where to add/insert the new menu item.
item
The MenuItem to add to the collection
items
dispose
Indicates whether the removed items should be disposed.
value
An object representing the item to locate in the collection.
key
The key of the item to locate.
dest
The object array to copy the collection to.
index
The location in the destination array to copy the collection to.
key
The key of the item to locate.
searchAllChildren
Indicates that the search should include child items.
value
The menu item to locate.
key
The key for the menu item to locate.
item
The item to remove.
index
The index of the item to remove.
key
The key of the menu item to remove.
owner
The Menu object that owns the collection.
Wisej.Web.MenuItemEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Provides data for the ControlAdded and ControlRemoved events.
Initializes a new instance of the MenuItemEventArgs class for the specified control.
| Name | Type | Description |
|---|---|---|
MenuItem: Returns the menu item object used by this event.
| Name | Description |
|---|---|
item
The MenuItem to store in this event.
Represents the method that will handle the MenuItemAdded and MenuItemRemoved events of the Menu class.