This documentation is archived and is not being maintained.

MainMenu.GetForm Method

Gets the Form that contains this control.

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

[UIPermissionAttribute(SecurityAction.Demand, Window = UIPermissionWindow.AllWindows)]
public Form GetForm()

Return Value

Type: System.Windows.Forms.Form
A Form that is the container for this control. Returns null if the MainMenu is not currently hosted on a form.

This property enables you to determine if a specific MainMenu is parented to a form. The property is typically used when multiple MainMenu objects are being used on a form and you need to determine which one is currently being used by a form.

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.

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;
   }
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: