MainMenu

Wisej.Web.MainMenu

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • BindableComponent

      • Menu

        • MainMenu

Represents the main menu in a Form.

C#

public class MainMenu : Menu

VB.NET

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.

Name	Type	Description
container	IContainer	An IContainer representing the container of the MainMenu.

MainMenu(items)

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

Name	Type	Description
items	MenuItem[]	An array of MenuItem objects that will be added to the MainMenu.

Properties

AutoOverflow

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)

BackColor

Color: Returns or sets the background color of the main menu bar.

CausesValidation

Boolean: Returns or sets whether clicking menu items causes validation to be performed on the active control. (Default: False)

Enabled

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

Font

Font: Returns or sets the font of the main menu bar.

ForeColor

Color: Returns or sets the text color of the main menu bar.

Form

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

IsMenuBar

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

RightToLeft: Returns or sets whether the text displayed by the control is displayed from right to left.

Visible

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

Methods

CloneMenu()

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

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

Dispose(disposing)

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

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

GetForm()

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.

Hide()

Hides the main menu.

OnBackColorChanged(e)

Fires the BackColorChanged event.

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

OnEnabledChanged(e)

Fires the EnabledChanged event.

Parameter	Type	Description
e	EventArgs	An 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.

OnMenuItemAdded(e)

Parameter	Type	Description
e	MenuItemEventArgs

OnVisibleChanged(e)

Fires the VisibleChanged event.

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

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

ShouldSerializeRightToLeft()

Returns: Boolean.

Show()

Shows the main menu.

Update()

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

Events

BackColorChanged

EventHandler Fired when the BackColor property value changes.

CausesValidationChanged

EventHandler Fired when the value of the CausesValidation property changes.

EnabledChanged

EventHandler Fired when the Enabled property value has changed.

FontChanged

EventHandler Fired when the Font property value changes.

ForeColorChanged

EventHandler Fired when the ForeColor property value changes.

VisibleChanged

EventHandler Fired when the Visible property value changes.

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.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.