xtd::forms::check_box Class Reference

Inheritance diagram for xtd::forms::check_box:

Definition

Represents a Windows check_box.

class forms_export_ check_box : public xtd::forms::button_base

Inheritance

xtd::object → xtd::forms::component → xtd::forms::control → xtd::forms::button_base → xtd::forms::check_box

Header

#include <xtd/forms/check_box>

Namespace

xtd::forms

Library

xtd.forms

Remarks

Use a check_box to give the user an option, such as true/false or yes/no. The check_box control can display an image or text or both.

check_box and radio_button controls have a similar function: they allow the user to choose from a list of options. check_box controls let the user pick a combination of options. In contrast, radio_button controls allow a user to choose from mutually exclusive options.

The appearance property determines whether the check_box appears as a typical check_box or as a button.

The three_state property determines whether the control supports two or three states. Use the checked property to get or set the value of a two-state check_box control and use the check_state property to get or set the value of a three-state check_box control.

Note

If the three_state property is set to true, the checked property will return true for either a checked or indeterminate state.

Remarks

The flat_style property determines the style and appearance of the control. If the flat_style property is set to flat_style::system, the user's operating system determines the appearance of the control.

Note

When the flat_style property is set to flat_style::system, the check_align property is ignored and the control is displayed using the content_alignment::middle_left or content_alignment::middle_right alignment. If the check_align property is set to one of the right alignments, the control is displayed using the content_alignment::middle_right alignment; otherwise, it is displayed using the content_alignment::middle_left alignment.

Remarks

The following describes an indeterminate state: You have a check_box that determines if the selected text in a rich_text_box is bold. When you select text you can click the check_box to bold the selection. Likewise, when you select some text, the check_box displays whether the selected text is bold. If your selected text contains text that is bold and normal, the check_box will have an indeterminate state.

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples

The following code example demonstrates the use of check_box control.

#include <xtd/xtd>
 
namespace check_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Check box example");
      controls().add_range({check_box1, check_box2, check_box3, check_box4, check_box5});
      
      check_box1.auto_check(false);
      check_box1.click += delegate_ {
        // Uncomments next line to check / uncheck check box 1 (auto_check is false...)
        //check_box1.checked(!check_box1.checked());
        check_box1.text(string::format("{}", check_box1.check_state()));
      };
      check_box1.location({30, 30});
      check_box1.text(string::format("{}", check_box1.check_state()));
      
      check_box2.check_state_changed += delegate_ {
        check_box2.text(string::format("{}", check_box2.check_state()));
      };
      check_box2.checked(true);
      check_box2.location({30, 60});
      
      check_box3.auto_size(true);
      check_box3.check_state_changed += delegate_ {
        check_box3.text(string::format("{}", check_box3.check_state()));
      };
      check_box3.check_state(forms::check_state::indeterminate);
      check_box3.three_state(true);
      check_box3.location({30, 90});
      
      check_box4.appearance(forms::appearance::button);
      check_box4.check_state_changed += delegate_ {
        check_box4.text(string::format("{}", check_box4.check_state()));
      };
      check_box4.checked(true);
      check_box4.location({30, 120});
      
      check_box5.appearance(forms::appearance::button);
      check_box5.auto_check(false);
      check_box5.click += delegate_ {
        // Uncomments next line to check / uncheck check box 5 (auto_check is false...)
        //check_box5.checked(!check_box5.checked());
        check_box5.text(string::format("{}", check_box5.check_state()));
      };
      check_box5.location({30, 150});
      check_box5.text(string::format("{}", check_box5.check_state()));
    }
    
  private:
    check_box check_box1;
    check_box check_box2;
    check_box check_box3;
    check_box check_box4;
    check_box check_box5;
  };
}
 
auto main() -> int {
  application::enable_visual_styles();
  application::run(check_box_example::form1 {});
}

Public Events
event< check_box, xtd::event_handler >	appearance_changed
	Occurs when the value of the appearance property changes.
event< check_box, xtd::event_handler >	checked_changed
	Occurs when the value of the checked property changes.
event< check_box, xtd::event_handler >	check_state_changed
	Occurs when the value of the check_state property changes.

Public Constructors
	check_box ()
	Initializes a new instance of the CheckBox class.

Public Properties
virtual auto	appearance () const noexcept -> xtd::forms::appearance
	Gets the value that determines the appearance of a check_box control.
virtual auto	appearance (xtd::forms::appearance value) -> check_box &
	Gets the value that determines the appearance of a check_box control.
virtual auto	auto_check () const noexcept -> bool
	Gets a value indicating whether the checked or check_state values and the check_box's appearance are automatically changed when the check_box is clicked.
virtual auto	auto_check (bool value) -> check_box &
	Sets a value indicating whether the checked or check_state values and the check_box's appearance are automatically changed when the check_box is clicked.
virtual auto	check_align () const noexcept -> xtd::forms::content_alignment
	Gets the horizontal and vertical alignment of the check mark on a check_box control.
virtual auto	check_align (xtd::forms::content_alignment value) -> check_box &
	Sets the horizontal and vertical alignment of the check mark on a check_box control.
virtual auto	checked () const noexcept -> bool
	Gets a value indicating whether the check_box is in the checked state.
virtual auto	checked (bool value) -> check_box &
	Sets a value indicating whether the check_box is in the checked state.
virtual auto	check_state () const noexcept -> xtd::forms::check_state
	Gets the state of the check_box.
virtual auto	check_state (xtd::forms::check_state value) -> check_box &
	Sets the state of the check_box.
virtual auto	three_state () const noexcept -> bool
	Gets a value indicating whether the check_box will allow three check states rather than two.
virtual auto	three_state (bool value) -> check_box &
	Gets a value indicating whether the check_box will allow three check states rather than two.

Public Static Methods
static auto	create () -> check_box
	A factory to create an xtd::forms::check_box.
static auto	create (const xtd::drawing::point &location) -> check_box
	A factory to create an xtd::forms::check_box with specified location.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size) -> check_box
	A factory to create an xtd::forms::check_box with specified location, and size.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> check_box
	A factory to create an xtd::forms::check_box with specified location, size, and name.
static auto	create (const xtd::string &text) -> check_box
	A factory to create an xtd::forms::check_box with specified text.
static auto	create (const xtd::string &text, const xtd::drawing::point &location) -> check_box
	A factory to create an xtd::forms::check_box with specified text, and location.
static auto	create (const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size) -> check_box
	A factory to create an xtd::forms::check_box with specified text, location, and size.
static auto	create (const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> check_box
	A factory to create an xtd::forms::check_box with specified text, location, size, and name.
static auto	create (const xtd::string &text, xtd::forms::check_state check_statecheck_state) -> check_box
	A factory to create an xtd::forms::check_box with specified text, and check_state.
static auto	create (const xtd::string &text, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location) -> check_box
	A factory to create an xtd::forms::check_box with specified text, check_state, and location.
static auto	create (const xtd::string &text, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location, const xtd::drawing::size &size) -> check_box
	A factory to create an xtd::forms::check_box with specified text, check_state, location, and size.
static auto	create (const xtd::string &text, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> check_box
	A factory to create an xtd::forms::check_box with specified text, check_state, location, size, and name.
static auto	create (const xtd::string &text, bool three_state) -> check_box
	A factory to create an xtd::forms::check_box with specified text, and three_state.
static auto	create (const xtd::string &text, bool three_state, xtd::forms::check_state check_statecheck_state) -> check_box
	A factory to create an xtd::forms::check_box with specified text, three_state, and check_state.
static auto	create (const xtd::string &text, bool three_state, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location) -> check_box
	A factory to create an xtd::forms::check_box with specified text, three_state, check_state, and location.
static auto	create (const xtd::string &text, bool three_state, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location, const xtd::drawing::size &size) -> check_box
	A factory to create an xtd::forms::check_box with specified text, three_state, check_state, location, and size.
static auto	create (const xtd::string &text, bool three_state, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> check_box
	A factory to create an xtd::forms::check_box with specified text, three_state, check_state, location, size, and name.
static auto	create (const xtd::forms::control &parent) -> check_box
	A factory to create a xtd::forms::check_box with specified parent.
static auto	create (const xtd::forms::control &parent, const xtd::drawing::point &location) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, and location.
static auto	create (const xtd::forms::control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, location, and size.
static auto	create (const xtd::forms::control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, location, size, and name.
static auto	create (const xtd::forms::control &parent, const xtd::string &text) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, and text.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, const xtd::drawing::point &location) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, and location.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, location, and size.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, location, size, and name.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, xtd::forms::check_state check_statecheck_state) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, and check_state.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, check_state, and location.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location, const xtd::drawing::size &size) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, check_state, location, and size.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, check_state, location, size, and name.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, bool three_state) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, and three_state.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, bool three_state, xtd::forms::check_state check_statecheck_state) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, three_state, and check_state.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, bool three_state, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, three_state, check_state, and location.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, bool three_state, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location, const xtd::drawing::size &size) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, three_state, check_state, location, and size.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, bool three_state, xtd::forms::check_state check_statecheck_state, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> check_box
	A factory to create a xtd::forms::check_box with specified parent, text, three_state, check_state, location, size, and name.

Protected Properties
auto	create_params () const noexcept -> xtd::forms::create_params override
	Gets the required creation parameters when the control handle is created.
auto	state () const noexcept -> xtd::forms::visual_styles::check_box_state
	Gets state.

Protected Methods
auto	measure_control () const noexcept -> xtd::drawing::size override
	Measure this control.
virtual auto	on_appearance_changed (const xtd::event_args &e) -> void
	Raises the check_box::appearance_changed event.
virtual auto	on_checked_changed (const xtd::event_args &e) -> void
	Raises the check_box::checked_changed event.
virtual auto	on_check_state_changed (const xtd::event_args &e) -> void
	Raises the check_box::check_state_changed event.
auto	on_enabled_changed (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::enabled_changed event.
auto	on_handle_created (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::handle_created event.
auto	on_mouse_down (const xtd::forms::mouse_event_args &e) -> void override
	Raises the xtd::forms::control::mouse_down event.
auto	on_mouse_enter (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::mouse_enter event.
auto	on_mouse_leave (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::mouse_leave event.
auto	on_mouse_up (const xtd::forms::mouse_event_args &e) -> void override
	Raises the xtd::forms::control::mouse_up event.
auto	on_paint (xtd::forms::paint_event_args &e) -> void override
	Raises the xtd::forms::control::paint event.
auto	wnd_proc (xtd::forms::message &message) -> void override
	Processes Windows messages.

Additional Inherited Members
using	context_menu_ref
	Represent an xtd::forms::context_menu reference.
event< button_base, event_handler >	image_changed
	Occurs when the value of the image property changes.
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.
virtual auto	auto_ellipsis () const noexcept -> bool
	Gets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control.
virtual auto	auto_ellipsis (bool auto_ellipsis) -> button_base &
	Sets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control.
bool	auto_size () const noexcept override
	Gets a value that indicates whether the control resizes based on its contents.
auto	auto_size (bool auto_size) -> control &override
	Sets a value that indicates whether the control resizes based on its contents.
auto	control_appearance (xtd::forms::control_appearance value) -> control &override
	Sets control appearance.
virtual auto	flat_appearance () const noexcept -> const xtd::forms::flat_button_appearance &
	Gets the appearance of the border and the colors used to indicate check state and mouse state.
virtual auto	flat_appearance (const xtd::forms::flat_button_appearance &value) -> button_base &
	Sets the appearance of the border and the colors used to indicate check state and mouse state.
virtual auto	flat_style () const noexcept -> xtd::forms::flat_style
	Gets the flat style appearance of the button control.
virtual auto	flat_style (xtd::forms::flat_style value) -> button_base &
	Sets the flat style appearance of the button control.
virtual auto	image () const noexcept -> const xtd::drawing::image &
	Gets the image that is displayed on a button control.
virtual auto	image (const xtd::drawing::image &value) -> button_base &
	Sets the image that is displayed on a button control.
virtual auto	image_align () const noexcept -> xtd::forms::content_alignment
	Gets the alignment of the image on the button control.
virtual auto	image_align (xtd::forms::content_alignment value) -> button_base &
	Sets the alignment of the image on the button control.
virtual auto	image_index () const noexcept -> xtd::int32
	Gets the image list index value of the image displayed on the button control.
virtual auto	image_index (xtd::int32 value) -> button_base &
	Sets the image list index value of the image displayed on the button control.
virtual auto	image_list () const noexcept -> const xtd::forms::image_list &
	Gets the image_list that contains the image displayed on a button control.
virtual auto	image_list () noexcept -> xtd::forms::image_list &
	Gets the image_list that contains the image displayed on a button control.
virtual auto	image_list (const xtd::forms::image_list &value) -> button_base &
	Sets the image_list that contains the image displayed on a button control.
virtual auto	text_align () const noexcept -> xtd::forms::content_alignment
	Gets the alignment of the text on the button control.
virtual auto	text_align (xtd::forms::content_alignment value) -> button_base &
	Gets the alignment of the text on the button control.
virtual auto	control_appearance () const noexcept -> xtd::forms::control_appearance
	Gets control appearance.
	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	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	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	dock () const noexcept -> xtd::forms::dock_style
	Gets which control borders are docked to its parent control and determines how a control is resized with its parent.
virtual auto	dock (xtd::forms::dock_style value) -> control &
	Sets which control borders are docked to its parent control and determines how a control is resized with its parent.
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.
	button_base () noexcept
	Initializes a new instance of the ButtonBase class.
auto	is_default () const noexcept -> bool
	Gets a value indicating whether the button control is the default button.
auto	is_default (bool value) -> button_base &
	Sets a value indicating whether the button control is the default button.
auto	on_back_color_changed (const event_args &e) -> void override
	Raises the xtd::forms::control::back_color_changed event.
auto	on_font_changed (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::font_changed event.
auto	on_fore_color_changed (const event_args &e) -> void override
	Raises the xtd::forms::control::fore_color_changed event.
virtual auto	on_image_changed (const xtd::event_args &e) -> void
	Raises the button_base::image_changed event.
auto	on_parent_back_color_changed (const event_args &e) -> void override
	Raises the xtd::forms::control::parent_back_color_changed event.
auto	on_parent_fore_color_changed (const event_args &e) -> void override
	Raises the xtd::forms::control::parent_fore_color_changed event.
auto	on_resize (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::region event.
auto	on_text_changed (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::text_changed event.
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_font () const noexcept -> xtd::drawing::font
	Gets the default font of the control.
virtual auto	default_fore_color () const noexcept -> xtd::drawing::color
	Gets the default foreground color of the control.
virtual auto	default_size () const noexcept -> xtd::drawing::size
	Gets the default size 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.
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_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_got_focus (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::got_focus event.
virtual auto	on_handle_destroyed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::handle_destroyed 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_horizontal_wheel (const xtd::forms::mouse_event_args &e) -> void
	Raises the xtd::forms::control::mouse_horizontal_wheel 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_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_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_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_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.

Constructor & Destructor Documentation

check_box()

xtd::forms::check_box::check_box

(

)

Initializes a new instance of the CheckBox class.

Remarks

By default, when a new check_box is instantiated, auto_check is set to true, checked is set to false, and appearance is set to normal.

Examples

The following code example demonstrates the use of check_box constructor.

#include <xtd/xtd>
 
namespace check_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Check box example");
      controls().add_range({check_box1, check_box2, check_box3, check_box4, check_box5});
      
      check_box1.auto_check(false);
      check_box1.click += delegate_ {
        // Uncomments next line to check / uncheck check box 1 (auto_check is false...)
        //check_box1.checked(!check_box1.checked());
        check_box1.text(string::format("{}", check_box1.check_state()));
      };
      check_box1.location({30, 30});
      check_box1.text(string::format("{}", check_box1.check_state()));
      
      check_box2.check_state_changed += delegate_ {
        check_box2.text(string::format("{}", check_box2.check_state()));
      };
      check_box2.checked(true);
      check_box2.location({30, 60});
      
      check_box3.auto_size(true);
      check_box3.check_state_changed += delegate_ {
        check_box3.text(string::format("{}", check_box3.check_state()));
      };
      check_box3.check_state(forms::check_state::indeterminate);
      check_box3.three_state(true);
      check_box3.location({30, 90});
      
      check_box4.appearance(forms::appearance::button);
      check_box4.check_state_changed += delegate_ {
        check_box4.text(string::format("{}", check_box4.check_state()));
      };
      check_box4.checked(true);
      check_box4.location({30, 120});
      
      check_box5.appearance(forms::appearance::button);
      check_box5.auto_check(false);
      check_box5.click += delegate_ {
        // Uncomments next line to check / uncheck check box 5 (auto_check is false...)
        //check_box5.checked(!check_box5.checked());
        check_box5.text(string::format("{}", check_box5.check_state()));
      };
      check_box5.location({30, 150});
      check_box5.text(string::format("{}", check_box5.check_state()));
    }
    
  private:
    check_box check_box1;
    check_box check_box2;
    check_box check_box3;
    check_box check_box4;
    check_box check_box5;
  };
}
 
auto main() -> int {
  application::enable_visual_styles();
  application::run(check_box_example::form1 {});
}

Member Function Documentation

appearance() [1/2]

virtual auto xtd::forms::check_box::appearance ( ) const -> xtd::forms::appearance

nodiscardvirtualnoexcept

Gets the value that determines the appearance of a check_box control.

Returns

One of the appearance values. The default value is normal.

Remarks

If appearance value is set to normal, the check_box has a typical appearance. If the value is set to button, the check_box appears like a toggle button, which can be toggled to an up or down state.

Examples

The following code example demonstrates the use of check_box appearance.

#include <xtd/xtd>
 
namespace check_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Check box example");
      controls().add_range({check_box1, check_box2, check_box3, check_box4, check_box5});
      
      check_box1.auto_check(false);
      check_box1.click += delegate_ {
        // Uncomments next line to check / uncheck check box 1 (auto_check is false...)
        //check_box1.checked(!check_box1.checked());
        check_box1.text(string::format("{}", check_box1.check_state()));
      };
      check_box1.location({30, 30});
      check_box1.text(string::format("{}", check_box1.check_state()));
      
      check_box2.check_state_changed += delegate_ {
        check_box2.text(string::format("{}", check_box2.check_state()));
      };
      check_box2.checked(true);
      check_box2.location({30, 60});
      
      check_box3.auto_size(true);
      check_box3.check_state_changed += delegate_ {
        check_box3.text(string::format("{}", check_box3.check_state()));
      };
      check_box3.check_state(forms::check_state::indeterminate);
      check_box3.three_state(true);
      check_box3.location({30, 90});
      
      check_box4.appearance(forms::appearance::button);
      check_box4.check_state_changed += delegate_ {
        check_box4.text(string::format("{}", check_box4.check_state()));
      };
      check_box4.checked(true);
      check_box4.location({30, 120});
      
      check_box5.appearance(forms::appearance::button);
      check_box5.auto_check(false);
      check_box5.click += delegate_ {
        // Uncomments next line to check / uncheck check box 5 (auto_check is false...)
        //check_box5.checked(!check_box5.checked());
        check_box5.text(string::format("{}", check_box5.check_state()));
      };
      check_box5.location({30, 150});
      check_box5.text(string::format("{}", check_box5.check_state()));
    }
    
  private:
    check_box check_box1;
    check_box check_box2;
    check_box check_box3;
    check_box check_box4;
    check_box check_box5;
  };
}
 
auto main() -> int {
  application::enable_visual_styles();
  application::run(check_box_example::form1 {});
}

appearance() [2/2]

virtual auto xtd::forms::check_box::appearance ( xtd::forms::appearance value ) -> check_box &

virtual

Gets the value that determines the appearance of a check_box control.

Parameters

value

One of the appearance values. The default value is normal.

Remarks

If appearance value is set to normal, the check_box has a typical appearance. If the value is set to button, the check_box appears like a toggle button, which can be toggled to an up or down state.

auto_check() [1/2]

virtual auto xtd::forms::check_box::auto_check ( ) const -> bool

nodiscardvirtualnoexcept

Gets a value indicating whether the checked or check_state values and the check_box's appearance are automatically changed when the check_box is clicked.

Returns

true if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true.

Remarks

If auto_check is set to false, you will need to add code to update the checked or check_state values in the click event handler.

Examples

The following code example demonstrates the use of check_box auto_check.

#include <xtd/xtd>
 
namespace check_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Check box example");
      controls().add_range({check_box1, check_box2, check_box3, check_box4, check_box5});
      
      check_box1.auto_check(false);
      check_box1.click += delegate_ {
        // Uncomments next line to check / uncheck check box 1 (auto_check is false...)
        //check_box1.checked(!check_box1.checked());
        check_box1.text(string::format("{}", check_box1.check_state()));
      };
      check_box1.location({30, 30});
      check_box1.text(string::format("{}", check_box1.check_state()));
      
      check_box2.check_state_changed += delegate_ {
        check_box2.text(string::format("{}", check_box2.check_state()));
      };
      check_box2.checked(true);
      check_box2.location({30, 60});
      
      check_box3.auto_size(true);
      check_box3.check_state_changed += delegate_ {
        check_box3.text(string::format("{}", check_box3.check_state()));
      };
      check_box3.check_state(forms::check_state::indeterminate);
      check_box3.three_state(true);
      check_box3.location({30, 90});
      
      check_box4.appearance(forms::appearance::button);
      check_box4.check_state_changed += delegate_ {
        check_box4.text(string::format("{}", check_box4.check_state()));
      };
      check_box4.checked(true);
      check_box4.location({30, 120});
      
      check_box5.appearance(forms::appearance::button);
      check_box5.auto_check(false);
      check_box5.click += delegate_ {
        // Uncomments next line to check / uncheck check box 5 (auto_check is false...)
        //check_box5.checked(!check_box5.checked());
        check_box5.text(string::format("{}", check_box5.check_state()));
      };
      check_box5.location({30, 150});
      check_box5.text(string::format("{}", check_box5.check_state()));
    }
    
  private:
    check_box check_box1;
    check_box check_box2;
    check_box check_box3;
    check_box check_box4;
    check_box check_box5;
  };
}
 
auto main() -> int {
  application::enable_visual_styles();
  application::run(check_box_example::form1 {});
}

auto_check() [2/2]

virtual auto xtd::forms::check_box::auto_check ( bool value ) -> check_box &

virtual

Sets a value indicating whether the checked or check_state values and the check_box's appearance are automatically changed when the check_box is clicked.

Parameters

value

true if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true.

Remarks

If auto_check is set to false, you will need to add code to update the checked or check_state values in the click event handler.

check_align() [1/2]

virtual auto xtd::forms::check_box::check_align ( ) const -> xtd::forms::content_alignment

nodiscardvirtualnoexcept

Gets the horizontal and vertical alignment of the check mark on a check_box control.

Returns

One of the content_alignment values. The default value is middle_left.

check_align() [2/2]

virtual auto xtd::forms::check_box::check_align ( xtd::forms::content_alignment value ) -> check_box &

virtual

Sets the horizontal and vertical alignment of the check mark on a check_box control.

Parameters

value

One of the content_alignment values. The default value is middle_left.

checked() [1/2]

virtual auto xtd::forms::check_box::checked ( ) const -> bool

nodiscardvirtualnoexcept

Gets a value indicating whether the check_box is in the checked state.

Returns

true if the check_box is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state.

Remarks

When the value is true, the check_box portion of the control displays a check mark. If the appearance property is set to button, the control will appear sunken when checked is true and raised like a standard button when false.

Examples

The following code example demonstrates the use of check_box checked.

#include <xtd/xtd>
 
namespace check_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Check box example");
      controls().add_range({check_box1, check_box2, check_box3, check_box4, check_box5});
      
      check_box1.auto_check(false);
      check_box1.click += delegate_ {
        // Uncomments next line to check / uncheck check box 1 (auto_check is false...)
        //check_box1.checked(!check_box1.checked());
        check_box1.text(string::format("{}", check_box1.check_state()));
      };
      check_box1.location({30, 30});
      check_box1.text(string::format("{}", check_box1.check_state()));
      
      check_box2.check_state_changed += delegate_ {
        check_box2.text(string::format("{}", check_box2.check_state()));
      };
      check_box2.checked(true);
      check_box2.location({30, 60});
      
      check_box3.auto_size(true);
      check_box3.check_state_changed += delegate_ {
        check_box3.text(string::format("{}", check_box3.check_state()));
      };
      check_box3.check_state(forms::check_state::indeterminate);
      check_box3.three_state(true);
      check_box3.location({30, 90});
      
      check_box4.appearance(forms::appearance::button);
      check_box4.check_state_changed += delegate_ {
        check_box4.text(string::format("{}", check_box4.check_state()));
      };
      check_box4.checked(true);
      check_box4.location({30, 120});
      
      check_box5.appearance(forms::appearance::button);
      check_box5.auto_check(false);
      check_box5.click += delegate_ {
        // Uncomments next line to check / uncheck check box 5 (auto_check is false...)
        //check_box5.checked(!check_box5.checked());
        check_box5.text(string::format("{}", check_box5.check_state()));
      };
      check_box5.location({30, 150});
      check_box5.text(string::format("{}", check_box5.check_state()));
    }
    
  private:
    check_box check_box1;
    check_box check_box2;
    check_box check_box3;
    check_box check_box4;
    check_box check_box5;
  };
}
 
auto main() -> int {
  application::enable_visual_styles();
  application::run(check_box_example::form1 {});
}

checked() [2/2]

virtual auto xtd::forms::check_box::checked ( bool value ) -> check_box &

virtual

Sets a value indicating whether the check_box is in the checked state.

Parameters

value

true if the check_box is in the checked state; otherwise, false. The default value is false.

Remarks

When the value is true, the check_box portion of the control displays a check mark. If the appearance property is set to button, the control will appear sunken when checked is true and raised like a standard button when false.

check_state() [1/2]

virtual auto xtd::forms::check_box::check_state ( ) const -> xtd::forms::check_state

nodiscardvirtualnoexcept

Gets the state of the check_box.

Returns

One of the xtd::forms::check_state enumeration values. The default value is unchecked.

Remarks

If the three_state property is set to false, the check_state property value can only be set to check_state::indeterminate in code and not by u ser interaction.

The following table describes the xtd::forms::appearance of the check_box control in its different states for the normal and button style control check_box::appearance.

Check_state	appearance::normal	appearance::button
checked	The check_box displays a check mark.	The control appears sunken.
unchecked	The CheckBox is empty.	The control appears raised.
indeterminate	The CheckBox displays a check mark and is shaded.	The control appears flat.

Examples

The following code example demonstrates the use of check_box check_state.

#include <xtd/xtd>
 
namespace check_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Check box example");
      controls().add_range({check_box1, check_box2, check_box3, check_box4, check_box5});
      
      check_box1.auto_check(false);
      check_box1.click += delegate_ {
        // Uncomments next line to check / uncheck check box 1 (auto_check is false...)
        //check_box1.checked(!check_box1.checked());
        check_box1.text(string::format("{}", check_box1.check_state()));
      };
      check_box1.location({30, 30});
      check_box1.text(string::format("{}", check_box1.check_state()));
      
      check_box2.check_state_changed += delegate_ {
        check_box2.text(string::format("{}", check_box2.check_state()));
      };
      check_box2.checked(true);
      check_box2.location({30, 60});
      
      check_box3.auto_size(true);
      check_box3.check_state_changed += delegate_ {
        check_box3.text(string::format("{}", check_box3.check_state()));
      };
      check_box3.check_state(forms::check_state::indeterminate);
      check_box3.three_state(true);
      check_box3.location({30, 90});
      
      check_box4.appearance(forms::appearance::button);
      check_box4.check_state_changed += delegate_ {
        check_box4.text(string::format("{}", check_box4.check_state()));
      };
      check_box4.checked(true);
      check_box4.location({30, 120});
      
      check_box5.appearance(forms::appearance::button);
      check_box5.auto_check(false);
      check_box5.click += delegate_ {
        // Uncomments next line to check / uncheck check box 5 (auto_check is false...)
        //check_box5.checked(!check_box5.checked());
        check_box5.text(string::format("{}", check_box5.check_state()));
      };
      check_box5.location({30, 150});
      check_box5.text(string::format("{}", check_box5.check_state()));
    }
    
  private:
    check_box check_box1;
    check_box check_box2;
    check_box check_box3;
    check_box check_box4;
    check_box check_box5;
  };
}
 
auto main() -> int {
  application::enable_visual_styles();
  application::run(check_box_example::form1 {});
}

check_state() [2/2]

virtual auto xtd::forms::check_box::check_state ( xtd::forms::check_state value ) -> check_box &

virtual

Sets the state of the check_box.

Parameters

value

One of the xtd::forms::check_state enumeration values. The default value is unchecked.

Remarks

The following table describes the xtd::forms::appearance of the check_box control in its different states for the normal and button style control check_box::appearance.

Check_state	appearance::normal	appearance::button
checked	The check_box displays a check mark.	The control appears sunken.
unchecked	The CheckBox is empty.	The control appears raised.
indeterminate	The CheckBox displays a check mark and is shaded.	The control appears flat.

Examples

The following code example demonstrates the use of check_box check_state.

#include <xtd/xtd>
 
namespace check_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Check box example");
      controls().add_range({check_box1, check_box2, check_box3, check_box4, check_box5});
      
      check_box1.auto_check(false);
      check_box1.click += delegate_ {
        // Uncomments next line to check / uncheck check box 1 (auto_check is false...)
        //check_box1.checked(!check_box1.checked());
        check_box1.text(string::format("{}", check_box1.check_state()));
      };
      check_box1.location({30, 30});
      check_box1.text(string::format("{}", check_box1.check_state()));
      
      check_box2.check_state_changed += delegate_ {
        check_box2.text(string::format("{}", check_box2.check_state()));
      };
      check_box2.checked(true);
      check_box2.location({30, 60});
      
      check_box3.auto_size(true);
      check_box3.check_state_changed += delegate_ {
        check_box3.text(string::format("{}", check_box3.check_state()));
      };
      check_box3.check_state(forms::check_state::indeterminate);
      check_box3.three_state(true);
      check_box3.location({30, 90});
      
      check_box4.appearance(forms::appearance::button);
      check_box4.check_state_changed += delegate_ {
        check_box4.text(string::format("{}", check_box4.check_state()));
      };
      check_box4.checked(true);
      check_box4.location({30, 120});
      
      check_box5.appearance(forms::appearance::button);
      check_box5.auto_check(false);
      check_box5.click += delegate_ {
        // Uncomments next line to check / uncheck check box 5 (auto_check is false...)
        //check_box5.checked(!check_box5.checked());
        check_box5.text(string::format("{}", check_box5.check_state()));
      };
      check_box5.location({30, 150});
      check_box5.text(string::format("{}", check_box5.check_state()));
    }
    
  private:
    check_box check_box1;
    check_box check_box2;
    check_box check_box3;
    check_box check_box4;
    check_box check_box5;
  };
}
 
auto main() -> int {
  application::enable_visual_styles();
  application::run(check_box_example::form1 {});
}

three_state() [1/2]

virtual auto xtd::forms::check_box::three_state ( ) const -> bool

nodiscardvirtualnoexcept

Gets a value indicating whether the check_box will allow three check states rather than two.

Returns

true if the check_box is able to display three check states; otherwise, false. The default value is false.

Remarks

If the three_state property is set to false, the check_state property value can only be set to the indeterminate value of xtd.forms.check_state in code and not by user interaction.

Examples

The following code example demonstrates the use of check_box three_state.

#include <xtd/xtd>
 
namespace check_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Check box example");
      controls().add_range({check_box1, check_box2, check_box3, check_box4, check_box5});
      
      check_box1.auto_check(false);
      check_box1.click += delegate_ {
        // Uncomments next line to check / uncheck check box 1 (auto_check is false...)
        //check_box1.checked(!check_box1.checked());
        check_box1.text(string::format("{}", check_box1.check_state()));
      };
      check_box1.location({30, 30});
      check_box1.text(string::format("{}", check_box1.check_state()));
      
      check_box2.check_state_changed += delegate_ {
        check_box2.text(string::format("{}", check_box2.check_state()));
      };
      check_box2.checked(true);
      check_box2.location({30, 60});
      
      check_box3.auto_size(true);
      check_box3.check_state_changed += delegate_ {
        check_box3.text(string::format("{}", check_box3.check_state()));
      };
      check_box3.check_state(forms::check_state::indeterminate);
      check_box3.three_state(true);
      check_box3.location({30, 90});
      
      check_box4.appearance(forms::appearance::button);
      check_box4.check_state_changed += delegate_ {
        check_box4.text(string::format("{}", check_box4.check_state()));
      };
      check_box4.checked(true);
      check_box4.location({30, 120});
      
      check_box5.appearance(forms::appearance::button);
      check_box5.auto_check(false);
      check_box5.click += delegate_ {
        // Uncomments next line to check / uncheck check box 5 (auto_check is false...)
        //check_box5.checked(!check_box5.checked());
        check_box5.text(string::format("{}", check_box5.check_state()));
      };
      check_box5.location({30, 150});
      check_box5.text(string::format("{}", check_box5.check_state()));
    }
    
  private:
    check_box check_box1;
    check_box check_box2;
    check_box check_box3;
    check_box check_box4;
    check_box check_box5;
  };
}
 
auto main() -> int {
  application::enable_visual_styles();
  application::run(check_box_example::form1 {});
}

three_state() [2/2]

virtual auto xtd::forms::check_box::three_state ( bool value ) -> check_box &

virtual

Gets a value indicating whether the check_box will allow three check states rather than two.

Parameters

value

true if the check_box is able to display three check states; otherwise, false. The default value is false.

Remarks

If the three_state property is set to false, the check_state property value can only be set to the indeterminate value of xtd.forms.check_state in code and not by user interaction.

create() [1/34]

auto xtd::forms::check_box::create ( ) -> check_box

staticnodiscard

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

Returns

New xtd::forms::check_box created.

create() [2/34]

auto xtd::forms::check_box::create ( const xtd::drawing::point & location ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified location.

Parameters

location

A xtd::drawing::point that represent location of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [3/34]

auto xtd::forms::check_box::create ( const xtd::drawing::point & location, const xtd::drawing::size & size ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified location, and size.

Parameters

location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [4/34]

auto xtd::forms::check_box::create ( const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified location, size, and name.

Parameters

location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.
name	The name of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [5/34]

auto xtd::forms::check_box::create ( const xtd::string & text ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text.

Parameters

text	A string that represent text of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [6/34]

auto xtd::forms::check_box::create ( const xtd::string & text, const xtd::drawing::point & location ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, and location.

Parameters

text	A string that represent text of the xtd::forms::check_box.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [7/34]

auto xtd::forms::check_box::create ( const xtd::string & text, const xtd::drawing::point & location, const xtd::drawing::size & size ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, location, and size.

Parameters

text	A string that represent text of the xtd::forms::check_box.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [8/34]

auto xtd::forms::check_box::create ( const xtd::string & text, const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, location, size, and name.

Parameters

text	A string that represent text of the xtd::forms::check_box.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.
name	The name of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [9/34]

auto xtd::forms::check_box::create ( const xtd::string & text, xtd::forms::check_state check_state ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, and check_state.

Parameters

text	A string that represent text of the xtd::forms::check_box.
check_state	One of the xtd::forms::check_state enumeration values.

Returns

New xtd::forms::check_box created.

create() [10/34]

auto xtd::forms::check_box::create ( const xtd::string & text, xtd::forms::check_state check_state, const xtd::drawing::point & location ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, check_state, and location.

Parameters

text	A string that represent text of the xtd::forms::check_box.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.
name	The name of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [11/34]

auto xtd::forms::check_box::create ( const xtd::string & text, xtd::forms::check_state check_state, const xtd::drawing::point & location, const xtd::drawing::size & size ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, check_state, location, and size.

Parameters

text	A string that represent text of the xtd::forms::check_box.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [12/34]

auto xtd::forms::check_box::create ( const xtd::string & text, xtd::forms::check_state check_state, const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, check_state, location, size, and name.

Parameters

text	A string that represent text of the xtd::forms::check_box.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.
name	The name of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [13/34]

auto xtd::forms::check_box::create ( const xtd::string & text, bool three_state ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, and three_state.

Parameters

text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.

Returns

New xtd::forms::check_box created.

create() [14/34]

auto xtd::forms::check_box::create ( const xtd::string & text, bool three_state, xtd::forms::check_state check_state ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, three_state, and check_state.

Parameters

text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.
check_state	One of the xtd::forms::check_state enumeration values.

Returns

New xtd::forms::check_box created.

create() [15/34]

auto xtd::forms::check_box::create ( const xtd::string & text, bool three_state, xtd::forms::check_state check_state, const xtd::drawing::point & location ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, three_state, check_state, and location.

Parameters

text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [16/34]

auto xtd::forms::check_box::create ( const xtd::string & text, bool three_state, xtd::forms::check_state check_state, const xtd::drawing::point & location, const xtd::drawing::size & size ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, three_state, check_state, location, and size.

Parameters

text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [17/34]

auto xtd::forms::check_box::create ( const xtd::string & text, bool three_state, xtd::forms::check_state check_state, const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> check_box

staticnodiscard

A factory to create an xtd::forms::check_box with specified text, three_state, check_state, location, size, and name.

Parameters

text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.
name	The name of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [18/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent.

Parameters

parent

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

Returns

New xtd::forms::check_box created.

create() [19/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::drawing::point & location ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, and location.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [20/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::drawing::point & location, const xtd::drawing::size & size ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, location, and size.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [21/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, location, size, and name.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.
name	The name of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [22/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, and text.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [23/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, const xtd::drawing::point & location ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, and location.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [24/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, const xtd::drawing::point & location, const xtd::drawing::size & size ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, location, and size.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [25/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, location, size, and name.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.
name	The name of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [26/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, xtd::forms::check_state check_state ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, and check_state.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
check_state	One of the xtd::forms::check_state enumeration values.

Returns

New xtd::forms::check_box created.

create() [27/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, xtd::forms::check_state check_state, const xtd::drawing::point & location ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, check_state, and location.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [28/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, xtd::forms::check_state check_state, const xtd::drawing::point & location, const xtd::drawing::size & size ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, check_state, location, and size.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [29/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, xtd::forms::check_state check_state, const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, check_state, location, size, and name.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.
name	The name of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [30/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, bool three_state ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, and three_state.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.

Returns

New xtd::forms::check_box created.

create() [31/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, bool three_state, xtd::forms::check_state check_state ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, three_state, and check_state.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.
check_state	One of the xtd::forms::check_state enumeration values.

Returns

New xtd::forms::check_box created.

create() [32/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, bool three_state, xtd::forms::check_state check_state, const xtd::drawing::point & location ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, three_state, check_state, and location.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [33/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, bool three_state, xtd::forms::check_state check_state, const xtd::drawing::point & location, const xtd::drawing::size & size ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, three_state, check_state, location, and size.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create() [34/34]

auto xtd::forms::check_box::create ( const xtd::forms::control & parent, const xtd::string & text, bool three_state, xtd::forms::check_state check_state, const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> check_box

staticnodiscard

A factory to create a xtd::forms::check_box with specified parent, text, three_state, check_state, location, size, and name.

Parameters

parent	The parent that contains the new created xtd::forms::check_box.
text	A string that represent text of the xtd::forms::check_box.
three_state	true if the check_box is able to display three check states; otherwise, false.
check_state	One of the xtd::forms::check_state enumeration values.
location	A xtd::drawing::point that represent location of the xtd::forms::check_box.
size	A xtd::drawing::size that represent size of the xtd::forms::check_box.
name	The name of the xtd::forms::check_box.

Returns

New xtd::forms::check_box created.

create_params()

auto xtd::forms::check_box::create_params ( ) const -> xtd::forms::create_params

nodiscardoverrideprotectedvirtualnoexcept

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.

Reimplemented from xtd::forms::button_base.

state()

auto xtd::forms::check_box::state ( ) const -> xtd::forms::visual_styles::check_box_state

nodiscardprotectednoexcept

Gets state.

Returns

One of xtd::forms::visual_styles::check_box_state values.

measure_control()

auto xtd::forms::check_box::measure_control ( ) const -> xtd::drawing::size

nodiscardoverrideprotectedvirtualnoexcept

Measure this control.

Returns

The xtd::drawing::size size of this control.

Remarks

This method is not relevant for this class.

Reimplemented from xtd::forms::button_base.

on_appearance_changed()

virtual auto xtd::forms::check_box::on_appearance_changed ( const xtd::event_args & e ) -> void

protectedvirtual

Raises the check_box::appearance_changed event.

Parameters

e	An event_args that contains the event data.

Remarks

Raising an event invokes the event handler through a delegate.

The on_appearance_changed 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.

on_checked_changed()

virtual auto xtd::forms::check_box::on_checked_changed ( const xtd::event_args & e ) -> void

protectedvirtual

Raises the check_box::checked_changed event.

Parameters

e	An event_args that contains the event data.

Remarks

Raising an event invokes the event handler through a delegate.

The on_checked_changed 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.

on_check_state_changed()

virtual auto xtd::forms::check_box::on_check_state_changed ( const xtd::event_args & e ) -> void

protectedvirtual

Raises the check_box::check_state_changed event.

Parameters

e	An event_args that contains the event data.

Remarks

Raising an event invokes the event handler through a delegate.

The on_check_state_changed 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.

on_enabled_changed()

auto xtd::forms::check_box::on_enabled_changed ( const xtd::event_args & e ) -> void

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::button_base.

on_handle_created()

auto xtd::forms::check_box::on_handle_created ( const xtd::event_args & e ) -> void

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_mouse_down()

auto xtd::forms::check_box::on_mouse_down ( const xtd::forms::mouse_event_args & e ) -> void

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::button_base.

on_mouse_enter()

auto xtd::forms::check_box::on_mouse_enter ( const xtd::event_args & e ) -> void

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::button_base.

on_mouse_leave()

auto xtd::forms::check_box::on_mouse_leave ( const xtd::event_args & e ) -> void

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::button_base.

on_mouse_up()

auto xtd::forms::check_box::on_mouse_up ( const xtd::forms::mouse_event_args & e ) -> void

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::button_base.

on_paint()

auto xtd::forms::check_box::on_paint ( xtd::forms::paint_event_args & e ) -> void

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

wnd_proc()

auto xtd::forms::check_box::wnd_proc ( xtd::forms::message & m ) -> void

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

appearance_changed

event<check_box, xtd::event_handler> xtd::forms::check_box::appearance_changed

Occurs when the value of the appearance property changes.

Remarks

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

checked_changed

event<check_box, xtd::event_handler> xtd::forms::check_box::checked_changed

Occurs when the value of the checked property changes.

Remarks

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

check_state_changed

event<check_box, xtd::event_handler> xtd::forms::check_box::check_state_changed

Occurs when the value of the check_state property changes.

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/check_box.hpp