MainMenu.GetForm Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 Function GetForm As Form

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

.NET Framework
Available since 1.1
Return to top
Show: