MainMenu.CloneMenu Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

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

public:
 virtual System::Windows::Forms::MainMenu ^ CloneMenu();

public virtual System.Windows.Forms.MainMenu CloneMenu ();

override this.CloneMenu : unit -> System.Windows.Forms.MainMenu

Public Overridable Function CloneMenu () As MainMenu

Returns

MainMenu

A MainMenu that represents the cloned menu.

Examples

The following code example uses the GetForm method to determine if a MainMenu is currently parented to the form. If the call in the example code to GetForm does not return null, the code then clones the menu structure of the MainMenu using the CloneMenu method. The code then sets the RightToLeft property to true on the new copy of the MainMenu to create a MainMenu that can be used for languages that support right to left text. This example requires that you have a MainMenu created that is named mainMenu1.

void CloneMyMenu()
{
   // Determine if mainMenu1 is currently hosted on the form.
   if ( mainMenu1->GetForm() != nullptr )
   {
      // Create a copy of the MainMenu that is hosted on the form.
      MainMenu^ mainMenu2 = mainMenu1->CloneMenu();

      // Set the RightToLeft property for mainMenu2.
      mainMenu2->RightToLeft = ::RightToLeft::Yes;
   }
}

public void CloneMyMenu()
{
   // Determine if mainMenu1 is currently hosted on the form.
   if(mainMenu1.GetForm() != null)
   {
      // Create a copy of the MainMenu that is hosted on the form.
      MainMenu mainMenu2 = mainMenu1.CloneMenu();
      // Set the RightToLeft property for mainMenu2.
      mainMenu2.RightToLeft = RightToLeft.Yes;
   }
}

Public Sub CloneMyMenu()
    ' Determine if mainMenu1 is currently hosted on the form.
    If (mainMenu1.GetForm() IsNot Nothing) Then
        ' Create a copy of the MainMenu that is hosted on the form.
        Dim mainMenu2 As MainMenu = mainMenu1.CloneMenu()
        ' Set the RightToLeft property for mainMenu2.
        mainMenu2.RightToLeft = RightToLeft.Yes
    End If
End Sub

Remarks

You can use this method to create a copy of the menu structure stored in a MainMenu. You can use this method to reuse the menu structure stored in a MainMenu as the foundation for a new MainMenu. For example, if you want to create a menu structure that has the same menu items as an existing MainMenu but will also have additional MenuItem objects added to it, you can use the CloneMenu method to create a copy of the original MainMenu and then add the new MenuItem objects to the cloned MainMenu.