Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • BindableComponent

      • Menu

        • MenuItem

          • 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.

public class LinkMenuItem : MenuItem

Public Class LinkMenuItem
    Inherits MenuItem

Constructors

LinkMenuItem()

Initializes a new instance of LinkMenuItem.

Properties

HRef

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

Methods

Fires the HRefChanged event.

Renders the client component.

Events

EventHandler Fired when the HRef property value changes.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • BindableComponent

      • Menu

        • ContextMenu

Represents a context menu associated to a Control.

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.

Initializes a new instance of the ToolTip class with a specified container.

Properties

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.

Methods

Clones this ContextMenu.

Returns: ContextMenu.

Disposes of the resources, other than memory, used by the ContextMenu.

Fires the Collapse event.

Fires the Load event.

Fires the MenuItemAdded event.

Fires the MenuItemRemoved event.

Fires the Popup event.

Processes the event from the client.

Renders the client component.

Returns: Boolean.

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.

Events

EventHandler Fired when the context menu collapses.

EventHandler Occurs before the context menu is displayed on the client when shown using one of the Show or ShowAsync methods. It doesn't fire when the context menu is associated to a control and it's shown from a user event (i.e. the user right clicks on the control associated with the context menu).

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

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • BindableComponent

      • Menu

Represents the base functionality for all menus.

public class Menu : BindableComponent, ICloneable

Public Class Menu
    Inherits BindableComponent
    Implements ICloneable

Properties

AccessibleDescription

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)

AccessibleName

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

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 flag indicating that this menu instance is used a as menu bar. Which makes the first level menuItem children become menu buttons.

Boolean: Returns a value indicating whether this menu contains any menu items. This property is read-only.

Int32: Returns the number of child menu items without forcing the creation of the collection.

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)

Methods

Copies the Menu that is passed as a parameter to the current Menu.

Disposes of the resources, other than memory, used by the Menu.

Returns the position at which a menu item should be inserted into the menu.

Returns: Int32. The position at which a menu item should be inserted into the menu.

Returns the position at which a menu item should be replaced into the menu.

Returns: Int32. The position at which a menu item should be replaced into the menu.

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.

Returns: Menu.

Merges the MenuItem objects of one menu with the current menu.

Throws:

• ArgumentException It was attempted to merge the menu with itself.

Adds references components to the list. Referenced components can be added individually or as a reference to a collection.

Fires the BindingContextChanged event.

Fires the MenuItemAdded event.

Fired the MenuItemClicked event.

Fires the MenuItemRemoved event.

Renders the client component.

Validates the current control.

Returns: Boolean. true if the active control is validated.

Events

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.

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • BindableComponent

      • Menu

        • MenuItem

          • CheckedMenuItem

Represents an individual menu item that is displayed within a MainMenu or ContextMenu and always shows a checkbox next to the label.

public class CheckedMenuItem : MenuItem

Public Class CheckedMenuItem
    Inherits MenuItem

Constructors

CheckedMenuItem()

Initializes a new instance of CheckedMenuItem.

Methods

OnClick(e)

Fires the Click event.

Renders the client component.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the ControlAdded and ControlRemoved events.

public class MenuItemEventArgs : EventArgs

Public Class MenuItemEventArgs
    Inherits EventArgs

Constructors

MenuItemEventArgs(item)

Initializes a new instance of the MenuItemEventArgs class for the specified control.

Properties

MenuItem

MenuItem: Returns the menu item object used by this event.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • BindableComponent

      • Menu

        • MainMenu

Represents the main menu in a Form.

public class MainMenu : Menu

Public Class MainMenu
    Inherits Menu

Constructors

MainMenu()

Initializes a new instance of the MainMenu class without any specified menu items.

MainMenu(container)

Initializes a new instance of the MainMenu class with the specified container.

Initializes a new instance of the MainMenu with a specified set of MenuItem objects.

Properties

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.

Form: The container window (Form or Page) that owns this menu;

Boolean: Returns a flag indicating that this menu instance is used a as menu bar. Which makes the first level menuItem children become menu buttons.

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)

Methods

Creates a new MainMenu that is a duplicate of the current MainMenu.

Returns: MainMenu. A MainMenu that represents the cloned menu.

Disposes of the resources, other than memory, used by the MainMenu.

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.

Fires the BackColorChanged event.

Fires the EnabledChanged event.

Fires the FontChanged event.

Fires the ForeColorChanged event.

Fires the VisibleChanged event.

Renders the client component.

Returns: Boolean.

Shows the main menu.

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

Events

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.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • BindableComponent

      • Menu

        • MenuItem

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

public class MenuItem : Menu, ICommandSource

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.

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.

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

Boolean:

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.

ImagePropertySettings: Creates the property manager for the Icon properties on first use.

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 the unique identifier for this menu item.

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)

String: Returns the text to use for rendering to the client.

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

Determines whether the menu item is a child of a top-level form, page or desktop that are currently active.

Returns: Boolean. true if the specified menu item is a child of an active top-level container.

Creates a copy of the current MenuItem.

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

Creates a copy of the specified MenuItem.

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

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

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

Fires the BackColorChanged event.

Fires the CheckedChanged event.

Fires the Click event.

Fires the CommandChanged event.

Fires the FontChanged event.

Fires the ForeColorChanged event.

Fires the Popup event.

Fires the Popup event.

Fires the Select event.

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.

Fires the TextChanged event.

Processes the event from the client.

Renders the client component.

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

Fires the Select event for this menu item.

Creates child menu items corresponding to the visible mdi child forms.

Updates the component on the client.

Updates the checked (activated) item in the mdi list.

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 Command property value changes.

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

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents a collection of MenuItem objects.

public class MenuItemCollection : IList, ICollection, IEnumerable, IList<MenuItem>, ICollection<MenuItem>, IEnumerable<MenuItem>

Public Class MenuItemCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of MenuItem), ICollection(Of MenuItem), IEnumerable(Of MenuItem)

Constructors

MenuItemCollection(owner)

Initializes a new instance of MenuItemCollection.

Properties

Count

Int32: Returns the number of items in the collection.

IsReadOnly

Boolean: Returns a value indicating whether this collection can be modified.

Item(index)

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.

Methods

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.

Renders the child items in an array of configurations.

Returns: Object.

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Specifies how a MenuItem in a MenuBar or a MainMenu behaves when the control resizes.

public enum MenuItemSizeMode : Enum

Public Enum MenuItemSizeMode As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the MenuItemAdded and MenuItemRemoved events of the Menu class.

public delegate void MenuItemEventHandler(Object sender, MenuItemEventArgs e)

Public Delegate Sub MenuItemEventHandler(ByVal sender As [Object], ByVal e As MenuItemEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Control

  • MenuBar

Represents a menu bar component.

public class MenuBar : Control

Public Class MenuBar
    Inherits Control

Constructors

MenuBar()

Initializes a new instance of the MenuBar class.

Properties

AutoOverflow

Boolean: Enables the overflow handling which automatically removes items that don't fit in the MenuBar and adds them to a drop-down menu button. (Default: True)

BorderStyle

BorderStyle: Returns or sets the border style of the MenuBar control. (Default: None)

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

Size:

DockStyle: (Default: None)

MenuBarMenu:

MenuItemCollection: Returns the collection of MenuItem objects associated with the menu.

Methods

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

Returns: Int32.

Returns: Size.

Returns a collection of referenced components or collection of components.

Fires the BindingContextChanged event.

Fires the MenuItemAdded event.

Fired the MenuItemClicked event.

Fires the MenuItemRemoved event.

Renders the client component.

Sets the specified bounds of the MenuBar control.

Events

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.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Specifies the behavior of a when it is merged with items in another menu.

public enum MenuMerge : Enum

Public Enum MenuMerge As [Enum]

Fields

Used By