MenuItem

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

• Component

  • Component

    • Menu

      • MenuItem

Represents an individual item that is displayed within a MainMenu or ContextMenu.

public class MenuItem : Menu

Public Class MenuItem
    Inherits Menu

Constructors

MenuItem()

Initializes a MenuItem with a blank caption.

MenuItem(text)

Initializes a new instance of the MenuItem class with a specified caption for the menu item.

MenuItem(text, onClick)

Initializes a new instance of the class with a specified caption and event handler for the Click event of the menu item.

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.

Initializes a new instance of the MenuItem class with a specified caption; defined event-handlers for the Click, Select and Popup events; a shortcut key; a merge type; and order specified for the menu item.

Properties

Boolean: Returns or sets a value indicating that the control can display HTML in the Text property. (Default: False)

Boolean: 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)

Color: Returns or sets the background color of the menu item.

CharacterCasing: Returns or sets the case of the text to display to the user. (Default: Normal)

Boolean: Returns or sets whether a check mark appears next to the text of the menu item. (Default: False)

Throws:

• ArgumentException The MenuItem is a top-level menu or has children.

Boolean: Returns or sets whether the menu item is enabled. (Default: True)

Font: Returns or sets the font of the menu item.

Color: Returns or sets the text color of the menu item.

Form: Returns the Form that owns the Menu.

Image: Returns or sets the icon that is displayed by MenuItem.

String: Returns or sets the theme name or URL for the icon to display in the MenuItem.

Int32: Returns or sets a value indicating the position of the menu item in its parent menu.

Throws:

• ArgumentOutOfRangeException The assigned value is less than zero or greater than the item count.

Boolean: Returns a value indicating whether the menu item contains child menu items.

Boolean: 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)

Int32: Returns or sets a value indicating the relative position of the menu item when it is merged with another. (Default: 0)

MenuMerge: Returns or sets a value indicating the behavior of this menu item when its menu is merged with another. (Default: Add)

Menu: The parent menu that contains this menu item

Boolean: Returns or sets whether the MenuItem, if checked, displays a radio-button instead of a check mark. (Default: False)

Shortcut: Returns or sets a value indicating the shortcut key associated with the menu item. (Default: None)

Boolean: Returns or sets whether the shortcut key that is associated with the menu item is displayed next to the menu item caption. (Default: True)

MenuItemSizeMode: Returns or sets how the menu item is resized when in a MenuBar or MainMenu (Default: Auto)

Control: Returns the Control that owns the ContextMenu.

String: Returns or sets a value indicating the text of the menu item. Use "-" to display the menu separator.

Boolean: Returns or sets whether the menu item is visible. (Default: True)

Methods

Creates a copy of the current MenuItem.

Returns: MenuItem. A MenuItem that represents the duplicated menu item.

Merges this MenuItem with another MenuItem and returns the resulting merged MenuItem.

Returns: MenuItem. A MenuItem that represents the merged menu item.

Generates a Click event for the MenuItem, simulating a click by a user.

Fires the Select event for this menu item.

Updates the component on the client.

Events

EventHandler Fired when the BackColor property value changes.

EventHandler Fired when the Checked property value changes.

EventHandler Fired when the menu item is clicked or selected using a shortcut key or access key defined for the menu item.

EventHandler Fired when the Font property value changes.

EventHandler Fired when the ForeColor property value changes.

EventHandler Occurs before a menu item's list of menu items is displayed.

EventHandler Fired when the user places the pointer over a menu item.

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.

EventHandler Fired when the Text property value changes.

Inherited By

Implements