MainMenu.RightToLeft Property

 
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 or sets whether the text displayed by the control is displayed from right to left.

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

Public Overridable Property RightToLeft As RightToLeft

Property Value

Type: System.Windows.Forms.RightToLeft

One of the RightToLeft values.

Exception Condition
InvalidEnumArgumentException

The value assigned to the property is not a valid member of the RightToLeft enumeration.

This property enables your menus to support languages that are written from right to left. When this property is set to RightToLeft.Yes, the menu item text will be displayed from right to left instead of the default left to right method.

System_CAPS_noteNote

For more information about how enabling right-to-left alignment affects Windows Forms controls, see the RightToLeft property.

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 example code then sets the RightToLeft property to RightToLeft.Yes 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: