MainMenu Class

 

Represents the menu structure of a form. Although MenuStrip replaces and adds functionality to the MainMenu control of previous versions, MainMenu is retained for both backward compatibility and future use if you choose.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.Menu
        System.Windows.Forms.MainMenu

public class MainMenu : Menu

NameDescription
System_CAPS_pubmethodMainMenu()

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

System_CAPS_pubmethodMainMenu(IContainer)

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

System_CAPS_pubmethodMainMenu(MenuItem[])

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

NameDescription
System_CAPS_protpropertyCanRaiseEvents

Gets a value indicating whether the component can raise an event.(Inherited from Component.)

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)

System_CAPS_protpropertyEvents

Gets the list of event handlers that are attached to this Component.(Inherited from Component.)

System_CAPS_pubpropertyHandle

Gets a value representing the window handle for the menu.(Inherited from Menu.)

System_CAPS_pubpropertyIsParent

Gets a value indicating whether this menu contains any menu items. This property is read-only.(Inherited from Menu.)

System_CAPS_pubpropertyMdiListItem

Gets a value indicating the MenuItem that is used to display a list of multiple document interface (MDI) child forms.(Inherited from Menu.)

System_CAPS_pubpropertyMenuItems

Gets a value indicating the collection of MenuItem objects associated with the menu.(Inherited from Menu.)

System_CAPS_pubpropertyName

Gets or sets the name of the Menu.(Inherited from Menu.)

System_CAPS_pubpropertyRightToLeft

Gets or sets whether the text displayed by the control is displayed from right to left.

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertyTag

Gets or sets user-defined data associated with the control.(Inherited from Menu.)

NameDescription
System_CAPS_pubmethodCloneMenu()

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

System_CAPS_protmethodCloneMenu(Menu)

Copies the Menu that is passed as a parameter to the current Menu.(Inherited from Menu.)

System_CAPS_protmethodCreateMenuHandle()

Creates a new handle to the Menu.(Overrides Menu.CreateMenuHandle().)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Disposes of the resources, other than memory, used by the MainMenu.(Overrides Menu.Dispose(Boolean).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)

System_CAPS_pubmethodFindMenuItem(Int32, IntPtr)

Gets the MenuItem that contains the value specified. (Inherited from Menu.)

System_CAPS_protmethodFindMergePosition(Int32)

Returns the position at which a menu item should be inserted into the menu.(Inherited from Menu.)

System_CAPS_pubmethodGetContextMenu()

Gets the ContextMenu that contains this menu.(Inherited from Menu.)

System_CAPS_pubmethodGetForm()

Gets the Form that contains this control.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetMainMenu()

Gets the MainMenu that contains this menu.(Inherited from Menu.)

System_CAPS_protmethodGetService(Type)

Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodMergeMenu(Menu)

Merges the MenuItem objects of one menu with the current menu.(Inherited from Menu.)

System_CAPS_protmethodOnCollapse(EventArgs)

Raises the Collapse event.

System_CAPS_protmethodProcessCmdKey(Message, Keys)

Processes a command key.(Inherited from Menu.)

System_CAPS_pubmethodToString()

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a string that represents the MainMenu.(Overrides Menu.ToString().)

NameDescription
System_CAPS_pubeventCollapse

Occurs when the main menu collapses.

System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

The MainMenu control represents the container for the menu structure of a form. A menu is composed of MenuItem objects that represent the individual menu commands in the menu structure. Each MenuItem can be a command for your application or a parent menu for other submenu items. To bind the MainMenu to the Form that will display it, assign the MainMenu to the Menu property of the Form.

For applications that will have support for multiple languages, you can use the RightToLeft property to display the text of the menu from right to left to support languages such as Arabic.

You can create different MainMenu objects to represent different menu structures for your form. If you want to reuse the menu structure contained in a specific MainMenu, you can use its CloneMenu method to create a copy. Once you have a copy of the menu structure, you can make the appropriate modifications for your new menu structure.

System_CAPS_noteNote

Cutting and pasting menu items from one form to another in the designer might not work as expected if the form you are pasting into has no menu items defined.

The following code example creates a MainMenu, assigns two MenuItem objects to the MainMenu and binds it to a form. This example requires that you have a Form created that is named Form1.

public void CreateMyMainMenu()
{
   // Create an empty MainMenu.
   MainMenu mainMenu1 = new MainMenu();

   MenuItem menuItem1 = new MenuItem();
   MenuItem menuItem2 = new MenuItem();

   menuItem1.Text = "File";
   menuItem2.Text = "Edit";
   // Add two MenuItem objects to the MainMenu.
   mainMenu1.MenuItems.Add(menuItem1);
   mainMenu1.MenuItems.Add(menuItem2);

   // Bind the MainMenu to Form1.
   Menu = mainMenu1;   
}

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: