xtd::forms::tool_bar Class Reference

Inheritance diagram for xtd::forms::tool_bar:

Definition

Represents a Windows toolbar.

class forms_export_ tool_bar : public xtd::forms::control

Inheritance

xtd::object → xtd::forms::component → xtd::forms::control → xtd::forms::tool_bar

Header

#include <xtd/forms/tool_bar>

Namespace

xtd::forms

Library

xtd.forms

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples

The following code example demonstrates the use of xtd::forms::tool_bar control.

#include <xtd/xtd>
 
namespace tool_bar_example {
  class form1 : public form {
  public:
    form1() {
      text("Toolbar example");
      client_size({820, 500});
      controls().add_range({list_box1, tool_bar2, tool_bar1});
      tool_bar(tool_bar1);
      active_control(list_box1);
      
      list_box1.dock(dock_style::fill);
      
      choice1.items().add_range({"Item1", "Item2", "Item3", "Item4", "Item5", "Item6", "Item7", "Item8", "Item9", "Item10"});
      choice1.selected_index(0);
      choice1.selected_value_changed += delegate_ {
        list_box1.items().add(string::format("{} selected", choice1.selected_item()));
        list_box1.selected_index(list_box1.items().count() - 1);
      };
      
      progress_bar1.width(150);
      
      progress_timer1.interval_milliseconds(50);
      progress_timer1.start();
      progress_timer1.tick += delegate_ {
        progress_bar1.value(progress_bar1.value() < progress_bar1.maximum() ? progress_bar1.value() + 1 : progress_bar1.minimum());
      };
      
      tool_bar1.image_list().images().add_range({tool_bar_images::file_new(), tool_bar_images::file_open(), tool_bar_images::file_save(), tool_bar_images::file_print(), tool_bar_images::edit_cut(), tool_bar_images::edit_copy(), tool_bar_images::edit_paste(), tool_bar_images::help()});
      tool_bar1.buttons().add_range({new_tool_bar_button, open_tool_bar_button, save_tool_bar_button, print_tool_bar_button, tool_bar1_separator1, cut_tool_bar_button, copy_tool_bar_button, paste_tool_bar_button, tool_bar1_separator2, choice_tool_bar_button, tool_bar1_separator3, help_tool_bar_button});
      tool_bar1.button_click += {*this, &form1::on_tool_bar_button_click};
      
      tool_bar2.dock(dock_style::bottom);
      tool_bar2.show_text(true);
      tool_bar2.text_align(xtd::forms::tool_bar_text_align::right);
      tool_bar2.image_list().image_size({24, 24});
      tool_bar2.image_list().images().add_range({tool_bar_images::from_name("media-playback-start"), tool_bar_images::from_name("media-skip-backward"), tool_bar_images::from_name("media-playback-stop"), tool_bar_images::from_name("media-skip-forward"), tool_bar_images::from_name("media-record"), tool_bar_images::from_name("media-eject")});
      tool_bar2.buttons().add_range({play_tool_bar_button, tool_bar2_separator1, skip_backward_tool_bar_button, stop_tool_bar_button, skip_forward_tool_bar_button, tool_bar2_separator2, record_tool_bar_button, tool_bar2_separator3, progress_tool_bar_button, tool_bar2_separator4, eject_tool_bar_button});
      tool_bar2.button_click += {*this, &form1::on_tool_bar_button_click};
      
      record_tool_bar_button.enabled(false);
    }
    
  private:
    auto on_tool_bar_button_click(object& sender, const tool_bar_button_click_event_args& e) -> void {
      if (e.button().style() == tool_bar_button_style::toggle_button) list_box1.items().add(string::format("Button {} clicked, pushed = {}", e.button().text(), e.button().pushed()));
      else list_box1.items().add(string::format("Button {} clicked", e.button().text()));
      list_box1.selected_index(list_box1.items().count() - 1);
    }
    
    auto on_menu_click(object& sender, const event_args& e) -> void {
      list_box1.items().add(string::format("Menu item {} clicked", as<menu_item>(sender).text()));
      list_box1.selected_index(list_box1.items().count() - 1);
    }
    
    list_box list_box1;
    
    menu_item context_help_context_menu_item {"Help context", event_handler {*this, &form1::on_menu_click}};
    menu_item context_help_index_menu_item {"Help index", event_handler {*this, &form1::on_menu_click}};
    menu_item context_help_search_menu_item {"Help search", event_handler {*this, &form1::on_menu_click}};
    menu_item context_separator_menu_item {"-"};
    menu_item context_about_menu_item {texts::about(), event_handler {*this, &form1::on_menu_click}};
    forms::context_menu context_menu1 {context_help_context_menu_item, context_help_index_menu_item, context_help_search_menu_item, context_separator_menu_item, context_about_menu_item};
    
    forms::tool_bar tool_bar1;
    choice choice1;
    tool_bar_button new_tool_bar_button = tool_bar_button::create_push_button(texts::new_(), 0);
    tool_bar_button open_tool_bar_button = tool_bar_button::create_push_button(texts::open(), 1);
    tool_bar_button save_tool_bar_button = tool_bar_button::create_push_button(texts::save(), 2);
    tool_bar_button print_tool_bar_button = tool_bar_button::create_push_button(texts::print(), 3);
    tool_bar_button tool_bar1_separator1 = tool_bar_button::create_separator();
    tool_bar_button cut_tool_bar_button = tool_bar_button::create_push_button(texts::cut(), 4);
    tool_bar_button copy_tool_bar_button = tool_bar_button::create_push_button(texts::copy(), 5);
    tool_bar_button paste_tool_bar_button = tool_bar_button::create_push_button(texts::paste(), 6);
    tool_bar_button tool_bar1_separator2 = tool_bar_button::create_separator();
    tool_bar_button choice_tool_bar_button = tool_bar_button::create_control("Items", choice1);
    tool_bar_button tool_bar1_separator3 = tool_bar_button::create_stretchable_separator();
    tool_bar_button help_tool_bar_button = tool_bar_button::create_drop_down_button(texts::help(), 7, context_menu1);
    
    forms::tool_bar tool_bar2;
    progress_bar progress_bar1;
    forms::timer progress_timer1;
    tool_bar_button play_tool_bar_button = tool_bar_button::create_push_button("&Play", 0);
    tool_bar_button tool_bar2_separator1 = tool_bar_button::create_separator();
    tool_bar_button skip_backward_tool_bar_button = tool_bar_button::create_push_button("Skip &Backward", 1);
    tool_bar_button stop_tool_bar_button = tool_bar_button::create_push_button("S&top", 2);
    tool_bar_button skip_forward_tool_bar_button = tool_bar_button::create_push_button("Skip &Forward", 3);
    tool_bar_button tool_bar2_separator2 = tool_bar_button::create_separator();
    tool_bar_button record_tool_bar_button = tool_bar_button::create_push_button("&Record", 4);
    tool_bar_button tool_bar2_separator3 = tool_bar_button::create_separator();
    tool_bar_button progress_tool_bar_button = tool_bar_button::create_control(progress_bar1);
    tool_bar_button tool_bar2_separator4 = tool_bar_button::create_stretchable_separator();
    tool_bar_button eject_tool_bar_button = tool_bar_button::create_toggle_button("&Eject", 5);
  };
}
 
auto main() -> int {
  application::run(tool_bar_example::form1 {});
}

Remarks

xtd::forms::tool_bar controls are used to display xtd::forms::tool_bar_button controls that can appear as a standard button, a toggle-style button, or a drop-down style button. You can assign images to the buttons by creating an xtd::forms::image_list, assigning it to the xtd::forms::tool_bar::image_list property of the toolbar, and assigning the image index value to the xtd::forms::tool_bar_button::image_index property each xtd::forms::tool_bar_button. You can then assign text to be displayed underneath or to the right of the image by setting the xtd::forms::tool_bar_button::text property of the xtd::forms::tool_bar_button.

Set the xtd::forms::tool_bar::appearance property of the toolbar to xtd::forms::tool_bar_appearance::flat to give the toolbar and its buttons a flat appearance. As the mouse pointer moves over the buttons, their appearance changes to three-dimensional. Toolbar buttons can be divided into logical groups by using separators. A separator is a toolbar button with the xtd::forms::tool_bar_button::style property set to xtd::forms::tool_bar_button_style::separator. Button separators appear as lines rather than spaces between the buttons when the toolbar has a flat appearance. If the xtd::forms::tool_bar::appearance property is set to xtd::forms::tool_bar_appearance::normal, the toolbar buttons appear raised and three-dimensional.

If you specify a value for the xtd::forms::tool_bar::button_size property, all buttons in the tool bar are restricted to the specified size. Otherwise, the buttons adjust their size depending on their content, and the xtd::forms::tool_bar::button_size property returns the initial size of the largest button.

To create a collection of xtd::forms::tool_bar_button controls to display on the xtd::forms::tool_bar, add the buttons individually by using the xtd::forms::tool_bar::tool_bar_button_collection::push_back or xtd::forms::tool_bar::tool_bar_button_collection::insert methods of the xtd::forms::tool_bar::buttons property.

Examples

application_enable_dark_mode.cpp, application_enable_light_mode.cpp, and themes.cpp.

Protected Attributes
friend	tool_bar_button
friend	form

Public Aliases
using	tool_bar_button_collection
	Represents the base type of the xtd::forms::tool_bar::buttons collection.

Public Events
xtd::event< tool_bar, xtd::forms::tool_bar_button_click_event_handler >	button_click
	Occurs when a xtd::forms::tool_bar_button on the xtd::forms::tool_bar is clicked.
xtd::event< tool_bar, xtd::forms::tool_bar_button_click_event_handler >	button_drop_down
	Occurs when a drop-down style xtd::forms::tool_bar_button or its down arrow is clicked.

Public Constructors
	tool_bar ()
	Initializes a new instance of the xtd::forms::tool_bar class.

Public Properties
virtual xtd::forms::tool_bar_appearance	appearance () const noexcept
	Gets the value that determines the appearance of a toolbar control and its buttons.
virtual tool_bar &	appearance (xtd::forms::tool_bar_appearance value)
	Sets the value that determines the appearance of a toolbar control and its buttons.
virtual forms::border_sides	border_sides () const noexcept
	Gets the border sides for the control.
virtual tool_bar &	border_sides (forms::border_sides border_sidesborder_sides)
	Sets the border sides for the control.
virtual forms::border_style	border_style () const noexcept
	Gets the border style for the control.
virtual tool_bar &	border_style (forms::border_style value)
	Sets the border style for the control.
virtual xtd::forms::tool_bar &	border_style (std::nullptr_t value)
	Resets the border style for the control.
const tool_bar_button_collection &	buttons () const noexcept
	Gets the collection of xtd::forms::tool_bar_button controls assigned to the toolbar control.
tool_bar_button_collection &	buttons ()
	Gets the collection of xtd::forms::tool_bar_button controls assigned to the toolbar control.
virtual xtd::drawing::size	button_size () const noexcept
	Gets the size of the buttons on the toolbar control.
virtual tool_bar &	button_size (const xtd::drawing::size &value)
	Sets the size of the buttons on the toolbar control.
virtual tool_bar &	button_size (std::nullptr_t value)
	Resets the size of the buttons on the toolbar control.
virtual bool	divider () const noexcept
	Gets a value indicating whether the toolbar displays a divider.
virtual tool_bar &	divider (bool value)
	Sets a value indicating whether the toolbar displays a divider.
dock_style	dock () const noexcept override
	Gets which control borders are docked to its parent control and determines how a control is resized with its parent.
control &	dock (dock_style dock) override
	Sets which control borders are docked to its parent control and determines how a control is resized with its parent.
virtual bool	drop_down_arrows () const noexcept
	Gets a value indicating whether drop-down buttons on a toolbar display down arrows.
virtual tool_bar &	drop_down_arrows (bool value)
	Sets a value indicating whether drop-down buttons on a toolbar display down arrows.
const xtd::forms::image_list &	image_list () const noexcept
	Gets the collection of images available to the toolbar button controls.
xtd::forms::image_list &	image_list ()
	Gets the collection of images available to the toolbar button controls.
tool_bar &	image_list (const xtd::forms::image_list &value)
	Sets the collection of images available to the toolbar button controls.
virtual xtd::drawing::size	image_size () const noexcept
	Gets the size of the images in the image list assigned to the toolbar.
virtual bool	show_icon () const noexcept
	Gets a value indicating whether the toolbar displays the image for each button.
virtual tool_bar &	show_icon (bool value)
	Sets a value indicating whether the toolbar displays the image for each button.
virtual bool	show_text () const noexcept
	Gets a value indicating whether the toolbar displays the text for each button.
virtual tool_bar &	show_text (bool value)
	Sets a value indicating whether the toolbar displays the text for each button.
virtual bool	show_tool_tips () const noexcept
	Gets a value indicating whether the toolbar displays a xtd::forms::tool_tip for each button.
virtual tool_bar &	show_tool_tips (bool value)
	Sets a value indicating whether the toolbar displays a xtd::forms::tool_tip for each button.
virtual xtd::forms::tool_bar_text_align	text_align () const noexcept
	Gets the alignment of text in relation to each image displayed on the toolbar button controls.
virtual tool_bar &	text_align (xtd::forms::tool_bar_text_align value)
	Sets the alignment of text in relation to each image displayed on the toolbar button controls.
virtual bool	wrappable () const noexcept
	Gets a value indicating whether the toolbar buttons wrap to the next line if the toolbar becomes too small to display all the buttons on the same line.
virtual tool_bar &	wrappable (bool value)
	Gets a value indicating whether the toolbar buttons wrap to the next line if the toolbar becomes too small to display all the buttons on the same line.

Public Static Methods
static tool_bar	create ()
	A factory to create an xtd::forms::tool_bar.
static tool_bar	create (const xtd::forms::image_list::image_collection &image_collection)
	A factory to create an xtd::forms::tool_bar with specified image collection.
static tool_bar	create (const xtd::forms::image_list::image_collection &image_collection, const xtd::string &name)
	A factory to create an xtd::forms::tool_bar with specified image collection, and name.
static tool_bar	create (xtd::forms::dock_style style)
	A factory to create an xtd::forms::tool_bar with specified style.
static tool_bar	create (xtd::forms::dock_style style, const xtd::forms::image_list::image_collection &image_collection)
	A factory to create an xtd::forms::tool_bar with specified style, and image collection.
static tool_bar	create (xtd::forms::dock_style style, const xtd::forms::image_list::image_collection &image_collection, const xtd::string &name)
	A factory to create an xtd::forms::tool_bar with specified style, image collection, and name.
static tool_bar	create (const tool_bar_button_collection &buttons)
	A factory to create an xtd::forms::tool_bar.
static tool_bar	create (const xtd::forms::image_list::image_collection &image_collection, const tool_bar_button_collection &buttons)
	A factory to create an xtd::forms::tool_bar with specified image collection.
static tool_bar	create (const xtd::forms::image_list::image_collection &image_collection, const tool_bar_button_collection &buttons, const xtd::string &name)
	A factory to create an xtd::forms::tool_bar with specified image collection, and name.
static tool_bar	create (xtd::forms::dock_style style, const tool_bar_button_collection &buttons)
	A factory to create an xtd::forms::tool_bar with specified style.
static tool_bar	create (xtd::forms::dock_style style, const xtd::forms::image_list::image_collection &image_collection, const tool_bar_button_collection &buttons)
	A factory to create an xtd::forms::tool_bar with specified style, and image collection.
static tool_bar	create (xtd::forms::dock_style style, const xtd::forms::image_list::image_collection &image_collection, const tool_bar_button_collection &buttons, const xtd::string &name)
	A factory to create an xtd::forms::tool_bar with specified style, image collection, and name.
static tool_bar	create (const control &parent)
	A factory to create an xtd::forms::tool_bar with specified parent.
static tool_bar	create (const control &parent, const xtd::forms::image_list::image_collection &image_collection)
	A factory to create an xtd::forms::tool_bar with specified parent, and image collection.
static tool_bar	create (const control &parent, const xtd::forms::image_list::image_collection &image_collection, const xtd::string &name)
	A factory to create an xtd::forms::tool_bar with specified parent, image collection, and name.
static tool_bar	create (const control &parent, xtd::forms::dock_style style)
	A factory to create an xtd::forms::tool_bar with specified parent, and style.
static tool_bar	create (const control &parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection &image_collection)
	A factory to create an xtd::forms::tool_bar with specified parent, style, and image collection.
static tool_bar	create (const control &parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection &image_collection, const xtd::string &name)
	A factory to create an xtd::forms::tool_bar with specified parent, style, image collection, and name.
static tool_bar	create (const control &parent, const tool_bar_button_collection &buttons)
	A factory to create an xtd::forms::tool_bar with specified parent.
static tool_bar	create (const control &parent, const xtd::forms::image_list::image_collection &image_collection, const tool_bar_button_collection &buttons)
	A factory to create an xtd::forms::tool_bar with specified parent, and image collection.
static tool_bar	create (const control &parent, const xtd::forms::image_list::image_collection &image_collection, const tool_bar_button_collection &buttons, const xtd::string &name)
	A factory to create an xtd::forms::tool_bar with specified parent, image collection, and name.
static tool_bar	create (const control &parent, xtd::forms::dock_style style, const tool_bar_button_collection &buttons)
	A factory to create an xtd::forms::tool_bar with specified parent, and style.
static tool_bar	create (const control &parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection &image_collection, const tool_bar_button_collection &buttons)
	A factory to create an xtd::forms::tool_bar with specified parent, style, and image collection.
static tool_bar	create (const control &parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection &image_collection, const tool_bar_button_collection &buttons, const xtd::string &name)
	A factory to create an xtd::forms::tool_bar with specified parent, style, image collection, and name.

Protetced properties
forms::create_params	create_params () const noexcept override
	Gets the required creation parameters when the control handle is created.
xtd::drawing::font	default_font () const noexcept override
	Gets the default font of the control.
drawing::size	default_size () const noexcept override
	Gets the default size of the control.

Protetced methods
void	on_button_click (const xtd::forms::tool_bar_button_click_event_args &e)
	Raises the xtd::forms::tool_bar::button_click event.
void	on_button_drop_down (const xtd::forms::tool_bar_button_click_event_args &e)
	Raises the xtd::forms::tool_bar::button_drop_down event.
void	on_handle_created (const event_args &e) override
	Raises the xtd::forms::control::handle_created event.
void	on_handle_destroyed (const event_args &e) override
	Raises the xtd::forms::control::handle_destroyed event.
void	on_paint (xtd::forms::paint_event_args &e) override
	Raises the xtd::forms::control::paint event.
void	on_resize (const event_args &e) override
	Raises the xtd::forms::control::region event.
void	wnd_proc (message &message) override
	Processes Windows messages.

Additional Inherited Members
using	context_menu_ref
	Represent an xtd::forms::context_menu reference.
xtd::event< control, xtd::event_handler >	auto_size_changed
	Occurs when the value of the xtd::forms::control::auto_size property changes.
xtd::event< control, xtd::event_handler >	back_color_changed
	Occurs when the value of the xtd::forms::control::back_color property changes.
xtd::event< control, xtd::event_handler >	background_image_changed
	Occurs when the value of the xtd::forms::control::background_image property changes.
xtd::event< control, xtd::event_handler >	background_image_layout_changed
	Occurs when the value of the xtd::forms::control::background_image_layout property changes.
xtd::event< control, xtd::event_handler >	control_appearance_changed
	Occurs when the value of the xtd::forms::control::control_appearance property changes.
xtd::event< control, xtd::event_handler >	click
	Occurs when the xtd::forms::control is clicked.
xtd::event< control, xtd::event_handler >	client_size_changed
	Occurs when the value of the xtd::forms::control::client_size property changes.
xtd::event< control, xtd::event_handler >	cursor_changed
	Occurs when the value of the xtd::forms::control::cursor property changes.
xtd::event< control, xtd::forms::control_event_handler >	control_added
	Occurs when a new xtd::forms::control::control is added to the xtd::forms::control::control_collection.
xtd::event< control, xtd::forms::control_event_handler >	control_removed
	Occurs when a new xtd::forms::control:: is removed to the xtd::forms::control::control_collection.
xtd::event< control, xtd::event_handler >	dock_changed
	Occurs when the value of the xtd::forms::control::dock property changes.
xtd::event< control, xtd::event_handler >	double_click
	Occurs when the xtd::forms::control is double-clicked.
xtd::event< control, xtd::event_handler >	got_focus
	Occurs when the xtd::forms::control receives focus.
xtd::event< control, xtd::event_handler >	handle_created
	Occurs when a handle is created for the xtd::forms::control.
xtd::event< control, xtd::event_handler >	handle_destroyed
	Occurs when the control's handle is in the process of being destroyed.
xtd::event< control, xtd::event_handler >	enabled_changed
	Occurs when the value of the xtd::forms::control::enabled property changes.
xtd::event< control, xtd::event_handler >	fore_color_changed
	Occurs when the value of the xtd::forms::control::fore_color property changes.
xtd::event< control, xtd::event_handler >	font_changed
	Occurs when the value of the xtd::forms::control::font property changes.
xtd::event< control, xtd::forms::help_event_handler >	help_requested
	Occurs when the user requests help for a xtd::forms::control.
xtd::event< control, xtd::forms::key_event_handler >	key_down
	Occurs when a key is pressed while the xtd::forms::control has focus.
xtd::event< control, xtd::forms::key_press_event_handler >	key_press
	Occurs when a character. space or backspace key is pressed while the xtd::forms::control has focus.
xtd::event< control, xtd::forms::key_event_handler >	key_up
	Occurs when a key is released while the xtd::forms::control has focus.
xtd::event< control, xtd::event_handler >	layout
	Occurs when a xtd::forms::control should reposition its child controls.
xtd::event< control, xtd::event_handler >	location_changed
	Occurs when the value of the xtd::forms::control::location property changes.
xtd::event< control, xtd::event_handler >	lost_focus
	Occurs when the xtd::forms::control loses focus.
xtd::event< control, xtd::forms::mouse_event_handler >	mouse_click
	Occurs when the xtd::forms::control is clicked by the mouse.
xtd::event< control, xtd::forms::mouse_event_handler >	mouse_double_click
	Occurs when the xtd::forms::control is double clicked by the mouse.
xtd::event< control, xtd::forms::mouse_event_handler >	mouse_down
	Occurs when the mouse pointer is over the xtd::forms::control and a mouse button is pressed.
xtd::event< control, xtd::event_handler >	mouse_enter
	Occurs when the mouse pointer enters the xtd::forms::control.
xtd::event< control, xtd::forms::mouse_event_handler >	mouse_horizontal_wheel
	Occurs when the mouse horizontal wheel moves while the xtd::forms::control has focus.
xtd::event< control, xtd::event_handler >	mouse_leave
	Occurs when the mouse pointer leaves the xtd::forms::control.
xtd::event< control, xtd::forms::mouse_event_handler >	mouse_move
	Occurs when the mouse pointer is moved over the xtd::forms::control.
xtd::event< control, xtd::forms::mouse_event_handler >	mouse_up
	Occurs when the mouse pointer is over the xtd::forms::control and a mouse button is released.
xtd::event< control, xtd::forms::mouse_event_handler >	mouse_wheel
	Occurs when the mouse wheel moves while the xtd::forms::control has focus.
xtd::event< control, xtd::event_handler >	move
	Occurs when the control is moved.
xtd::event< control, xtd::forms::paint_event_handler >	paint
	Occurs when the xtd::forms::control is redrawn.
xtd::event< control, xtd::event_handler >	parent_changed
	Occurs when the value of the xtd::forms::control::parent property changes.
xtd::event< control, xtd::event_handler >	region_changed
	Occurs when the value of the xtd::forms::control::region property changes.
xtd::event< control, xtd::event_handler >	resize
	Occurs when the xtd::forms::control is resized.
xtd::event< control, xtd::event_handler >	right_to_left_changed
	Occurs when the value of the xtd::forms::control::right_to_left property changes.
xtd::event< control, xtd::event_handler >	size_changed
	Occurs when the value of the xtd::forms::control::size property changes.
xtd::event< control, xtd::event_handler >	style_sheet_changed
	Occurs when the value of the xtd::forms::control::style_sheet property changes or when xtd::application::style_sheet property changes.
xtd::event< control, xtd::event_handler >	system_colors_changed
	Occurs when the xtd::drwing::system_colors changes.
xtd::event< control, xtd::event_handler >	tab_stop_changed
	Occurs when the xtd::forms::control::tab_stop property value changes.
xtd::event< control, xtd::event_handler >	text_changed
	Occurs when the value of the xtd::forms::control::text property changes.
xtd::event< control, xtd::event_handler >	visible_changed
	Occurs when the value of the xtd::forms::control::visible property changes.
	control ()
	Initializes a new instance of the xtd::forms::control class with default settings.
	control (const xtd::string &text)
	Initializes a new instance of the xtd::forms::control class with specific text.
	control (const control &parent, const xtd::string &text)
	Initializes a new instance of the xtd::forms::control class as a child control, with specific text.
	control (const xtd::string &text, int32 left, int32 top, int32 width, int32 height)
	Initializes a new instance of the control class with specific text, size, and location.
	control (const control &parent, const xtd::string &text, int32 left, int32 top, int32 width, int32 height)
	Initializes a new instance of the xtd::forms::control class as a child control, with specific text, size, and location.
virtual auto	anchor () const noexcept -> xtd::forms::anchor_styles
	Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
virtual auto	anchor (xtd::forms::anchor_styles value) -> control &
	Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
virtual auto	auto_scroll_point () const noexcept -> xtd::drawing::point
	Gets where this control is scrolled to in scroll_control_into_view(control).
virtual auto	auto_size () const noexcept -> bool
	Gets a value that indicates whether the control resizes based on its contents.
virtual auto	auto_size (bool value) -> control &
	Sets a value that indicates whether the control resizes based on its contents.
virtual auto	back_color () const noexcept -> xtd::drawing::color
	Gets the background color for the control.
virtual auto	back_color (const xtd::drawing::color &value) -> control &
	Sets the background color for the control.
virtual auto	back_color (xtd::null_ptr) -> control &
	Resets the background color for the control.
virtual auto	background_image () const noexcept -> const xtd::drawing::image &
	Gets the background image displayed in the control.
virtual auto	background_image (const xtd::drawing::image &value) -> control &
	Sets the background image displayed in the control.
virtual auto	background_image_layout () const noexcept -> xtd::forms::image_layout
	Gets the background image layout as defined in the xtd::forms::image_layout enumeration.
virtual auto	background_image_layout (xtd::forms::image_layout value) -> control &
	Sets the background image layout as defined in the xtd::forms::image_layout enumeration.
virtual auto	bottom () const noexcept -> xtd::int32
	Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
virtual auto	bounds () const noexcept -> xtd::drawing::rectangle
	Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
virtual auto	bounds (const xtd::drawing::rectangle &value) -> control &
	Sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
virtual auto	can_focus () const noexcept -> bool
	Gets a value indicating whether the control can receive focus.
virtual auto	can_select () const noexcept -> bool
	Gets a value indicating whether the control can be selected.
auto	can_raise_events () const noexcept -> bool override
	Determines if events can be raised on the control.
virtual auto	client_rectangle () const noexcept -> const xtd::drawing::rectangle &
	Gets the rectangle that represents the client area of the control.
virtual auto	client_size () const noexcept -> const xtd::drawing::size &
	Gets the height and width of the client area of the control.
virtual auto	client_size (const xtd::drawing::size &value) -> control &
	Sets the height and width of the client area of the control.
virtual auto	company_name () const noexcept -> xtd::string
	Gets the name of the company or creator of the application containing the control.
virtual auto	context_menu () const noexcept -> std::optional< context_menu_ref >
	Gets the xtd::forms::context_menu that is displayed in the control.
virtual auto	context_menu (xtd::forms::context_menu &value) -> control &
	Sets the xtd::forms::context_menu that is displayed in the control.
virtual auto	context_menu (xtd::null_ptr) -> control &
	Resets the xtd::forms::context_menu that is displayed in the control.
virtual auto	control_appearance () const noexcept -> xtd::forms::control_appearance
	Gets control appearance.
virtual auto	control_appearance (xtd::forms::control_appearance value) -> control &
	Sets control appearance.
virtual auto	controls () noexcept -> control_collection &
	Gets the collection of controls contained within the control.
virtual auto	controls () const noexcept -> const control_collection &
	Gets the collection of controls contained within the control.
virtual auto	created () const noexcept -> bool
	Gets a value indicating whether the control has been created.
virtual auto	cursor () const noexcept -> xtd::forms::cursor
	Gets the cursor that is displayed when the mouse pointer is over the control.
virtual auto	cursor (const xtd::forms::cursor &value) -> control &
	Sets the cursor that is displayed when the mouse pointer is over the control.
virtual auto	cursor (xtd::null_ptr) -> control &
	Resets the cursor that is displayed when the mouse pointer is over the control.
virtual auto	display_rectangle () const noexcept -> xtd::drawing::rectangle
	Gets the rectangle that represents the display area of the control.
virtual auto	double_buffered () const noexcept -> bool
	Gets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
virtual auto	double_buffered (bool value) -> control &
	Sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
virtual auto	enabled () const noexcept -> bool
	Gets a value indicating whether the control can respond to user interaction.
virtual auto	enabled (bool value) -> control &
	Sets a value indicating whether the control can respond to user interaction.
virtual auto	focused () const noexcept -> bool
	Gets a value indicating whether the control has input focus.
virtual auto	font () const noexcept -> xtd::drawing::font
	Gets the font of the text displayed by the control.
virtual auto	font (const xtd::drawing::font &value) -> control &
	Sets the font of the text displayed by the control.
virtual auto	font (xtd::null_ptr) -> control &
	Resets the font of the text displayed by the control.
virtual auto	fore_color () const noexcept -> xtd::drawing::color
	Gets the foreground color of the control.
virtual auto	fore_color (const xtd::drawing::color &value) -> control &
	Sets the foreground color of the control.
virtual auto	fore_color (xtd::null_ptr) -> control &
	Resets the foreground color of the control.
auto	handle () const -> xtd::intptr override
	Gets the window handle that the control is bound to.
virtual auto	height () const noexcept -> xtd::int32
	Gets the height of the control.
virtual auto	height (xtd::int32 value) -> control &
	Sets the height of the control.
auto	invoke_required () const noexcept -> bool override
	Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on.
auto	is_handle_created () const noexcept -> bool
	Gets a value indicating whether the control has a handle associated with it.
virtual auto	left () const noexcept -> xtd::int32
	Gets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual auto	left (xtd::int32 value) -> control &
	Sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual auto	location () const noexcept -> xtd::drawing::point
	Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
virtual auto	location (const xtd::drawing::point &value) -> control &
	Sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
virtual auto	margin () const noexcept -> xtd::forms::padding
	Gets the space between controls.
virtual auto	margin (const xtd::forms::padding &value) -> control &
	Sets the space between controls.
virtual auto	maximum_client_size () const noexcept -> const xtd::drawing::size &
	Gets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	maximum_client_size (const xtd::drawing::size &size) -> control &
	Sets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	maximum_size () const noexcept -> const xtd::drawing::size &
	Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	maximum_size (const xtd::drawing::size &value) -> control &
	Sets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	minimum_client_size () const noexcept -> const xtd::drawing::size &
	Gets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	minimum_client_size (const xtd::drawing::size &value) -> control &
	Sets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	minimum_size () const noexcept -> const xtd::drawing::size &
	Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	minimum_size (const xtd::drawing::size &value) -> control &
	Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
auto	native_handle () const noexcept -> xtd::intptr
	Gets the native handle that the control is bound to.
virtual auto	name () const noexcept -> const xtd::string &
	Gets the name of the control.
virtual auto	name (const xtd::string &value) -> control &
	Sets the name of the control.
virtual auto	padding () const noexcept -> xtd::forms::padding
	Gets padding within the control.
virtual auto	padding (const xtd::forms::padding &value) -> control &
	Sets padding within the control.
virtual auto	parent () const noexcept -> std::optional< xtd::forms::control_ref >
	Gets the parent container of the control.
virtual auto	parent (const control &value) -> control &
	Sets the parent container of the control.
virtual auto	parent (xtd::null_ptr) -> control &
	Resets the parent container of the control.
virtual auto	product_name () const noexcept -> xtd::string
	Gets the product name of the assembly containing the control.
auto	recreating_handle () const noexcept -> bool
	Gets a value indicating whether the control is currently re-creating its handle.
virtual auto	region () const noexcept -> const xtd::drawing::region &
	Gets the window region associated with the control.
virtual auto	region (const xtd::drawing::region &value) -> control &
	Sets the window region associated with the control.
virtual auto	right () const noexcept -> xtd::int32
	Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
virtual auto	right_to_left () const noexcept -> xtd::forms::right_to_left
	Gets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
virtual auto	right_to_left (xtd::forms::right_to_left value) -> control &
	Sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
virtual auto	right_to_left (xtd::null_ptr) -> control &
	Resets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
virtual auto	size () const noexcept -> xtd::drawing::size
	Gets the height and width of the control.
virtual auto	size (const xtd::drawing::size &value) -> control &
	Sets the height and width of the control.
virtual auto	style_sheet () const noexcept -> xtd::forms::style_sheets::style_sheet
	Gets the contol style sheet.
virtual auto	style_sheet (const xtd::forms::style_sheets::style_sheet &value) -> control &
	Sets the contol style sheet.
virtual auto	style_sheet (const xtd::string &value) -> control &
	Sets the contol style sheet.
virtual auto	style_sheet (xtd::null_ptr) -> control &
	Resets the contol style sheet.
virtual auto	tab_stop () const noexcept -> bool
	Gets a value indicating whether the user can give the focus to this control using the TAB key.
virtual auto	tab_stop (bool value) -> control &
	Sets a value indicating whether the user can give the focus to this control using the TAB key.
virtual auto	tag () const noexcept -> const xtd::any_object &
	Gets the object that contains data about the control.
virtual auto	tag (const xtd::any_object &value) -> control &
	Sets the object that contains data about the control.
virtual auto	text () const noexcept -> const xtd::string &
	Gets the text associated with this control.
virtual auto	text (const xtd::string &value) -> control &
	Sets the text associated with this control.
auto	toolkit_handle () const noexcept -> xtd::intptr
	Gets the toolkit handle that the control is bound to.
virtual auto	top () const noexcept -> xtd::int32
	Gets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual auto	top (xtd::int32 value) -> control &
	Sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual auto	top_level_control () const noexcept -> std::optional< xtd::forms::control_ref >
	Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
virtual auto	visible () const noexcept -> bool
	Gets a value indicating whether the control and all its child controls are displayed.
virtual auto	visible (bool value) -> control &
	Sets a value indicating whether the control and all its child controls are displayed.
virtual auto	width () const noexcept -> xtd::int32
	Gets the width of the control.
virtual auto	width (xtd::int32 value) -> control &
	Sets the width of the control.
auto	begin_invoke (xtd::delegate< void()> method) -> xtd::async_result override
	Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
auto	begin_invoke (xtd::delegate< void(xtd::array< xtd::any_object >)> method, const xtd::array< xtd::any_object > &args) -> xtd::async_result override
	Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
virtual auto	bring_to_front () -> void
	Brings the control to the front of the z-order.
auto	compare_to (const control &value) const noexcept -> xtd::int32 override
auto	create_control () -> void
	Forces the creation of the visible control, including the creation of the handle and any visible child controls.
auto	create_graphics () const -> xtd::drawing::graphics
	Creates the xtd::drawing::graphics for the control.
virtual auto	destroy_control () -> void
	Forces the destruction of the visible control, including the destruction of the handle and any visible child controls.
auto	end_invoke (xtd::async_result async) -> std::optional< xtd::object_ref > override
	Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed.
auto	equals (const xtd::object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const control &value) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	focus () -> bool
	Sets input focus to the control.
auto	get_auto_size_mode () const -> xtd::forms::auto_size_mode
	Gets a value indicating how a control will behave when its auto_size property is enabled.
auto	get_child_index (xtd::intptr child) const -> xtd::usize
	Retrieves the index of a control within the control collection.
auto	get_child_index (xtd::intptr child, bool &throw_exception) const -> xtd::usize
	Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
virtual auto	hide () -> void
	Conceals the control from the user.
virtual auto	invalidate () const -> void
	Invalidates the entire surface of the control and causes the control to be redrawn.
virtual auto	invalidate (bool invalidate_children) const -> void
	Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
virtual auto	invalidate (const xtd::drawing::rectangle &rect) const -> void
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
virtual auto	invalidate (const xtd::drawing::rectangle &rect, bool invalidate_children) const -> void
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
virtual auto	invalidate (const xtd::drawing::region &region) const -> void
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
virtual auto	invalidate (const xtd::drawing::region &region, bool invalidate_children) const -> void
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
auto	invoke (xtd::delegate< void()> method) -> std::optional< xtd::object_ref > override
	Executes the specified delegate on the thread that owns the control's underlying window handle.
auto	invoke (xtd::delegate< void(xtd::array< xtd::any_object >)> method, const xtd::array< xtd::any_object > &args) -> std::optional< xtd::object_ref > override
	Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
auto	invoke (xtd::delegate< void(xtd::array< xtd::any_object >)> method, const xtd::any_object &arg) -> std::optional< xtd::object_ref > override
	Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
auto	perform_layout () -> void
	Forces the control to apply layout logic to all its child controls.
auto	point_to_client (const xtd::drawing::point &p) const -> xtd::drawing::point
	Computes the location of the specified screen point into client coordinates.
auto	point_to_screen (const xtd::drawing::point &p) const -> xtd::drawing::point
	Computes the location of the specified client point into screen coordinates.
auto	post_message (xtd::intptr hwnd, xtd::int32 msg, xtd::intptr wparam, xtd::intptr lparam) const -> bool
	Places (posts) a message in the message queue with specified hwnd, message, wparam and lparam.
virtual auto	pre_process_message (const xtd::forms::message &message) -> bool
	Preprocesses keyboard or input messages within the message loop before they are dispatched.
virtual auto	refresh () const -> void
	Forces the control to invalidate its client area and immediately redraw itself and any child controls.
auto	resume_layout () -> void
	Resumes usual layout logic.
auto	resume_layout (bool perform_layout) -> void
	Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
auto	send_message (xtd::intptr hwnd, xtd::int32 msg, xtd::intptr wparam, xtd::intptr lparam) const -> xtd::intptr
	Send a message with specified hwnd, message, wparam and lparam.
auto	set_auto_size_mode (xtd::forms::auto_size_mode auto_size_modeauto_size_mode) -> void
	Sets a value indicating how a control will behave when its auto_size property is enabled.
auto	set_bounds (xtd::int32 x, xtd::int32 y, xtd::int32 width, xtd::int32 height) -> void
	Sets the bounds of the control to the specified location and size.
auto	set_bounds (xtd::int32 x, xtd::int32 y, xtd::int32 width, xtd::int32 height, xtd::forms::bounds_specified specified) -> void
	Sets the specified bounds of the control to the specified location and size.
virtual auto	show () -> void
	Displays the control to the user.
auto	suspend_layout () -> void
	Temporarily suspends the layout logic for the control.
auto	to_string () const noexcept -> xtd::string override
	Returns a string containing the name of the control, if any.
virtual auto	update () const -> void
	Causes the control to redraw the invalidated regions within its client area.
auto	operator<< (control &child) -> control &
	Add child control.
auto	operator>> (control &child) -> control &
	Remove child control.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	compare_to (const control &obj) const noexcept -> xtd::int32=0
	Compares the current instance with another object of the same type.
virtual auto	equals (const control &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
static auto	check_for_illegal_cross_thread_calls () noexcept -> bool
	Gets a value indicating whether to catch calls on the wrong thread that access a xtd::forms::contrtol::handle property when an application is being debugged.
static auto	check_for_illegal_cross_thread_calls (bool value) -> void
	Sets a value indicating whether to catch calls on the wrong thread that access a xtd::forms::contrtol::handle property when an application is being debugged.
static auto	modifier_keys () noexcept -> xtd::forms::keys
	Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
static auto	mouse_buttons () noexcept -> xtd::forms::mouse_buttons
	Gets a value indicating which of the mouse buttons is in a pressed state.
static auto	mouse_position () noexcept -> xtd::drawing::point
	Gets the position of the mouse cursor in screen coordinates.
static auto	create () -> control
	A factory to create a specified control.
static auto	create (const xtd::drawing::point &location) -> control
	A factory to create a specified control with specified location.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size) -> control
	A factory to create a specified control with specified location, and size.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control
	A factory to create a specified control with specified location, size, and name.
static auto	create (const control &paren) -> control
	A factory to create a specified control with specified parent.
static auto	create (const control &parent, const xtd::drawing::point &location) -> control
	A factory to create a specified control with specified parent, location, size, and name.
static auto	create (const control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size) -> control
	A factory to create a specified control with specified parent, location, and size.
static auto	create (const control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control
	A factory to create a specified control with specified parent, location, size, and name.
template<typename control_t>
static auto	create () -> control_t
	A factory to create a specified control.
template<typename control_t>
static auto	create (const xtd::drawing::point &location) -> control_t
	A factory to create a specified control with specified location.
template<typename control_t>
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size) -> control_t
	A factory to create a specified control with specified location, and size.
template<typename control_t>
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control_t
	A factory to create a specified control with specified location, size, and name.
template<typename control_t>
static auto	create (const control &parent) -> control_t
	A factory to create a specified control with specified parent.
template<typename control_t>
static auto	create (const control &parent, const xtd::drawing::point &location) -> control_t
	A factory to create a specified control with specified parent, and location.
template<typename control_t>
static auto	create (const control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size) -> control_t
	A factory to create a specified control with specified parent, location, and size.
template<typename control_t>
static auto	create (const control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control_t
	A factory to create a specified control with specified parent, location, size, and name.
template<typename control_t>
static auto	create (const xtd::string &text) -> control_t
	A factory to create a specified control with specified text.
template<typename control_t>
static auto	create (const xtd::string &text, const xtd::drawing::point &location) -> control_t
	A factory to create a specified control with specified text, and location.
template<typename control_t>
static auto	create (const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size) -> control_t
	A factory to create a specified control with specified text, location, and size.
template<typename control_t>
static auto	create (const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control_t
	A factory to create a specified control with specified text, location,size, and name.
template<typename control_t>
static auto	create (const control &parent, const xtd::string &text) -> control_t
	A factory to create a specified control with specified parent, and text.
template<typename control_t>
static auto	create (const control &parent, const xtd::string &text, const xtd::drawing::point &location) -> control_t
	A factory to create a specified control with specified parent, text, and location.
template<typename control_t>
static auto	create (const control &parent, const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size) -> control_t
	A factory to create a specified control with specified parent, text, location, and size.
template<typename control_t>
static auto	create (const control &parent, const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control_t
	A factory to create a specified control with specified parent, text, location, size, and name.
static auto	from_child_handle (xtd::intptr handle) -> std::optional< xtd::forms::control_ref >
	Retrieves the control that contains the specified handle.
static auto	from_handle (xtd::intptr handle) -> std::optional< xtd::forms::control_ref >
	Returns the control that is currently associated with the specified handle.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.
auto	control_state () const noexcept -> xtd::forms::visual_styles::control_state
	Gets state.
virtual auto	default_back_color () const noexcept -> xtd::drawing::color
	Gets the default background color of the control.
virtual auto	default_cursor () const noexcept -> xtd::forms::cursor
	Gets the default cursor for the control.
virtual auto	default_fore_color () const noexcept -> xtd::drawing::color
	Gets the default foreground color of the control.
virtual auto	create_handle () -> void
	Creates a handle for the control.
virtual auto	destroy_handle () -> void
	Destroys the handle associated with the control.
virtual auto	def_wnd_proc (xtd::forms::message &message) -> void
	Sends the specified message to the default window procedure.
auto	get_style (xtd::forms::control_styles flag) const noexcept -> bool
	Retrieves the value of the specified control style bit for the control.
virtual auto	measure_control () const noexcept -> xtd::drawing::size
	Measure this control.
auto	measure_text () const noexcept -> xtd::drawing::size
	Measure this control text.
virtual auto	on_auto_size_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::auto_size_changed event.
virtual auto	on_back_color_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::back_color_changed event.
virtual auto	on_background_image_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::background_image_changed event.
virtual auto	on_background_image_layout_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::background_image_layout_changed event.
virtual auto	on_control_appearance_changed (const xtd::event_args &e) -> void
	Raises the control::control_appearance_changed event.
virtual auto	on_click (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::click event.
virtual auto	on_client_size_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::client_size_changed event.
virtual auto	on_control_added (const xtd::forms::control_event_args &e) -> void
	Raises the xtd::forms::control::control_added event.
virtual auto	on_control_removed (const xtd::forms::control_event_args &e) -> void
	Raises the xtd::forms::control::control_removed event.
virtual auto	on_create_control () -> void
	Raises the xtd::forms::control::create_control event.
virtual auto	on_cursor_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::cursor_changed event.
virtual auto	on_destroy_control () -> void
	Raises the xtd::forms::control::destroy_control event.
virtual auto	on_dock_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::dock_changed event.
virtual auto	on_double_click (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::double_click event.
virtual auto	on_enabled_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::enabled_changed event.
virtual auto	on_fore_color_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::fore_color_changed event.
virtual auto	on_font_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::font_changed event.
virtual auto	on_got_focus (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::got_focus event.
virtual auto	on_help_requested (xtd::forms::help_event_args &e) -> void
	Raises the xtd::forms::control::help_requested event.
virtual auto	on_key_down (xtd::forms::key_event_args &e) -> void
	Raises the xtd::forms::control::key_down event.
virtual auto	on_key_press (xtd::forms::key_press_event_args &e) -> void
	Raises the xtd::forms::control::key_press event.
virtual auto	on_key_up (xtd::forms::key_event_args &e) -> void
	Raises the xtd::forms::control::key_up event.
virtual auto	on_layout (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::layout event.
virtual auto	on_location_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::location_changed event.
virtual auto	on_lost_focus (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::lost_focus event.
virtual auto	on_mouse_click (const xtd::forms::mouse_event_args &e) -> void
	Raises the xtd::forms::control::mouse_click event.
virtual auto	on_mouse_double_click (const xtd::forms::mouse_event_args &e) -> void
	Raises the xtd::forms::control::mouse_double_click event.
virtual auto	on_mouse_down (const xtd::forms::mouse_event_args &e) -> void
	Raises the xtd::forms::control::mouse_down event.
virtual auto	on_mouse_enter (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::mouse_enter event.
virtual auto	on_mouse_horizontal_wheel (const xtd::forms::mouse_event_args &e) -> void
	Raises the xtd::forms::control::mouse_horizontal_wheel event.
virtual auto	on_mouse_leave (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::mouse_leave event.
virtual auto	on_mouse_move (const xtd::forms::mouse_event_args &e) -> void
	Raises the xtd::forms::control::mouse_move event.
virtual auto	on_mouse_up (const xtd::forms::mouse_event_args &e) -> void
	Raises the xtd::forms::control::mouse_up event.
virtual auto	on_mouse_wheel (const xtd::forms::mouse_event_args &e) -> void
	Raises the xtd::forms::control::mouse_wheel event.
virtual auto	on_move (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::move event.
virtual auto	on_paint_background (xtd::forms::paint_event_args &e) -> void
	Paints the background of the xtd::forms::control.
virtual auto	on_parent_back_color_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::parent_back_color_changed event.
virtual auto	on_parent_cursor_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::parent_cursor_changed event.
virtual auto	on_parent_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::parent_changed event.
virtual auto	on_parent_enabled_changed (const xtd::event_args &e) -> void
	Raises the xtd::control::enabled_changed event when the xtd::control::enabled property value of the control's container changes..
virtual auto	on_parent_fore_color_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::parent_fore_color_changed event.
virtual auto	on_parent_font_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::parent_font_changed event.
virtual auto	on_region_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::region_changed event.
virtual auto	on_right_to_left_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::right_to_left_changed event.
virtual auto	on_size_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::size_changed event.
virtual auto	on_style_sheet_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::style_sheet_changed event.
virtual auto	on_system_colors_changed (const xtd::event_args &e) -> void
	Raises the control::system_colors_changed event.
virtual auto	on_tab_stop_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::tab_stop_changed event.
virtual auto	on_text_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::text_changed event.
virtual auto	on_visible_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::visible_changed event.
auto	post_recreate_handle () noexcept -> void
virtual auto	recreate_handle () -> void
	Forces the re-creation of the handle for the control.
virtual auto	set_bounds_core (xtd::int32 x, xtd::int32 y, xtd::int32 width, xtd::int32 height, xtd::forms::bounds_specified specified) -> void
	Performs the work of setting the specified bounds of this control.
auto	set_can_focus (bool value) -> void
	Sets a value indicating whether the control can receive focus.
virtual auto	set_text (const xtd::string &text) -> void
	Sets the text associated with this control.
virtual auto	set_client_size_core (xtd::int32 width, xtd::int32 height) -> void
	Sets the size of the client area of the control.
auto	set_parent (xtd::intptr handle) -> void
	Sets the parent handle of the control.
auto	set_style (xtd::forms::control_styles flag, bool value) -> void
	Sets a specified control_styles flag to either true or false.
	component ()
	Initialises a new instance of the component class.
auto	design_mode () const noexcept -> bool
	Gets a value that indicates whether the component is currently in design mode.
static auto	set_mouse_buttons (xtd::forms::mouse_buttons value) -> void
	Sets a value indicating which of the mouse buttons is in a pressed state.

Member Typedef Documentation

tool_bar_button_collection

using xtd::forms::tool_bar::tool_bar_button_collection

Represents the base type of the xtd::forms::tool_bar::buttons collection.

Constructor & Destructor Documentation

tool_bar()

xtd::forms::tool_bar::tool_bar

(

)

Initializes a new instance of the xtd::forms::tool_bar class.

Remarks

A newly created toolbar control is empty; add xtd::forms::tool_bar_button controls by setting the xtd::forms::tool_bar::buttons property.

Member Function Documentation

appearance() [1/2]

virtual xtd::forms::tool_bar_appearance xtd::forms::tool_bar::appearance ( ) const

virtualnoexcept

Gets the value that determines the appearance of a toolbar control and its buttons.

Returns

One of the xtd::forms::tool_bar_appearance values. The default is xtd::forms::tool_bar::appearance::normal.

Remarks

The xtd::forms::tool_bar::appearance property affects the appearance of the buttons assigned to the toolbar. When the appearance is set to xtd::forms::tool_bar_appearance::normal, the toolbar's buttons appear three-dimensional and raised. Set the xtd::forms::tool_bar::appearance property of the toolbar to xtd::forms::tool_bar_ppearance::flat to give the toolbar's buttons a flat appearance. As the mouse pointer moves over the flat buttons, they appear raised and three-dimensional. Separators on a xtd::forms::tool_bar with the xtd::forms::tool_bar::appearance property set to xtd::forms::tool_bar_appearance::flat appear as etched lines rather than spaces between the raised buttons. The flat style buttons give your application a more Web-like look.

appearance() [2/2]

virtual tool_bar & xtd::forms::tool_bar::appearance ( xtd::forms::tool_bar_appearance value )

virtual

Sets the value that determines the appearance of a toolbar control and its buttons.

Parameters

value

One of the xtd::forms::tool_bar_appearance values. The default is xtd::forms::tool_bar::appearance::normal.

Returns

Current tool_bar instance.

Remarks

The xtd::forms::tool_bar::appearance property affects the appearance of the buttons assigned to the toolbar. When the appearance is set to xtd::forms::tool_bar_appearance::normal, the toolbar's buttons appear three-dimensional and raised. Set the xtd::forms::tool_bar::appearance property of the toolbar to xtd::forms::tool_bar_ppearance::flat to give the toolbar's buttons a flat appearance. As the mouse pointer moves over the flat buttons, they appear raised and three-dimensional. Separators on a xtd::forms::tool_bar with the xtd::forms::tool_bar::appearance property set to xtd::forms::tool_bar_appearance::flat appear as etched lines rather than spaces between the raised buttons. The flat style buttons give your application a more Web-like look.

border_sides() [1/2]

virtual forms::border_sides xtd::forms::tool_bar::border_sides ( ) const

virtualnoexcept

Gets the border sides for the control.

Returns

A bitwise combination of the A bitwise combination values. The default is border_style::all.

border_sides() [2/2]

virtual tool_bar & xtd::forms::tool_bar::border_sides ( forms::border_sides border_sides )

virtual

Sets the border sides for the control.

Parameters

border_style

A bitwise combination of the border_sides values. The default is border_style::all.

Returns

Current tool_bar instance.

border_style() [1/3]

virtual forms::border_style xtd::forms::tool_bar::border_style ( ) const

virtualnoexcept

Gets the border style for the control.

Returns

One of the xtd::forms::border_style values. The default is xtd::forms::border_style::none.

Remarks

The xtd::forms::tool_bar can take on a sunken, three-dimensional appearance when the xtd::forms::tool_bar::border_style property is set to xtd::forms::border_style::fixed_3d. To display a flat thin border around the toolbar control, set the xtd::forms::tool_bar::border_style property to xtd::forms::border_style.fixed_single.

border_style() [2/3]

virtual tool_bar & xtd::forms::tool_bar::border_style ( forms::border_style value )

virtual

Sets the border style for the control.

Parameters

value

One of the xtd::forms::border_style values. The default is xtd::forms::border_style::none.

Returns

Current tool_bar instance.

Remarks

The xtd::forms::tool_bar can take on a sunken, three-dimensional appearance when the xtd::forms::tool_bar::border_style property is set to xtd::forms::border_style::fixed_3d. To display a flat thin border around the toolbar control, set the xtd::forms::tool_bar::border_style property to xtd::forms::border_style.fixed_single.

border_style() [3/3]

virtual xtd::forms::tool_bar & xtd::forms::tool_bar::border_style ( std::nullptr_t value )

virtual

Resets the border style for the control.

Parameters

value

nullptr.

Returns

Current tool_bar instance.

Remarks

The xtd::forms::tool_bar can take on a sunken, three-dimensional appearance when the xtd::forms::tool_bar::border_style property is set to xtd::forms::border_style::fixed_3d. To display a flat thin border around the toolbar control, set the xtd::forms::tool_bar::border_style property to xtd::forms::border_style.fixed_single.

buttons() [1/2]

const tool_bar_button_collection & xtd::forms::tool_bar::buttons ( ) const

noexcept

Gets the collection of xtd::forms::tool_bar_button controls assigned to the toolbar control.

Returns

A xtd::forms::tool_bar::tool_bar_button_collection that contains a collection of xtd::forms::tool_bar_button controls.

Remarks

The xtd::forms::tool_bar::item property is a zero-based indexed collection used to hold all the xtd::forms::tool_bar_button controls assigned to the toolbar. Because the property is read-only, it can not be assigned a collection of toolbar buttons directly. Toolbar item can be added or removed by using the methods inherited from the xtd::forms::tool_bar::tool_bar_button_collection class. Use the xtd::forms::tool_bar::tool_bar_button_collection::push_back method to add individual buttons and the xtd::forms::tool_bar::tool_bar_button_collection::erase method to delete a item. Call the xtd::forms::tool_bar::tool_bar_button_collection::clear method to remove all the buttons from the collection.

buttons() [2/2]

tool_bar_button_collection & xtd::forms::tool_bar::buttons

(

)

Gets the collection of xtd::forms::tool_bar_button controls assigned to the toolbar control.

Returns

A xtd::forms::tool_bar::tool_bar_button_collection that contains a collection of xtd::forms::tool_bar_button controls.

Remarks

The xtd::forms::tool_bar::item property is a zero-based indexed collection used to hold all the xtd::forms::tool_bar_button controls assigned to the toolbar. Because the property is read-only, it can not be assigned a collection of toolbar buttons directly. Toolbar item can be added or removed by using the methods inherited from the xtd::forms::tool_bar::tool_bar_button_collection class. Use the xtd::forms::tool_bar::tool_bar_button_collection::push_back method to add individual buttons and the xtd::forms::tool_bar::tool_bar_button_collection::erase method to delete a item. Call the xtd::forms::tool_bar::tool_bar_button_collection::clear method to remove all the buttons from the collection.

button_size() [1/3]

virtual xtd::drawing::size xtd::forms::tool_bar::button_size ( ) const

virtualnoexcept

Gets the size of the buttons on the toolbar control.

Returns

A xtd::drawing::size object that represents the size of the xtd::forms::tool_bar_button controls on the toolbar. The default size has a width of 24 pixels and a height of 22 pixels, or large enough to accommodate the xtd::drawing::image and text, whichever is greater.

Remarks

If the xtd::forms::tool_bar::button_size is not set, it is set to its default. Alternatively, a xtd::forms::tool_bar::size is computed to accommodate the largest xtd::drawing::image and text assigned to the xtd::forms::tool_bar_button controls.

button_size() [2/3]

virtual tool_bar & xtd::forms::tool_bar::button_size ( const xtd::drawing::size & value )

virtual

Sets the size of the buttons on the toolbar control.

Parameters

value

A xtd::drawing::size object that represents the size of the xtd::forms::tool_bar_button controls on the toolbar. The default size has a width of 24 pixels and a height of 22 pixels, or large enough to accommodate the xtd::drawing::image and text, whichever is greater.

Returns

Current tool_bar instance.

Remarks

If the xtd::forms::tool_bar::button_size is not set, it is set to its default. Alternatively, a xtd::forms::tool_bar::size is computed to accommodate the largest xtd::drawing::image and text assigned to the xtd::forms::tool_bar_button controls.

button_size() [3/3]

virtual tool_bar & xtd::forms::tool_bar::button_size ( std::nullptr_t value )

virtual

Resets the size of the buttons on the toolbar control.

Parameters

value

nullptr.

Returns

Current tool_bar instance.

Remarks

If the xtd::forms::tool_bar::button_size is not set, it is set to its default. Alternatively, a xtd::forms::tool_bar::size is computed to accommodate the largest xtd::drawing::image and text assigned to the xtd::forms::tool_bar_button controls.

divider() [1/2]

virtual bool xtd::forms::tool_bar::divider ( ) const

virtualnoexcept

Gets a value indicating whether the toolbar displays a divider.

Returns

true if the toolbar displays a divider; otherwise, false. The default is true.

Remarks

Dividers are displayed to help distinguish the toolbar from adjacent controls, such as menus. A divider is displayed as a raised edge along the top of the xtd::forms::tool_bar control.

Note

Only on Windows and if xtd::forms::tool_bar::appearance is set to xtd::forms::tool_bar_appearance::system.

divider() [2/2]

virtual tool_bar & xtd::forms::tool_bar::divider ( bool value )

virtual

Sets a value indicating whether the toolbar displays a divider.

Parameters

value

true if the toolbar displays a divider; otherwise, false. The default is true.

Returns

Current tool_bar instance.

Remarks

Dividers are displayed to help distinguish the toolbar from adjacent controls, such as menus. A divider is displayed as a raised edge along the top of the xtd::forms::tool_bar control.

Note

Only on Windows and if xtd::forms::tool_bar::appearance is set to xtd::forms::tool_bar_appearance::system.

dock() [1/2]

dock_style xtd::forms::tool_bar::dock ( ) const

overridevirtualnoexcept

Gets which control borders are docked to its parent control and determines how a control is resized with its parent.

Returns

One of the xtd::forms::dock_style values. The default is xtd::forms::dock_style::none.

Remarks

Use the xtd::forms::control::dock property to define how a control is automatically resized as its parent control is resized. For example, setting xtd::forms::control::dock to xtd::forms::dock_style::left causes the control to align itself with the left edges of its parent control and to resize as the parent control is resized. Controls are docked in their Z-order, which is the visual layering of controls on a form along the form's Z-axis (depth).

A control can be docked to one edge of its parent container or can be docked to all edges and fill the parent container.

Setting the xtd::forms::control::margin property on a docked control has no effect on the distance of the control from the edges of its container.

Note

The xtd::forms::control::anchor and xtd::forms::control::dock properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence.

Notes to Inheritors

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

Reimplemented from xtd::forms::control.

dock() [2/2]

control & xtd::forms::tool_bar::dock ( dock_style value )

overridevirtual

Sets which control borders are docked to its parent control and determines how a control is resized with its parent.

Parameters

value

One of the xtd::forms::dock_style values. The default is xtd::forms::dock_style::none.

Returns

Current control.

Remarks

Use the xtd::forms::control::dock property to define how a control is automatically resized as its parent control is resized. For example, setting xtd::forms::control::dock to xtd::forms::dock_style::left causes the control to align itself with the left edges of its parent control and to resize as the parent control is resized. Controls are docked in their Z-order, which is the visual layering of controls on a form along the form's Z-axis (depth).

A control can be docked to one edge of its parent container or can be docked to all edges and fill the parent container.

Setting the xtd::forms::control::margin property on a docked control has no effect on the distance of the control from the edges of its container.

Note

The xtd::forms::control::anchor and xtd::forms::control::dock properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence.

Notes to Inheritors

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

Reimplemented from xtd::forms::control.

drop_down_arrows() [1/2]

virtual bool xtd::forms::tool_bar::drop_down_arrows ( ) const

virtualnoexcept

Gets a value indicating whether drop-down buttons on a toolbar display down arrows.

Returns

true if drop-down toolbar buttons display down arrows; otherwise, false. The default is true.

Remarks

When xtd::forms::tool_bar::drop_down_arrows is set to false, no down arrows display on drop-down style toolbar buttons. When the user clicks the drop-down button on the toolbar, the menu drops down for selection. When the drop-down arrow is displayed, the user must press the down arrow to display the menu.

drop_down_arrows() [2/2]

virtual tool_bar & xtd::forms::tool_bar::drop_down_arrows ( bool value )

virtual

Sets a value indicating whether drop-down buttons on a toolbar display down arrows.

Parameters

value

true if drop-down toolbar buttons display down arrows; otherwise, false. The default is true.

Returns

Current tool_bar instance.

Remarks

When xtd::forms::tool_bar::drop_down_arrows is set to false, no down arrows display on drop-down style toolbar buttons. When the user clicks the drop-down button on the toolbar, the menu drops down for selection. When the drop-down arrow is displayed, the user must press the down arrow to display the menu.

image_list() [1/3]

const xtd::forms::image_list & xtd::forms::tool_bar::image_list ( ) const

noexcept

Gets the collection of images available to the toolbar button controls.

Returns

An xtd::forms::image_list that contains images available to the xtd::forms::tool_bar_button controls. The default is empty.

Remarks

If you create an xtd::drawing::image_list and assign it to the xtd::forms::toll_bar::image_list property, you can assign an image from the collection to the xtd:forms::tool_bar_button controls by assigning the image's index value to the xtd:forms::tool_bar_button::image_index property of the toolbar button.

image_list() [2/3]

xtd::forms::image_list & xtd::forms::tool_bar::image_list

(

)

Gets the collection of images available to the toolbar button controls.

Returns

An xtd::forms::image_list that contains images available to the xtd::forms::tool_bar_button controls. The default is empty.

Remarks

If you create an xtd::drawing::image_list and assign it to the xtd::forms::toll_bar::image_list property, you can assign an image from the collection to the xtd:forms::tool_bar_button controls by assigning the image's index value to the xtd:forms::tool_bar_button::image_index property of the toolbar button.

image_list() [3/3]

tool_bar & xtd::forms::tool_bar::image_list

(

const xtd::forms::image_list &

value

)

Sets the collection of images available to the toolbar button controls.

Parameters

value

An xtd::forms::image_list that contains images available to the xtd::forms::tool_bar_button controls. The default is empty.

Returns

Current tool_bar instance.

Remarks

If you create an xtd::drawing::image_list and assign it to the xtd::forms::toll_bar::image_list property, you can assign an image from the collection to the xtd:forms::tool_bar_button controls by assigning the image's index value to the xtd:forms::tool_bar_button::image_index property of the toolbar button.

image_size()

virtual xtd::drawing::size xtd::forms::tool_bar::image_size ( ) const

virtualnoexcept

Gets the size of the images in the image list assigned to the toolbar.

Returns

A xtd::drawing::size that represents the size of the images (in the xtd::forms::image_list) assigned to the xtd::forms::tool_bar.

show_icon() [1/2]

virtual bool xtd::forms::tool_bar::show_icon ( ) const

virtualnoexcept

Gets a value indicating whether the toolbar displays the image for each button.

Returns

true if the toolbar display the image for each button; otherwise, false. The default is true.

show_icon() [2/2]

virtual tool_bar & xtd::forms::tool_bar::show_icon ( bool value )

virtual

Sets a value indicating whether the toolbar displays the image for each button.

Parameters

value

true if the toolbar display the image for each button; otherwise, false. The default is true.

Returns

Current tool_bar instance.

show_text() [1/2]

virtual bool xtd::forms::tool_bar::show_text ( ) const

virtualnoexcept

Gets a value indicating whether the toolbar displays the text for each button.

Returns

true if the toolbar display the text for each button; otherwise, false. The default is false.

show_text() [2/2]

virtual tool_bar & xtd::forms::tool_bar::show_text ( bool value )

virtual

Sets a value indicating whether the toolbar displays the text for each button.

Parameters

value

true if the toolbar display the text for each button; otherwise, false. The default is false.

Returns

Current tool_bar instance.

show_tool_tips() [1/2]

virtual bool xtd::forms::tool_bar::show_tool_tips ( ) const

virtualnoexcept

Gets a value indicating whether the toolbar displays a xtd::forms::tool_tip for each button.

Returns

true if the toolbar display a xtd::forms::tool_tip for each button; otherwise, false. The default is false.

Remarks

To set the text displayed by the xtd::forms::tool_tip, set the xtd::forms::tool_bar_button::tool_tip_text property of each xtd::forms::tool_bar_button on the xtd::forms::tool_bar. To cause the xtd::forms::tool_tip to display as the user moves the mouse pointer over the toolbar button, set the xtd::forms::tool_bar::show_tool_tips property to true.

show_tool_tips() [2/2]

virtual tool_bar & xtd::forms::tool_bar::show_tool_tips ( bool value )

virtual

Sets a value indicating whether the toolbar displays a xtd::forms::tool_tip for each button.

Parameters

value

true if the toolbar display a xtd::forms::tool_tip for each button; otherwise, false. The default is false.

Returns

Current tool_bar instance.

Remarks

To set the text displayed by the xtd::forms::tool_tip, set the xtd::forms::tool_bar_button::tool_tip_text property of each xtd::forms::tool_bar_button on the xtd::forms::tool_bar. To cause the xtd::forms::tool_tip to display as the user moves the mouse pointer over the toolbar button, set the xtd::forms::tool_bar::show_tool_tips property to true.

text_align() [1/2]

virtual xtd::forms::tool_bar_text_align xtd::forms::tool_bar::text_align ( ) const

virtualnoexcept

Gets the alignment of text in relation to each image displayed on the toolbar button controls.

Returns

One of the xtd::forms::tool_bar_text_align values. The default is xtd::forms::tool_bar_text_align::underneath.

Remarks

The xtd::forms::tool_bar::text can be aligned underneath or to the right of the image displayed on the xtd::forms::tool_bar_button controls.

text_align() [2/2]

virtual tool_bar & xtd::forms::tool_bar::text_align ( xtd::forms::tool_bar_text_align value )

virtual

Sets the alignment of text in relation to each image displayed on the toolbar button controls.

Parameters

value

One of the xtd::forms::tool_bar_text_align values. The default is xtd::forms::tool_bar_text_align::underneath.

Returns

Current tool_bar instance.

Remarks

The xtd::forms::tool_bar::text can be aligned underneath or to the right of the image displayed on the xtd::forms::tool_bar_button controls.

wrappable() [1/2]

virtual bool xtd::forms::tool_bar::wrappable ( ) const

virtualnoexcept

Gets a value indicating whether the toolbar buttons wrap to the next line if the toolbar becomes too small to display all the buttons on the same line.

Returns

true if the toolbar buttons wrap to another line if the toolbar becomes too small to display all the buttons on the same line; otherwise, false. The default value is true.

Note

Not yet implemented.

wrappable() [2/2]

virtual tool_bar & xtd::forms::tool_bar::wrappable ( bool value )

virtual

Gets a value indicating whether the toolbar buttons wrap to the next line if the toolbar becomes too small to display all the buttons on the same line.

Parameters

value

true if the toolbar buttons wrap to another line if the toolbar becomes too small to display all the buttons on the same line; otherwise, false. The default value is true.

Returns

Current tool_bar instance.

Remarks

Toolbar buttons can be divided into logical groups by using separators. A separator is a toolbar button with the xtd::forms::tool_bar::style property set to xtd::forms::tool_bar_button_style::separator. If the xtd::forms::tool_bar::wrappable property is set to true and the toolbar becomes too small to display all the buttons on the same line, the toolbar is broken into additional lines, with the breaks occurring at the separators. This ensures that button groups stay together. Toolbar buttons that are not in a group can be separated when the toolbar wraps. The toolbar can become too small to display all its buttons on the same line if its parent xtd::forms:form is resized.

Note

Not yet implemented.

create() [1/24]

tool_bar xtd::forms::tool_bar::create ( )

static

A factory to create an xtd::forms::tool_bar.

Parameters

parent

The parent that contains the new created xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [2/24]

tool_bar xtd::forms::tool_bar::create ( const xtd::forms::image_list::image_collection & image_collection )

static

A factory to create an xtd::forms::tool_bar with specified image collection.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.

Returns

New xtd::forms::tool_bar created.

create() [3/24]

tool_bar xtd::forms::tool_bar::create ( const xtd::forms::image_list::image_collection & image_collection, const xtd::string & name )

static

A factory to create an xtd::forms::tool_bar with specified image collection, and name.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.
name	The name of the xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [4/24]

tool_bar xtd::forms::tool_bar::create ( xtd::forms::dock_style style )

static

A factory to create an xtd::forms::tool_bar with specified style.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.

Returns

New xtd::forms::tool_bar created.

create() [5/24]

tool_bar xtd::forms::tool_bar::create ( xtd::forms::dock_style style, const xtd::forms::image_list::image_collection & image_collection )

static

A factory to create an xtd::forms::tool_bar with specified style, and image collection.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.

Returns

New xtd::forms::tool_bar created.

create() [6/24]

tool_bar xtd::forms::tool_bar::create ( xtd::forms::dock_style style, const xtd::forms::image_list::image_collection & image_collection, const xtd::string & name )

static

A factory to create an xtd::forms::tool_bar with specified style, image collection, and name.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.
name	The name of the xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [7/24]

tool_bar xtd::forms::tool_bar::create ( const tool_bar_button_collection & buttons )

static

A factory to create an xtd::forms::tool_bar.

Parameters

parent

The parent that contains the new created xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [8/24]

tool_bar xtd::forms::tool_bar::create ( const xtd::forms::image_list::image_collection & image_collection, const tool_bar_button_collection & buttons )

static

A factory to create an xtd::forms::tool_bar with specified image collection.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.

Returns

New xtd::forms::tool_bar created.

create() [9/24]

tool_bar xtd::forms::tool_bar::create ( const xtd::forms::image_list::image_collection & image_collection, const tool_bar_button_collection & buttons, const xtd::string & name )

static

A factory to create an xtd::forms::tool_bar with specified image collection, and name.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.
name	The name of the xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [10/24]

tool_bar xtd::forms::tool_bar::create ( xtd::forms::dock_style style, const tool_bar_button_collection & buttons )

static

A factory to create an xtd::forms::tool_bar with specified style.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.

Returns

New xtd::forms::tool_bar created.

create() [11/24]

tool_bar xtd::forms::tool_bar::create ( xtd::forms::dock_style style, const xtd::forms::image_list::image_collection & image_collection, const tool_bar_button_collection & buttons )

static

A factory to create an xtd::forms::tool_bar with specified style, and image collection.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.

Returns

New xtd::forms::tool_bar created.

create() [12/24]

tool_bar xtd::forms::tool_bar::create ( xtd::forms::dock_style style, const xtd::forms::image_list::image_collection & image_collection, const tool_bar_button_collection & buttons, const xtd::string & name )

static

A factory to create an xtd::forms::tool_bar with specified style, image collection, and name.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.
name	The name of the xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [13/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent )

static

A factory to create an xtd::forms::tool_bar with specified parent.

Parameters

parent

The parent that contains the new created xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [14/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, const xtd::forms::image_list::image_collection & image_collection )

static

A factory to create an xtd::forms::tool_bar with specified parent, and image collection.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.

Returns

New xtd::forms::tool_bar created.

create() [15/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, const xtd::forms::image_list::image_collection & image_collection, const xtd::string & name )

static

A factory to create an xtd::forms::tool_bar with specified parent, image collection, and name.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.
name	The name of the xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [16/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, xtd::forms::dock_style style )

static

A factory to create an xtd::forms::tool_bar with specified parent, and style.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.

Returns

New xtd::forms::tool_bar created.

create() [17/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection & image_collection )

static

A factory to create an xtd::forms::tool_bar with specified parent, style, and image collection.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.

Returns

New xtd::forms::tool_bar created.

create() [18/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection & image_collection, const xtd::string & name )

static

A factory to create an xtd::forms::tool_bar with specified parent, style, image collection, and name.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.
name	The name of the xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [19/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, const tool_bar_button_collection & buttons )

static

A factory to create an xtd::forms::tool_bar with specified parent.

Parameters

parent

The parent that contains the new created xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [20/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, const xtd::forms::image_list::image_collection & image_collection, const tool_bar_button_collection & buttons )

static

A factory to create an xtd::forms::tool_bar with specified parent, and image collection.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.

Returns

New xtd::forms::tool_bar created.

create() [21/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, const xtd::forms::image_list::image_collection & image_collection, const tool_bar_button_collection & buttons, const xtd::string & name )

static

A factory to create an xtd::forms::tool_bar with specified parent, image collection, and name.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.
name	The name of the xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create() [22/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, xtd::forms::dock_style style, const tool_bar_button_collection & buttons )

static

A factory to create an xtd::forms::tool_bar with specified parent, and style.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.

Returns

New xtd::forms::tool_bar created.

create() [23/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection & image_collection, const tool_bar_button_collection & buttons )

static

A factory to create an xtd::forms::tool_bar with specified parent, style, and image collection.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.

Returns

New xtd::forms::tool_bar created.

create() [24/24]

tool_bar xtd::forms::tool_bar::create ( const control & parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection & image_collection, const tool_bar_button_collection & buttons, const xtd::string & name )

static

A factory to create an xtd::forms::tool_bar with specified parent, style, image collection, and name.

Parameters

parent	The parent that contains the new created xtd::forms::tool_bar.
style	One of the xtd::forms::dock_style values.
image_collection	An xtd::forms::image_list::image_collection that contains images available to the xtd::forms::tool_bar_button controls.
name	The name of the xtd::forms::tool_bar.

Returns

New xtd::forms::tool_bar created.

create_params()

forms::create_params xtd::forms::tool_bar::create_params ( ) const

overrideprotectedvirtualnoexcept

Gets the required creation parameters when the control handle is created.

Returns

A create_params that contains the required creation parameters when the handle to the control is created.

Remarks

The create_params property should not be overridden and used to adjust the properties of your derived control. Properties such as the create_params::caption, create_params::width, and create_params::height should be set by the corresponding properties in your control such as control::text, control::width and control::height. The create_params should only be extended when you are wrapping a standard Windows control class or to set styles not provided by the forms namespace.

Notes for inheritors

When overriding the create_params property in a derived class, use the base class's create_params property to extend the base implementation. Otherwise, you must provide all the implementation.

Reimplemented from xtd::forms::control.

default_font()

xtd::drawing::font xtd::forms::tool_bar::default_font ( ) const

overrideprotectedvirtualnoexcept

Gets the default font of the control.

Returns

The default font of the control. The value returned will vary depending on the user's operating system the local culture setting of their system.

Reimplemented from xtd::forms::control.

default_size()

drawing::size xtd::forms::tool_bar::default_size ( ) const

overrideprotectedvirtualnoexcept

Gets the default size of the control.

Returns

The default size of the control.

Reimplemented from xtd::forms::control.

on_button_click()

void xtd::forms::tool_bar::on_button_click ( const xtd::forms::tool_bar_button_click_event_args & e )

protected

Raises the xtd::forms::tool_bar::button_click event.

Parameters

e	A xtd::forms::tool_bar_button_click_event_args that contains the event data.

Remarks

For more information about handling events, see Handling and Raising Events.

The xtd::forms::tool_bar::on_button_click method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding xtd::forms::tool_bar::on_button_click in a derived class, be sure to call the base class's xtd::forms::tool_bar::on_button_click method so that registered delegates receive the event.

on_button_drop_down()

void xtd::forms::tool_bar::on_button_drop_down ( const xtd::forms::tool_bar_button_click_event_args & e )

protected

Raises the xtd::forms::tool_bar::button_drop_down event.

Parameters

e	A xtd::forms::tool_bar_button_click_event_args that contains the event data.

Remarks

For more information about handling events, see Handling and Raising Events.

The xtd::forms::tool_bar::on_button_click method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding xtd::forms::tool_bar::on_button_drop_down in a derived class, be sure to call the base class's xtd::forms::tool_bar::on_button_drop_down method so that registered delegates receive the event.

on_handle_created()

void xtd::forms::tool_bar::on_handle_created ( const event_args & e )

overrideprotectedvirtual

Raises the xtd::forms::control::handle_created event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_handle_destroyed()

void xtd::forms::tool_bar::on_handle_destroyed ( const event_args & e )

overrideprotectedvirtual

Raises the xtd::forms::control::handle_destroyed event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_paint()

void xtd::forms::tool_bar::on_paint ( xtd::forms::paint_event_args & e )

overrideprotectedvirtual

Raises the xtd::forms::control::paint event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_resize()

void xtd::forms::tool_bar::on_resize ( const event_args & e )

overrideprotectedvirtual

Raises the xtd::forms::control::region event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

wnd_proc()

void xtd::forms::tool_bar::wnd_proc ( message & m )

overrideprotectedvirtual

Processes Windows messages.

Parameters

m	The Windows Message to process.

Remarks

All messages are sent to the wnd_proc method after getting filtered through the pre_process_message method.

Notes to Inheritors

Inheriting controls should call the base class's wnd_proc(message&) method to process any messages that they do not handle.

Reimplemented from xtd::forms::control.

Member Data Documentation

button_click

xtd::event<tool_bar, xtd::forms::tool_bar_button_click_event_handler> xtd::forms::tool_bar::button_click

Occurs when a xtd::forms::tool_bar_button on the xtd::forms::tool_bar is clicked.

Remarks

For more information about handling events, see Handling and Raising Events.

button_drop_down

xtd::event<tool_bar, xtd::forms::tool_bar_button_click_event_handler> xtd::forms::tool_bar::button_drop_down

Occurs when a drop-down style xtd::forms::tool_bar_button or its down arrow is clicked.

Remarks

For more information about handling events, see Handling and Raising Events.

---

The documentation for this class was generated from the following file:

• xtd.forms/include/xtd/forms/tool_bar.hpp