MenuItem

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Component
  • Component
    • BindableComponent
      • Menu
        • MenuItem

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

C#

public class MenuItem : Menu, ICommandSource

VB.NET

Public Class MenuItem
    Inherits Menu
    Implements ICommandSource

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.

Name	Type	Description
text	String	The 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.

Name	Type	Description
text	String	The caption for the menu item.
onClick	EventHandler	The EventHandler that handles the Click event for this menu item.

MenuItem(text, onClick, shortcut)

Initializes a new instance of the class with a specified caption, event handler, and associated shortcut key for the menu item.

Name	Type	Description
text	String	The caption for the menu item.
onClick	EventHandler	The EventHandler that handles the Click event for this menu item.
shortcut	Shortcut	One of the Shortcut values.

MenuItem(text, items)

Initializes a new instance of the class with a specified caption and an array of submenu items defined for the menu item.

Name	Type	Description
text	String	The caption for the menu item.
items	MenuItem[]	An array of MenuItem objects that contains the submenu items for this menu item.

MenuItem(mergeType, mergeOrder, shortcut, text, onClick, onPopup, onSelect, items)

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.

Name	Type	Description
mergeType	MenuMerge	One of the MenuMerge values.
mergeOrder	Int32	The relative position that this menu item will take in a merged menu.
shortcut	Shortcut	One of the Shortcut values.
text	String	The caption for the menu item.
onClick	EventHandler	The EventHandler that handles the Click event for this menu item.
onPopup	EventHandler	The EventHandler that handles the Popup event for this menu item.
onSelect	EventHandler	The EventHandler that handles the Select event for this menu item.
items	MenuItem[]	An array of MenuItem objects that contains the submenu items for this menu item.

Properties

AllowHtml

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

AutoShowLoader

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)

Value: true to show the loader; otherwise, false. The default is false.

BackColor

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

CharacterCasing

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

Value: One of the CharacterCasing enumeration values that specifies the character case to apply to the text displayed to the user.

Checked

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

Value: true if there is a check mark next to the menu item; otherwise, false. The default is false.

Throws:

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

Command

ICommand: Returns or sets the ICommand implementation to invoke. (Default: null)

Enabled

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

Value: true if the menu item is enabled; otherwise, false. The default is true.

Font

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

ForeColor

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

Form

Form: Returns the Form that owns the Menu.

Icon

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

Value: The Image to display.

IconSource

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

Value: The theme name or URL for the icon to display in the MenuItem.

Index

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

Value: The zero-based index representing 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.

IsParent

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

Value: true if the menu item contains child menu items; false if the menu is a standalone menu item.

MdiList

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)

Value: true if a list of the MDI child windows is displayed in this menu item; otherwise, false. The default is false.

MenuID

Int32: Returns the unique identifier for this menu item.

Value: The unique identifier for this menu item.

MergeOrder

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

Value: A zero-based index representing the merge order position for this menu item. The default is 0.

MergeType

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

Value: A MenuMerge value that represents the menu item's merge type.

Parent

Menu: The parent menu that contains this menu item

RadioCheck

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

Value: true if a radio-button is to be used instead of a check mark; false if the standard check mark is to be displayed when the menu item is checked. The default is false.

Shortcut

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

Value: One of the Shortcut values. The default is Shortcut.None.

ShowShortcut

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)

Value: true if the shortcut key combination is displayed next to the menu item caption; false if the shortcut key combination is not to be displayed. The default is true.

SizeMode

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

Value: One of the MenuItemSizeMode values. The default is Auto.

SourceControl

Control: Returns the Control that owns the ContextMenu.

Text

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

Value: The text caption of the menu item.

Visible

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

Value: true if the menu item will be made visible on the menu; otherwise, false. The default is true.

Methods

CloneMenu()

Creates a copy of the current MenuItem.

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

CloneMenu(source, includeChildren)

Creates a copy of the specified MenuItem.

Parameter	Type	Description
source	MenuItem	The MenuItem that represents the menu item to copy.
includeChildren	Boolean	Indicates whether to clone the menu's child items.

Dispose(disposing)

Disposes of the resources (other than memory) used by the MenuItem.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

MergeMenu()

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

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

OnBackColorChanged(e)

Fires the BackColorChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnCheckedChanged(e)

Fires the CheckedChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnClick(e)

Fires the Click event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnCommandChanged(e)

Fires the CommandChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnFontChanged(e)

Fires the FontChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnForeColorChanged(e)

Fires the ForeColorChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnInitMenuPopup(e)

Fires the Popup event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnPopup(e)

Fires the Popup event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnSelect(e)

Fires the Select event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

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.

OnTextChanged(e)

Fires the TextChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

PerformClick()

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

PerformSelect()

Fires the Select event for this menu item.

Update()

Updates the component on the client.

Events

BackColorChanged

EventHandler Fired when the BackColor property value changes.

CheckedChanged

EventHandler Fired when the Checked property value changes.

Click

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

CommandChanged

EventHandler Fired when the Command property value changes.

FontChanged

EventHandler Fired when the Font property value changes.

ForeColorChanged

EventHandler Fired when the ForeColor property value changes.

Popup

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

Select

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.

TextChanged

EventHandler Fired when the Text property value changes.

Inherited By

Name	Description
CheckedMenuItem	Represents an individual menu item that is displayed within a MainMenu or ContextMenu and always shows a checkbox next to the label.
LinkMenuItem	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.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
ICommandSource	Defines an object that can invoke a Command.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.