right_to_left() [2/2]

virtual control & xtd::forms::control::right_to_left ( xtd::forms::right_to_left  value )

virtual

Sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.

Parameters

value

One of the xtd::forms::right_to_left values. The default is xtd::forms::right_to_left::inherit.

Returns

Current control.

Remarks

The xtd::forms::control::right_to_left property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a xtd::forms::button will have the same xtd::forms::control::back_color as its parent xtd::forms::form by default. For more information about ambient properties, see the ambient_properties guide.

The xtd::forms::control::right_to_left property is used for international applications where the language is written from right to left, such as Hebrew or Arabic. When this property is set to xtd::forms::right_to_left::yes, control elements that include text are displayed from right to left.

Note

If the value of the xtd::forms::control::right_to_left property is changed at run time, only raw text without formatting is preserved.

Remarks

The following are a few examples of how control elements are affected by the xtd::forms::control::right_to_left property value of xtd::forms::right_to_left::yes :

• Vertical scroll bars are displayed on the left side rather than right side of scrollable controls (for example, xtd::forms::form, xtd::forms::panel, multiline xtd::forms::text_box, and xtd::forms::rich_text_box).
• Horizontal scroll bars start with the scroll box (thumb) right-aligned.
• The check box element alignment, controlled by the check_align property, is reversed for xtd::forms::check_box and xtd::forms::radio_button controls.
• Items in list box, combo box, and up-down controls are right aligned.
• Up and down buttons are left-aligned on xtd::forms::numeric_up_down and domain_up_down controls.
• Menus (xtd::forms::main_menu, xtd::forms::menu_item, and xtd::forms::context_menu) are displayed right-aligned.
• The alignment of toolbar buttons on a xtd::forms::tool_bar control or the alignment of text on a xtd::forms::tool_bar_button is not affected by the xtd::forms::control::right_to_left property.

Notes to Inheritors

When overriding the xtd::forms::control::right_to_left property in a derived class, use the base class's xtd::forms::control::right_to_left property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the get and set accessors of the xtd::forms::control::right_to_left property; you can override only one if needed.