text() [1/2]

const xtd::string & xtd::forms::tool_bar_button::text ( ) const

noexcept

Gets the text displayed on the toolbar button.

Returns

The text displayed on the toolbar button. The default is an empty string ("").

Remarks

The default the xtd::forms::tool_bar_button::text property value is an empty string ("") unless you created the control with the xtd::forms::tool_bar constructor that accepts the text string as a parameter. The orientation of the text on the toolbar button is determined by the xtd::forms::tool_bar::text_align property of the button's parentxtd::forms::tool_bar, which can be set to one of the xtd::forms::tool_bar_text_align enumeration values. The orientation is in relation to the image assigned to the button. If no image is assigned to the button, there will be space left for one on the surface of the toolbar button.