Edit

Share via

Form.RightToLeftLayout Property

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll
Source:
Form.cs
Source:
Form.cs
Source:
Form.cs

Gets or sets a value indicating whether right-to-left mirror placement is turned on.

public:
 virtual property bool RightToLeftLayout { bool get(); void set(bool value); };
public virtual bool RightToLeftLayout { get; set; }
member this.RightToLeftLayout : bool with get, set
Public Overridable Property RightToLeftLayout As Boolean

Property Value

Boolean

true if right-to-left mirror placement is turned on; otherwise, false for standard child control placement. The default is false.

Remarks

The RightToLeftLayout property is primarily useful for developing world-ready forms for worldwide audiences. Many forms are designed so that controls are laid out on a form in a left-to-right fashion. These forms are compatible with languages that follow this writing direction. However, when you display the same forms to users of right-to-left languages, it is often preferable to reverse the order of the controls on the form. If both the RightToLeftLayout and RightToLeft properties are true, mirroring will be turned on for the form, and control placement and text flow will be right-to-left.

Unlike RightToLeft, RightToLeftLayout does not inherit. If you want it to take effect for child controls, you must set it on each child control that you want mirrored.

Owner draw is not supported when RightToLeftLayout is set to Yes. The owner draw events will still occur, but the behavior of any code you author in these events is not defined. Additionally, BackgroundImage, Opacity, TransparencyKey, and the painting events are not supported.

The RightToLeftLayout and RightToLeft properties cause the following Windows API window styles to be set:

  • When RightToLeft is set to Yes and RightToLeftLayout is set to true, Windows Forms sets the WS_EX_LAYOUTRTL window style, and removes the WS_EX_RIGHT and WS_EX_RTLREADING styles.

  • When RightToLeft is set to Yes but RightToLeftLayout is set to No, Windows Forms sets the WS_EX_RIGHT and WS_EX_RTLREADING window styles.

Changing the value of this property raises the RightToLeftLayoutChanged event.

For more information about globalization issues, see Best Practices for Developing World-Ready Applications.

Applies to

See also