xtd 0.2.0
Loading...
Searching...
No Matches
xtd::forms::toggle_button Class Reference
Inheritance diagram for xtd::forms::toggle_button:
xtd::forms::button_base xtd::forms::control xtd::forms::component xtd::forms::iwin32_window xtd::iclonable xtd::icomparable< control > xtd::iequatable< control > xtd::isynchronize_invoke xtd::object xtd::interface xtd::interface xtd::interface xtd::interface xtd::interface

Definition

Represents a Windows toggle_button.

Implements the basic functionality common to button controls.
Definition button_base.h:35
Represents a Windows toggle_button.
Definition toggle_button.h:42
#define forms_export_
Define shared library export.
Definition forms_export.h:13
Inheritance
xtd::objectxtd::forms::componentxtd::forms::controlxtd::forms::button_basextd::forms::toggle_button
Header
#include <xtd/forms/toggle_button>
Namespace
xtd::forms
Library
xtd.forms
Remarks
Use a toggle_button to give the user an option, such as true/false or yes/no. The toggle_button control can display an image or text or both.
toggle_button and radio_button controls have a similar function: they allow the user to choose from a list of options. toggle_button 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 toggle_button appears as a typical toggle_button 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 toggle_button control and use the check_state property to get or set the value of a three-state toggle_button 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 toggle_button that determines if the selected text in a rich_text_box is bold. When you select text you can click the toggle_button to bold the selection. Likewise, when you select some text, the toggle_button displays whether the selected text is bold. If your selected text contains text that is bold and normal, the toggle_button will have an indeterminate state.
Appearance
Windows macOS Gnome
Light  
 
 
 
 
 
Dark  
 
 
 
 
 
Examples
The following code example demonstrates the use of toggle_button control.
#include <xtd/forms/application>
#include <xtd/forms/form>
#include <xtd/forms/toggle_button>
using namespace xtd;
using namespace xtd::forms;
namespace toggle_button_example {
class form1 : public form {
public:
form1() {
text("Toggle button example");
controls().push_back_range({toggle_button1, toggle_button2, toggle_button3});
toggle_button1.auto_check(false);
toggle_button1.click += [&] {
//toggle_button1.checked(!toggle_button1.checked());
toggle_button1.text(ustring::format("{}", toggle_button1.check_state()));
};
toggle_button1.location({30, 30});
toggle_button1.text(ustring::format("{}", toggle_button1.check_state()));
toggle_button1.width(120);
toggle_button2.check_state_changed += [&] {
toggle_button2.text(ustring::format("{}", toggle_button2.check_state()));
};
toggle_button2.checked(true);
toggle_button2.location({30, 80});
toggle_button2.width(120);
toggle_button3.check_state_changed += [&] {
toggle_button3.text(ustring::format("{}", toggle_button3.check_state()));
};
toggle_button3.check_state(forms::check_state::indeterminate);
toggle_button3.three_state(true);
toggle_button3.location({30, 130});
toggle_button3.width(120);
}
private:
toggle_button toggle_button1;
toggle_button toggle_button2;
toggle_button toggle_button3;
};
}
auto main() -> int {
application::run(toggle_button_example::form1 {});
}
static void run()
Begins running a standard application message loop on the current thread, without a form.
static void enable_visual_styles()
Enables visual styles for the application.
Represents a window or dialog box that makes up an application's user interface.
Definition form.h:52
@ text
The xtd::forms::status_bar_panel displays text in the standard font.
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition xtd_about_box.h:12
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.h:10
Examples
application_enable_dark_mode.cpp, application_enable_light_mode.cpp, border_style.cpp, change_parent.cpp, collapsible_panel.cpp, demo.cpp, lcd_label_appearance.cpp, some_controls.cpp, some_system_controls.cpp, themes.cpp, toggle_button.cpp, and toggle_button2.cpp.

Public Events

event< toggle_button, event_handlerchecked_changed
 Occurs when the value of the checked property changes.
 
event< toggle_button, event_handlercheck_state_changed
 Occurs when the value of the check_state property changes.
 

Public Constructors

 toggle_button ()
 Initializes a new instance of the CheckBox class.
 

Public Properties

virtual bool auto_check () const noexcept
 Gets a value indicating whether the checked or check_state values and the toggle_button's appearance are automatically changed when the toggle_button is clicked.
 
virtual toggle_buttonauto_check (bool auto_check)
 Sets a value indicating whether the checked or check_state values and the toggle_button's appearance are automatically changed when the toggle_button is clicked.
 
virtual content_alignment check_align () const noexcept
 Gets the horizontal and vertical alignment of the check mark on a toggle_button control.
 
virtual toggle_buttoncheck_align (content_alignment check_align)
 Sets the horizontal and vertical alignment of the check mark on a toggle_button control.
 
virtual bool checked () const noexcept
 Gets a value indicating whether the toggle_button is in the checked state.
 
virtual toggle_buttonchecked (bool checked)
 Sets a value indicating whether the toggle_button is in the checked state.
 
virtual forms::check_state check_state () const noexcept
 Gets the state of the toggle_button.
 
virtual toggle_buttoncheck_state (forms::check_state check_state)
 Sets the state of the toggle_button.
 
virtual bool three_state () const noexcept
 Gets a value indicating whether the toggle_button will allow three check states rather than two.
 
virtual toggle_buttonthree_state (bool three_state)
 Gets a value indicating whether the toggle_button will allow three check states rather than two.
 

Public Static Methods

static toggle_button create ()
 A factory to create an xtd::forms::toggle_button.
 
static toggle_button create (const drawing::point &location)
 A factory to create an xtd::forms::toggle_button with specified location.
 
static toggle_button create (const drawing::point &location, const drawing::size &size)
 A factory to create an xtd::forms::toggle_button with specified location, and size.
 
static toggle_button create (const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create an xtd::forms::toggle_button with specified location, size, and name.
 
static toggle_button create (const xtd::ustring &text)
 A factory to create an xtd::forms::toggle_button with specified text.
 
static toggle_button create (const xtd::ustring &text, const drawing::point &location)
 A factory to create an xtd::forms::toggle_button with specified text, and location.
 
static toggle_button create (const xtd::ustring &text, const drawing::point &location, const drawing::size &size)
 A factory to create an xtd::forms::toggle_button with specified text, location, and size.
 
static toggle_button create (const xtd::ustring &text, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create an xtd::forms::toggle_button with specified text, location, size, and name.
 
static toggle_button create (const xtd::ustring &text, xtd::forms::check_state check_state)
 A factory to create an xtd::forms::toggle_button with specified text, and check_state.
 
static toggle_button create (const xtd::ustring &text, xtd::forms::check_state check_state, const drawing::point &location)
 A factory to create an xtd::forms::toggle_button with specified text, check_state, and location.
 
static toggle_button create (const xtd::ustring &text, xtd::forms::check_state check_state, const drawing::point &location, const drawing::size &size)
 A factory to create an xtd::forms::toggle_button with specified text, check_state, location, and size.
 
static toggle_button create (const xtd::ustring &text, xtd::forms::check_state check_state, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create an xtd::forms::toggle_button with specified text, check_state, location, size, and name.
 
static toggle_button create (const xtd::ustring &text, bool three_state, xtd::forms::check_state check_state)
 A factory to create an xtd::forms::toggle_button with specified text, three_state, and check_state.
 
static toggle_button create (const xtd::ustring &text, bool three_state, xtd::forms::check_state check_state, const drawing::point &location)
 A factory to create an xtd::forms::toggle_button with specified text, three_state, check_state, and location.
 
static toggle_button create (const xtd::ustring &text, bool three_state, xtd::forms::check_state check_state, const drawing::point &location, const drawing::size &size)
 A factory to create an xtd::forms::toggle_button with specified text, three_state, check_state, location, and size.
 
static toggle_button create (const xtd::ustring &text, bool three_state, xtd::forms::check_state check_state, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create an xtd::forms::toggle_button with specified text, three_state, check_state, location, size, and name.
 
static toggle_button create (const control &parent)
 A factory to create a xtd::forms::toggle_button with specified parent.
 
static toggle_button create (const control &parent, const drawing::point &location)
 A factory to create a xtd::forms::toggle_button with specified parent, and location.
 
static toggle_button create (const control &parent, const drawing::point &location, const drawing::size &size)
 A factory to create a xtd::forms::toggle_button with specified parent, location, and size.
 
static toggle_button create (const control &parent, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a xtd::forms::toggle_button with specified parent, location, size, and name.
 
static toggle_button create (const control &parent, const xtd::ustring &text)
 A factory to create a xtd::forms::toggle_button with specified parent, and text.
 
static toggle_button create (const control &parent, const xtd::ustring &text, const drawing::point &location)
 A factory to create a xtd::forms::toggle_button with specified parent, text, and location.
 
static toggle_button create (const control &parent, const xtd::ustring &text, const drawing::point &location, const drawing::size &size)
 A factory to create a xtd::forms::toggle_button with specified parent, text, location, and size.
 
static toggle_button create (const control &parent, const xtd::ustring &text, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a xtd::forms::toggle_button with specified parent, text, location, size, and name.
 
static toggle_button create (const control &parent, const xtd::ustring &text, xtd::forms::check_state check_state)
 A factory to create a xtd::forms::toggle_button with specified parent, text, and check_state.
 
static toggle_button create (const control &parent, const xtd::ustring &text, xtd::forms::check_state check_state, const drawing::point &location)
 A factory to create a xtd::forms::toggle_button with specified parent, text, check_state, and location.
 
static toggle_button create (const control &parent, const xtd::ustring &text, xtd::forms::check_state check_state, const drawing::point &location, const drawing::size &size)
 A factory to create a xtd::forms::toggle_button with specified parent, text, check_state, location, and size.
 
static toggle_button create (const control &parent, const xtd::ustring &text, xtd::forms::check_state check_state, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a xtd::forms::toggle_button with specified parent, text, check_state, location, size, and name.
 
static toggle_button create (const control &parent, const xtd::ustring &text, bool three_state, xtd::forms::check_state check_state)
 A factory to create a xtd::forms::toggle_button with specified parent, text, three_state, and check_state.
 
static toggle_button create (const control &parent, const xtd::ustring &text, bool three_state, xtd::forms::check_state check_state, const drawing::point &location)
 A factory to create a xtd::forms::toggle_button with specified parent, text, three_state, check_state, and location.
 
static toggle_button create (const control &parent, const xtd::ustring &text, bool three_state, xtd::forms::check_state check_state, const drawing::point &location, const drawing::size &size)
 A factory to create a xtd::forms::toggle_button with specified parent, text, three_state, check_state, location, and size.
 
static toggle_button create (const control &parent, const xtd::ustring &text, bool three_state, xtd::forms::check_state check_state, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a xtd::forms::toggle_button with specified parent, text, three_state, check_state, location, size, and name.
 

Protected Properties

forms::create_params create_params () const noexcept override
 Gets the required creation parameters when the control handle is created.
 

Protected Methods

std::unique_ptr< xtd::objectclone () const override
 Creates a new object that is a copy of the current instance.
 
drawing::size measure_control () const noexcept override
 Measure this control.
 
virtual void on_checked_changed (const event_args &e)
 Raises the toggle_button::checked_changed event.
 
virtual void on_check_state_changed (const event_args &e)
 Raises the toggle_button::check_state_changed event.
 
void on_enabled_changed (const event_args &e) override
 Raises the xtd::forms::control::enabled_changed event.
 
void on_handle_created (const event_args &e) override
 Raises the xtd::forms::control::handle_created event.
 
void on_mouse_down (const mouse_event_args &e) override
 Raises the xtd::forms::control::mouse_down event.
 
void on_mouse_enter (const event_args &e) override
 Raises the xtd::forms::control::mouse_enter event.
 
void on_mouse_leave (const event_args &e) override
 Raises the xtd::forms::control::mouse_leave event.
 
void on_mouse_up (const mouse_event_args &e) override
 Raises the xtd::forms::control::mouse_up event.
 
void on_paint (paint_event_args &e) override
 Raises the xtd::forms::control::paint event.
 
xtd::forms::visual_styles::toggle_button_state state () const noexcept
 Gets state.
 
void wnd_proc (message &message) override
 Processes Windows messages.
 

Additional Inherited Members

- Public Types inherited from xtd::forms::control
using context_menu_ref = std::reference_wrapper< xtd::forms::context_menu >
 Represent an xtd::forms::context_menu reference.
 
- Public Attributes inherited from xtd::forms::button_base
event< button_base, event_handlerimage_changed
 Occurs when the value of the image property changes.
 
- Public Attributes inherited from xtd::forms::control
event< control, event_handlerauto_size_changed
 Occurs when the value of the xtd::forms::control::auto_size property changes.
 
event< control, event_handlerback_color_changed
 Occurs when the value of the xtd::forms::control::back_color property changes.
 
event< control, event_handlerbackground_image_changed
 Occurs when the value of the xtd::forms::control::background_image property changes.
 
event< control, event_handlerbackground_image_layout_changed
 Occurs when the value of the xtd::forms::control::background_image_layout property changes.
 
event< control, event_handlercontrol_appearance_changed
 Occurs when the value of the xtd::forms::control::control_appearance property changes.
 
event< control, event_handlerclick
 Occurs when the xtd::forms::control is clicked.
 
event< control, event_handlerclient_size_changed
 Occurs when the value of the xtd::forms::control::client_size property changes.
 
event< control, event_handlercursor_changed
 Occurs when the value of the xtd::forms::control::cursor property changes.
 
event< control, control_event_handlercontrol_added
 Occurs when a new xtd::forms::control::control is added to the xtd::forms::control::control_collection.
 
event< control, control_event_handlercontrol_removed
 Occurs when a new xtd::forms::control:: is removed to the xtd::forms::control::control_collection.
 
event< control, event_handlerdock_changed
 Occurs when the value of the xtd::forms::control::dock property changes.
 
event< control, event_handlerdouble_click
 Occurs when the xtd::forms::control is double-clicked.
 
event< control, event_handlergot_focus
 Occurs when the xtd::forms::control receives focus.
 
event< control, event_handlerhandle_created
 Occurs when a handle is created for the xtd::forms::control.
 
event< control, event_handlerhandle_destroyed
 Occurs when the control's handle is in the process of being destroyed.
 
event< control, event_handlerenabled_changed
 Occurs when the value of the xtd::forms::control::enabled property changes.
 
event< control, event_handlerfore_color_changed
 Occurs when the value of the xtd::forms::control::fore_color property changes.
 
event< control, event_handlerfont_changed
 Occurs when the value of the xtd::forms::control::font property changes.
 
event< control, help_event_handlerhelp_requested
 Occurs when the user requests help for a xtd::forms::control.
 
event< control, key_event_handlerkey_down
 Occurs when a key is pressed while the xtd::forms::control has focus.
 
event< control, key_press_event_handlerkey_press
 Occurs when a character. space or backspace key is pressed while the xtd::forms::control has focus.
 
event< control, key_event_handlerkey_up
 Occurs when a key is released while the xtd::forms::control has focus.
 
event< control, event_handlerlayout
 Occurs when a xtd::forms::control should reposition its child controls.
 
event< control, event_handlerlocation_changed
 Occurs when the value of the xtd::forms::control::location property changes.
 
event< control, event_handlerlost_focus
 Occurs when the xtd::forms::control loses focus.
 
event< control, mouse_event_handlermouse_click
 Occurs when the xtd::forms::control is clicked by the mouse.
 
event< control, mouse_event_handlermouse_double_click
 Occurs when the xtd::forms::control is double clicked by the mouse.
 
event< control, mouse_event_handlermouse_down
 Occurs when the mouse pointer is over the xtd::forms::control and a mouse button is pressed.
 
event< control, event_handlermouse_enter
 Occurs when the mouse pointer enters the xtd::forms::control.
 
event< control, mouse_event_handlermouse_horizontal_wheel
 Occurs when the mouse horizontal wheel moves while the xtd::forms::control has focus.
 
event< control, event_handlermouse_leave
 Occurs when the mouse pointer leaves the xtd::forms::control.
 
event< control, mouse_event_handlermouse_move
 Occurs when the mouse pointer is moved over the xtd::forms::control.
 
event< control, mouse_event_handlermouse_up
 Occurs when the mouse pointer is over the xtd::forms::control and a mouse button is released.
 
event< control, mouse_event_handlermouse_wheel
 Occurs when the mouse wheel moves while the xtd::forms::control has focus.
 
event< control, event_handlermove
 Occurs when the control is moved.
 
event< control, paint_event_handlerpaint
 Occurs when the xtd::forms::control is redrawn.
 
event< control, event_handlerparent_changed
 Occurs when the value of the xtd::forms::control::parent property changes.
 
event< control, event_handlerregion_changed
 Occurs when the value of the xtd::forms::control::region property changes.
 
event< control, event_handlerresize
 Occurs when the xtd::forms::control is resized.
 
event< control, event_handlerright_to_left_changed
 Occurs when the value of the xtd::forms::control::right_to_left property changes.
 
event< control, event_handlersize_changed
 Occurs when the value of the xtd::forms::control::size property changes.
 
event< control, event_handlerstyle_sheet_changed
 Occurs when the value of the xtd::forms::control::style_sheet property changes or when xtd::application::style_sheet property changes.
 
event< control, event_handlersystem_colors_changed
 Occurs when the xtd::drwing::system_colors changes.
 
event< control, event_handlertab_stop_changed
 Occurs when the xtd::forms::control::tab_stop property value changes.
 
event< control, event_handlertext_changed
 Occurs when the value of the xtd::forms::control::text property changes.
 
event< control, event_handlervisible_changed
 Occurs when the value of the xtd::forms::control::visible property changes.
 
- Public Member Functions inherited from xtd::forms::button_base
virtual bool auto_ellipsis () const noexcept
 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 button_baseauto_ellipsis (bool auto_ellipsis)
 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.
 
controlauto_size (bool auto_size) override
 Sets a value that indicates whether the control resizes based on its contents.
 
controlcontrol_appearance (forms::control_appearance value) override
 Sets control appearance.
 
virtual const xtd::forms::flat_button_appearanceflat_appearance () const noexcept
 Gets the appearance of the border and the colors used to indicate check state and mouse state.
 
virtual xtd::forms::button_baseflat_appearance (const xtd::forms::flat_button_appearance &value)
 Sets the appearance of the border and the colors used to indicate check state and mouse state.
 
virtual xtd::forms::flat_style flat_style () const noexcept
 Gets the flat style appearance of the button control.
 
virtual xtd::forms::button_baseflat_style (xtd::forms::flat_style value)
 Sets the flat style appearance of the button control.
 
virtual const drawing::imageimage () const noexcept
 Gets the image that is displayed on a button control.
 
virtual button_baseimage (const drawing::image &value)
 Sets the image that is displayed on a button control.
 
virtual content_alignment image_align () const noexcept
 Gets the alignment of the image on the button control.
 
virtual button_baseimage_align (content_alignment value)
 Sets the alignment of the image on the button control.
 
virtual int32 image_index () const noexcept
 Gets the image list index value of the image displayed on the button control.
 
virtual button_baseimage_index (int32 value)
 Sets the image list index value of the image displayed on the button control.
 
virtual const forms::image_listimage_list () const noexcept
 Gets the image_list that contains the image displayed on a button control.
 
virtual forms::image_listimage_list () noexcept
 Gets the image_list that contains the image displayed on a button control.
 
virtual button_baseimage_list (const forms::image_list &value)
 Sets the image_list that contains the image displayed on a button control.
 
virtual content_alignment text_align () const noexcept
 Gets the alignment of the text on the button control.
 
virtual button_basetext_align (content_alignment value)
 Gets the alignment of the text on the button control.
 
virtual forms::control_appearance control_appearance () const noexcept
 Gets control appearance.
 
virtual controlcontrol_appearance (xtd::forms::control_appearance value)
 Sets control appearance.
 
- Public Member Functions inherited from xtd::forms::control
 control ()
 Initializes a new instance of the xtd::forms::control class with default settings.
 
 control (const xtd::ustring &text)
 Initializes a new instance of the xtd::forms::control class with specific text.
 
 control (const control &parent, const xtd::ustring &text)
 Initializes a new instance of the xtd::forms::control class as a child control, with specific text.
 
 control (const xtd::ustring &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::ustring &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 anchor_styles anchor () const noexcept
 Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
 
virtual controlanchor (xtd::forms::anchor_styles anchor)
 Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
 
virtual drawing::point auto_scroll_point () const noexcept
 Gets where this control is scrolled to in scroll_control_into_view(control).
 
virtual drawing::color back_color () const noexcept
 Gets the background color for the control.
 
virtual controlback_color (const xtd::drawing::color &color)
 Sets the background color for the control.
 
virtual const xtd::drawing::imagebackground_image () const noexcept
 Gets the background image displayed in the control.
 
virtual controlbackground_image (const xtd::drawing::image &background_image)
 Sets the background image displayed in the control.
 
virtual xtd::forms::image_layout background_image_layout () const noexcept
 Gets the background image layout as defined in the xtd::forms::image_layout enumeration.
 
virtual controlbackground_image_layout (xtd::forms::image_layout background_image_layout)
 Sets the background image layout as defined in the xtd::forms::image_layout enumeration.
 
virtual int32 bottom () const noexcept
 Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
 
virtual drawing::rectangle bounds () const noexcept
 Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
 
virtual controlbounds (const xtd::drawing::rectangle &bounds)
 Sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
 
virtual bool can_focus () const noexcept
 Gets a value indicating whether the control can receive focus.
 
virtual bool can_select () const noexcept
 Gets a value indicating whether the control can be selected.
 
bool can_raise_events () const noexcept override
 Determines if events can be raised on the control.
 
virtual const drawing::rectangleclient_rectangle () const noexcept
 Gets the rectangle that represents the client area of the control.
 
virtual const drawing::sizeclient_size () const noexcept
 Gets the height and width of the client area of the control.
 
virtual controlclient_size (const xtd::drawing::size &client_size)
 Sets the height and width of the client area of the control.
 
virtual xtd::ustring company_name () const noexcept
 Gets the name of the company or creator of the application containing the control.
 
virtual std::optional< context_menu_refcontext_menu () const noexcept
 Gets the xtd::forms::context_menu that is displayed in the control.
 
virtual controlcontext_menu (xtd::forms::context_menu &value)
 Sets the xtd::forms::context_menu that is displayed in the control.
 
virtual controlcontext_menu (std::nullptr_t)
 Sets the xtd::forms::context_menu that is displayed in the control.
 
virtual control_collectioncontrols () noexcept
 Gets the collection of controls contained within the control.
 
virtual const control_collectioncontrols () const noexcept
 Gets the collection of controls contained within the control.
 
virtual bool created () const noexcept
 Gets a value indicating whether the control has been created.
 
virtual forms::cursor cursor () const noexcept
 Gets the cursor that is displayed when the mouse pointer is over the control.
 
virtual controlcursor (const xtd::forms::cursor &cursor)
 Sets the cursor that is displayed when the mouse pointer is over the control.
 
virtual drawing::rectangle display_rectangle () const noexcept
 Gets the rectangle that represents the display area of the control.
 
virtual dock_style dock () const noexcept
 Gets which control borders are docked to its parent control and determines how a control is resized with its parent.
 
virtual controldock (xtd::forms::dock_style dock)
 Sets which control borders are docked to its parent control and determines how a control is resized with its parent.
 
virtual bool double_buffered () const noexcept
 Gets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
 
virtual controldouble_buffered (bool double_buffered)
 Sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
 
virtual bool enabled () const noexcept
 Gets a value indicating whether the control can respond to user interaction.
 
virtual controlenabled (bool enabled)
 Sets a value indicating whether the control can respond to user interaction.
 
virtual bool focused () const noexcept
 Gets a value indicating whether the control has input focus.
 
virtual drawing::font font () const noexcept
 Gets the font of the text displayed by the control.
 
virtual controlfont (const xtd::drawing::font &font)
 Sets the font of the text displayed by the control.
 
virtual drawing::color fore_color () const noexcept
 Gets the foreground color of the control.
 
virtual controlfore_color (const xtd::drawing::color &color)
 Sets the foreground color of the control.
 
intptr handle () const override
 Gets the window handle that the control is bound to.
 
virtual int32 height () const noexcept
 Gets the height of the control.
 
virtual controlheight (int32 height)
 Sets the height of the control.
 
bool invoke_required () const noexcept 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.
 
bool is_handle_created () const noexcept
 Gets a value indicating whether the control has a handle associated with it.
 
virtual int32 left () const noexcept
 Gets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
 
virtual controlleft (int32 left)
 Sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
 
virtual drawing::point location () const noexcept
 Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
 
virtual controllocation (const xtd::drawing::point &location)
 Sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
 
virtual forms::padding margin () const noexcept
 Gets the space between controls.
 
virtual controlmargin (const xtd::forms::padding &margin)
 Sets the space between controls.
 
virtual const drawing::sizemaximum_client_size () const noexcept
 Gets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
 
virtual controlmaximum_client_size (const xtd::drawing::size &size)
 Sets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
 
virtual const drawing::sizemaximum_size () const noexcept
 Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
 
virtual controlmaximum_size (const xtd::drawing::size &size)
 Sets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
 
virtual const drawing::sizeminimum_client_size () const noexcept
 Gets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
 
virtual controlminimum_client_size (const xtd::drawing::size &size)
 Sets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
 
virtual const drawing::sizeminimum_size () const noexcept
 Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
 
virtual controlminimum_size (const xtd::drawing::size &size)
 Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
 
intptr native_handle () const noexcept
 Gets the native handle that the control is bound to.
 
virtual const xtd::ustringname () const noexcept
 Gets the name of the control.
 
virtual controlname (const xtd::ustring &name)
 Sets the name of the control.
 
virtual forms::padding padding () const noexcept
 Gets padding within the control.
 
virtual controlpadding (const xtd::forms::padding &padding)
 Sets padding within the control.
 
virtual std::optional< control_refparent () const noexcept
 Gets the parent container of the control.
 
virtual controlparent (const control &parent)
 Sets the parent container of the control.
 
virtual controlparent (std::nullptr_t)
 Resets the parent container of the control.
 
virtual xtd::ustring product_name () const noexcept
 Gets the product name of the assembly containing the control.
 
bool recreating_handle () const noexcept
 Gets a value indicating whether the control is currently re-creating its handle.
 
virtual const xtd::drawing::regionregion () const noexcept
 Gets the window region associated with the control.
 
virtual controlregion (const xtd::drawing::region &value)
 Sets the window region associated with the control.
 
virtual int32 right () const noexcept
 Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
 
virtual xtd::forms::right_to_left right_to_left () const noexcept
 Gets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
 
virtual controlright_to_left (xtd::forms::right_to_left value)
 Sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
 
virtual drawing::size size () const noexcept
 Gets the height and width of the control.
 
virtual controlsize (const drawing::size &size)
 Sets the height and width of the control.
 
virtual style_sheets::style_sheet style_sheet () const noexcept
 Gets the contol style sheet.
 
virtual controlstyle_sheet (const style_sheets::style_sheet &value)
 Sets the contol style sheet.
 
virtual controlstyle_sheet (const xtd::ustring &value)
 Sets the contol style sheet.
 
virtual controlstyle_sheet (std::nullptr_t)
 Resets the contol style sheet.
 
virtual bool tab_stop () const noexcept
 Gets a value indicating whether the user can give the focus to this control using the TAB key.
 
virtual controltab_stop (bool value)
 Sets a value indicating whether the user can give the focus to this control using the TAB key.
 
virtual std::any tag () const noexcept
 Gets the object that contains data about the control.
 
virtual controltag (std::any tag)
 Sets the object that contains data about the control.
 
virtual const xtd::ustringtext () const noexcept
 Gets the text associated with this control.
 
virtual controltext (const xtd::ustring &text)
 Sets the text associated with this control.
 
intptr toolkit_handle () const noexcept
 Gets the toolkit handle that the control is bound to.
 
virtual int32 top () const noexcept
 Gets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
 
virtual controltop (int32 top)
 Sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
 
virtual std::optional< control_reftop_level_control () const noexcept
 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 bool visible () const noexcept
 Gets a value indicating whether the control and all its child controls are displayed.
 
virtual controlvisible (bool visible)
 Sets a value indicating whether the control and all its child controls are displayed.
 
virtual int32 width () const noexcept
 Gets the width of the control.
 
virtual controlwidth (int32 width)
 Sets the width of the control.
 
xtd::async_result begin_invoke (delegate< void()> method) override
 Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
 
xtd::async_result begin_invoke (delegate< void(std::vector< std::any >)> method, const std::vector< std::any > &args) override
 Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
 
virtual void bring_to_front ()
 Brings the control to the front of the z-order.
 
int32 compare_to (const control &value) const noexcept override
 
void create_control ()
 Forces the creation of the visible control, including the creation of the handle and any visible child controls.
 
drawing::graphics create_graphics () const
 Creates the xtd::drawing::graphics for the control.
 
virtual void destroy_control ()
 Forces the destruction of the visible control, including the destruction of the handle and any visible child controls.
 
std::optional< object_refend_invoke (xtd::async_result async) override
 Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed.
 
bool equals (const control &value) const noexcept override
 
bool focus ()
 Sets input focus to the control.
 
auto_size_mode get_auto_size_mode () const
 Gets a value indicating how a control will behave when its auto_size property is enabled.
 
size_t get_child_index (intptr child) const
 Retrieves the index of a control within the control collection.
 
size_t get_child_index (intptr child, bool &throw_exception) const
 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.
 
virtual void hide ()
 Conceals the control from the user.
 
virtual void invalidate () const
 Invalidates the entire surface of the control and causes the control to be redrawn.
 
virtual void invalidate (bool invalidate_children) const
 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 void invalidate (const drawing::rectangle &rect) const
 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 void invalidate (const drawing::rectangle &rect, bool invalidate_children) const
 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 void invalidate (const drawing::region &region) const
 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 void invalidate (const drawing::region &region, bool invalidate_children) const
 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.
 
std::optional< object_refinvoke (delegate< void()> method) override
 Executes the specified delegate on the thread that owns the control's underlying window handle.
 
std::optional< object_refinvoke (delegate< void(std::vector< std::any >)> method, const std::vector< std::any > &args) override
 Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
 
std::optional< object_refinvoke (delegate< void(std::vector< std::any >)> method, std::any arg) override
 Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
 
void perform_layout ()
 Forces the control to apply layout logic to all its child controls.
 
xtd::drawing::point point_to_client (const xtd::drawing::point &p) const
 Computes the location of the specified screen point into client coordinates.
 
xtd::drawing::point point_to_screen (const xtd::drawing::point &p) const
 Computes the location of the specified client point into screen coordinates.
 
bool post_message (intptr hwnd, int32 msg, intptr wparam, intptr lparam) const
 Places (posts) a message in the message queue with specified hwnd, message, wparam and lparam.
 
virtual bool pre_process_message (const xtd::forms::message &message)
 Preprocesses keyboard or input messages within the message loop before they are dispatched.
 
virtual void refresh () const
 Forces the control to invalidate its client area and immediately redraw itself and any child controls.
 
void resume_layout ()
 Resumes usual layout logic.
 
void resume_layout (bool perform_layout)
 Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
 
intptr send_message (intptr hwnd, int32 msg, intptr wparam, intptr lparam) const
 Send a message with specified hwnd, message, wparam and lparam.
 
void set_auto_size_mode (auto_size_mode auto_size_mode)
 Sets a value indicating how a control will behave when its auto_size property is enabled.
 
void set_bounds (int32 x, int32 y, int32 width, int32 height)
 Sets the bounds of the control to the specified location and size.
 
void set_bounds (int32 x, int32 y, int32 width, int32 height, bounds_specified specified)
 Sets the specified bounds of the control to the specified location and size.
 
virtual void show ()
 Displays the control to the user.
 
void suspend_layout ()
 Temporarily suspends the layout logic for the control.
 
xtd::ustring to_string () const noexcept override
 Returns a string containing the name of the control, if any.
 
virtual void update () const
 Causes the control to redraw the invalidated regions within its client area.
 
virtual xtd::async_result begin_invoke (delegate< void()> method)=0
 Asynchronously executes the delegate on the thread that created this object.
 
virtual xtd::async_result begin_invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)=0
 Asynchronously executes the delegate on the thread that created this object.
 
virtual std::optional< object_refinvoke (delegate< void()> value)=0
 Synchronously executes the delegate on the thread that created this object and marshals the call to the creating thread.
 
virtual std::optional< object_refinvoke (delegate< void(std::vector< std::any >)> method, const std::vector< std::any > &args)=0
 Synchronously executes the delegate on the thread that created this object and marshals the call to the creating thread.
 
virtual std::optional< object_refinvoke (delegate< void(std::vector< std::any >)> method, std::any arg)=0
 Synchronously executes the delegate on the thread that created this object and marshals the call to the creating thread.
 
controloperator<< (control &child)
 Add child control.
 
controloperator>> (control &child)
 Remove child control.
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object.
 
- Public Member Functions inherited from xtd::forms::iwin32_window
- Public Member Functions inherited from xtd::iclonable
- Public Member Functions inherited from xtd::icomparable< control >
virtual int32 compare_to (const control &obj) const noexcept=0
 Compares the current instance with another object of the same type.
 
- Public Member Functions inherited from xtd::iequatable< control >
virtual bool equals (const control &) const noexcept=0
 Indicates whether the current object is equal to another object of the same type.
 
- Public Member Functions inherited from xtd::isynchronize_invoke
- Static Public Member Functions inherited from xtd::forms::control
static bool check_for_illegal_cross_thread_calls () noexcept
 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 void check_for_illegal_cross_thread_calls (bool value)
 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 forms::keys modifier_keys () noexcept
 Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
 
static forms::mouse_buttons mouse_buttons () noexcept
 Gets a value indicating which of the mouse buttons is in a pressed state.
 
static xtd::drawing::point mouse_position () noexcept
 Gets the position of the mouse cursor in screen coordinates.
 
static control create ()
 A factory to create a specified control.
 
static control create (const drawing::point &location)
 A factory to create a specified control with specified location.
 
static control create (const drawing::point &location, const drawing::size &size)
 A factory to create a specified control with specified location, and size.
 
static control create (const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a specified control with specified location, size, and name.
 
static control create (const control &paren)
 A factory to create a specified control with specified parent.
 
static control create (const control &parent, const drawing::point &location)
 A factory to create a specified control with specified parent, location, size, and name.
 
static control create (const control &parent, const drawing::point &location, const drawing::size &size)
 A factory to create a specified control with specified parent, location, and size.
 
static control create (const control &parent, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a specified control with specified parent, location, size, and name.
 
template<typename control_t >
static control_t create ()
 A factory to create a specified control.
 
template<typename control_t >
static control_t create (const drawing::point &location)
 A factory to create a specified control with specified location.
 
template<typename control_t >
static control_t create (const drawing::point &location, const drawing::size &size)
 A factory to create a specified control with specified location, and size.
 
template<typename control_t >
static control_t create (const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a specified control with specified location, size, and name.
 
template<typename control_t >
static control_t create (const control &parent)
 A factory to create a specified control with specified parent.
 
template<typename control_t >
static control_t create (const control &parent, const drawing::point &location)
 A factory to create a specified control with specified parent, and location.
 
template<typename control_t >
static control_t create (const control &parent, const drawing::point &location, const drawing::size &size)
 A factory to create a specified control with specified parent, location, and size.
 
template<typename control_t >
static control_t create (const control &parent, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a specified control with specified parent, location, size, and name.
 
template<typename control_t >
static control_t create (const xtd::ustring &text)
 A factory to create a specified control with specified text.
 
template<typename control_t >
static control_t create (const xtd::ustring &text, const drawing::point &location)
 A factory to create a specified control with specified text, and location.
 
template<typename control_t >
static control_t create (const xtd::ustring &text, const drawing::point &location, const drawing::size &size)
 A factory to create a specified control with specified text, location, and size.
 
template<typename control_t >
static control_t create (const xtd::ustring &text, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a specified control with specified text, location,size, and name.
 
template<typename control_t >
static control_t create (const control &parent, const xtd::ustring &text)
 A factory to create a specified control with specified parent, and text.
 
template<typename control_t >
static control_t create (const control &parent, const xtd::ustring &text, const drawing::point &location)
 A factory to create a specified control with specified parent, text, and location.
 
template<typename control_t >
static control_t create (const control &parent, const xtd::ustring &text, const drawing::point &location, const drawing::size &size)
 A factory to create a specified control with specified parent, text, location, and size.
 
template<typename control_t >
static control_t create (const control &parent, const xtd::ustring &text, const drawing::point &location, const drawing::size &size, const xtd::ustring &name)
 A factory to create a specified control with specified parent, text, location, size, and name.
 
static std::optional< control_reffrom_child_handle (intptr handle)
 Retrieves the control that contains the specified handle.
 
static std::optional< control_reffrom_handle (intptr handle)
 Returns the control that is currently associated with the specified handle.
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 
- Protected Member Functions inherited from xtd::forms::button_base
 button_base () noexcept
 Initializes a new instance of the ButtonBase class.
 
bool is_default () const noexcept
 Gets a value indicating whether the button control is the default button.
 
button_baseis_default (bool value)
 Sets a value indicating whether the button control is the default button.
 
void on_back_color_changed (const event_args &e) override
 Raises the xtd::forms::control::back_color_changed event.
 
void on_font_changed (const xtd::event_args &e) override
 Raises the xtd::forms::control::font_changed event.
 
void on_fore_color_changed (const event_args &e) override
 Raises the xtd::forms::control::fore_color_changed event.
 
virtual void on_image_changed (const xtd::event_args &e)
 Raises the button_base::image_changed event.
 
void on_parent_back_color_changed (const event_args &e) override
 Raises the xtd::forms::control::parent_back_color_changed event.
 
void on_parent_fore_color_changed (const event_args &e) override
 Raises the xtd::forms::control::parent_fore_color_changed event.
 
void on_resize (const xtd::event_args &e) override
 Raises the xtd::forms::control::region event.
 
void on_text_changed (const xtd::event_args &e) override
 Raises the xtd::forms::control::text_changed event.
 
- Protected Member Functions inherited from xtd::forms::control
xtd::forms::visual_styles::control_state control_state () const noexcept
 Gets state.
 
virtual drawing::color default_back_color () const noexcept
 Gets the default background color of the control.
 
virtual forms::cursor default_cursor () const noexcept
 Gets the default cursor for the control.
 
virtual drawing::font default_font () const noexcept
 Gets the default font of the control.
 
virtual drawing::color default_fore_color () const noexcept
 Gets the default foreground color of the control.
 
virtual drawing::size default_size () const noexcept
 Gets the default size of the control.
 
virtual void create_handle ()
 Creates a handle for the control.
 
virtual void destroy_handle ()
 Destroys the handle associated with the control.
 
virtual void def_wnd_proc (message &message)
 Sends the specified message to the default window procedure.
 
bool get_style (control_styles flag) const noexcept
 Retrieves the value of the specified control style bit for the control.
 
drawing::size measure_text () const noexcept
 Measure this control text.
 
virtual void on_auto_size_changed (const event_args &e)
 Raises the xtd::forms::control::auto_size_changed event.
 
virtual void on_background_image_changed (const event_args &e)
 Raises the xtd::forms::control::background_image_changed event.
 
virtual void on_background_image_layout_changed (const event_args &e)
 Raises the xtd::forms::control::background_image_layout_changed event.
 
virtual void on_control_appearance_changed (const event_args &e)
 Raises the control::control_appearance_changed event.
 
virtual void on_click (const event_args &e)
 Raises the xtd::forms::control::click event.
 
virtual void on_client_size_changed (const event_args &e)
 Raises the xtd::forms::control::client_size_changed event.
 
virtual void on_control_added (const control_event_args &e)
 Raises the xtd::forms::control::control_added event.
 
virtual void on_control_removed (const control_event_args &e)
 Raises the xtd::forms::control::control_removed event.
 
virtual void on_create_control ()
 Raises the xtd::forms::control::create_control event.
 
virtual void on_cursor_changed (const event_args &e)
 Raises the xtd::forms::control::cursor_changed event.
 
virtual void on_destroy_control ()
 Raises the xtd::forms::control::destroy_control event.
 
virtual void on_dock_changed (const event_args &e)
 Raises the xtd::forms::control::dock_changed event.
 
virtual void on_double_click (const event_args &e)
 Raises the xtd::forms::control::double_click event.
 
virtual void on_got_focus (const event_args &e)
 Raises the xtd::forms::control::got_focus event.
 
virtual void on_handle_destroyed (const event_args &e)
 Raises the xtd::forms::control::handle_destroyed event.
 
virtual void on_help_requested (help_event_args &e)
 Raises the xtd::forms::control::help_requested event.
 
virtual void on_key_down (key_event_args &e)
 Raises the xtd::forms::control::key_down event.
 
virtual void on_key_press (key_press_event_args &e)
 Raises the xtd::forms::control::key_press event.
 
virtual void on_key_up (key_event_args &e)
 Raises the xtd::forms::control::key_up event.
 
virtual void on_layout (const event_args &e)
 Raises the xtd::forms::control::layout event.
 
virtual void on_location_changed (const event_args &e)
 Raises the xtd::forms::control::location_changed event.
 
virtual void on_lost_focus (const event_args &e)
 Raises the xtd::forms::control::lost_focus event.
 
virtual void on_mouse_click (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_click event.
 
virtual void on_mouse_double_click (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_double_click event.
 
virtual void on_mouse_horizontal_wheel (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_horizontal_wheel event.
 
virtual void on_mouse_move (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_move event.
 
virtual void on_mouse_wheel (const mouse_event_args &e)
 Raises the xtd::forms::control::mouse_wheel event.
 
virtual void on_move (const event_args &e)
 Raises the xtd::forms::control::move event.
 
virtual void on_paint_background (paint_event_args &e)
 Paints the background of the xtd::forms::control.
 
virtual void on_parent_cursor_changed (const event_args &e)
 Raises the xtd::forms::control::parent_cursor_changed event.
 
virtual void on_parent_changed (const event_args &e)
 Raises the xtd::forms::control::parent_changed event.
 
virtual void on_parent_enabled_changed (const event_args &e)
 Raises the xtd::control::enabled_changed event when the xtd::control::enabled property value of the control's container changes..
 
virtual void on_parent_font_changed (const event_args &e)
 Raises the xtd::forms::control::parent_font_changed event.
 
virtual void on_region_changed (const event_args &e)
 Raises the xtd::forms::control::region_changed event.
 
virtual void on_right_to_left_changed (const event_args &e)
 Raises the xtd::forms::control::right_to_left_changed event.
 
virtual void on_size_changed (const event_args &e)
 Raises the xtd::forms::control::size_changed event.
 
virtual void on_style_sheet_changed (const event_args &e)
 Raises the xtd::forms::control::style_sheet_changed event.
 
virtual void on_system_colors_changed (const event_args &e)
 Raises the control::system_colors_changed event.
 
virtual void on_tab_stop_changed (const event_args &e)
 Raises the xtd::forms::control::tab_stop_changed event.
 
virtual void on_visible_changed (const event_args &e)
 Raises the xtd::forms::control::visible_changed event.
 
void post_recreate_handle () noexcept
 
virtual void recreate_handle ()
 Forces the re-creation of the handle for the control.
 
virtual void set_bounds_core (int32 x, int32 y, int32 width, int32 height, bounds_specified specified)
 Performs the work of setting the specified bounds of this control.
 
void set_can_focus (bool value)
 Sets a value indicating whether the control can receive focus.
 
virtual void set_text (const xtd::ustring &text)
 Sets the text associated with this control.
 
virtual void set_client_size_core (int32 width, int32 height)
 Sets the size of the client area of the control.
 
void set_parent (intptr handle)
 Sets the parent handle of the control.
 
void set_style (control_styles flag, bool value)
 Sets a specified control_styles flag to either true or false.
 
- Protected Member Functions inherited from xtd::forms::component
 component ()
 Initialises a new instance of the component class.
 
bool design_mode () const noexcept
 Gets a value that indicates whether the component is currently in design mode.
 
- Static Protected Member Functions inherited from xtd::forms::control
static void set_mouse_buttons (forms::mouse_buttons value)
 Sets a value indicating which of the mouse buttons is in a pressed state.
 

Constructor & Destructor Documentation

◆ toggle_button()

xtd::forms::toggle_button::toggle_button ( )

Initializes a new instance of the CheckBox class.

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

Member Function Documentation

◆ auto_check() [1/2]

virtual bool xtd::forms::toggle_button::auto_check ( ) const
virtualnoexcept

Gets a value indicating whether the checked or check_state values and the toggle_button's appearance are automatically changed when the toggle_button 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.

◆ auto_check() [2/2]

virtual toggle_button & xtd::forms::toggle_button::auto_check ( bool  auto_check)
virtual

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

Parameters
auto_checktrue 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 content_alignment xtd::forms::toggle_button::check_align ( ) const
virtualnoexcept

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

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

◆ check_align() [2/2]

virtual toggle_button & xtd::forms::toggle_button::check_align ( content_alignment  check_align)
virtual

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

Parameters
check_alignOne of the content_alignment values. The default value is middle_left.

◆ check_state() [1/2]

virtual forms::check_state xtd::forms::toggle_button::check_state ( ) const
virtualnoexcept

Gets the state of the toggle_button.

Returns
One of the 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 toggle_button control in its different states for the normal and button style control toggle_button::appearance.
Check_state appearance::normal appearance::button
checked The toggle_button 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.

◆ check_state() [2/2]

virtual toggle_button & xtd::forms::toggle_button::check_state ( forms::check_state  check_state)
virtual

Sets the state of the toggle_button.

Parameters
chexk_stateOne of the check_state enumeration values. The default value is unchecked.
Remarks
The following table describes the xtd::forms::appearance of the toggle_button control in its different states for the normal and button style control toggle_button::appearance.
Check_state appearance::normal appearance::button
checked The toggle_button 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.

◆ checked() [1/2]

virtual bool xtd::forms::toggle_button::checked ( ) const
virtualnoexcept

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

Returns
true if the toggle_button 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 toggle_button 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.

◆ checked() [2/2]

virtual toggle_button & xtd::forms::toggle_button::checked ( bool  checked)
virtual

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

Parameters
checkedtrue if the toggle_button is in the checked state; otherwise, false. The default value is false.
Remarks
When the value is true, the toggle_button 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.

◆ clone()

std::unique_ptr< xtd::object > xtd::forms::toggle_button::clone ( ) const
overrideprotectedvirtual

Creates a new object that is a copy of the current instance.

Returns
A new object that is a copy of this instance.
Notes to Implementers
All controls must be override the clone method.

Reimplemented from xtd::forms::control.

◆ create() [1/32]

static toggle_button xtd::forms::toggle_button::create ( )
static

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

Returns
New xtd::forms::toggle_button created.

◆ create() [2/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [3/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const drawing::point location 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [4/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const drawing::point location,
const drawing::size size 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [5/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const drawing::point location,
const drawing::size size,
const xtd::ustring name 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
nameThe name of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [6/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [7/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
bool  three_state,
xtd::forms::check_state  check_state 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
three_statetrue if the toggle_button is able to display three check states; otherwise, false.
check_stateOne of the check_state enumeration values.
Returns
New xtd::forms::toggle_button created.

◆ create() [8/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
bool  three_state,
xtd::forms::check_state  check_state,
const drawing::point location 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
three_statetrue if the toggle_button is able to display three check states; otherwise, false.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [9/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
bool  three_state,
xtd::forms::check_state  check_state,
const drawing::point location,
const drawing::size size 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
three_statetrue if the toggle_button is able to display three check states; otherwise, false.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [10/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
bool  three_state,
xtd::forms::check_state  check_state,
const drawing::point location,
const drawing::size size,
const xtd::ustring name 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
three_statetrue if the toggle_button is able to display three check states; otherwise, false.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
nameThe name of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [11/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
const drawing::point location 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [12/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
const drawing::point location,
const drawing::size size 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [13/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
const drawing::point location,
const drawing::size size,
const xtd::ustring name 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
nameThe name of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [14/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
xtd::forms::check_state  check_state 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
check_stateOne of the check_state enumeration values.
Returns
New xtd::forms::toggle_button created.

◆ create() [15/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
xtd::forms::check_state  check_state,
const drawing::point location 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [16/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
xtd::forms::check_state  check_state,
const drawing::point location,
const drawing::size size 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [17/32]

static toggle_button xtd::forms::toggle_button::create ( const control parent,
const xtd::ustring text,
xtd::forms::check_state  check_state,
const drawing::point location,
const drawing::size size,
const xtd::ustring name 
)
static

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

Parameters
parentThe parent that contains the new created xtd::forms::toggle_button.
textA string that represent text of the xtd::forms::toggle_button.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
nameThe name of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [18/32]

static toggle_button xtd::forms::toggle_button::create ( const drawing::point location)
static

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

Parameters
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [19/32]

static toggle_button xtd::forms::toggle_button::create ( const drawing::point location,
const drawing::size size 
)
static

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

Parameters
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [20/32]

static toggle_button xtd::forms::toggle_button::create ( const drawing::point location,
const drawing::size size,
const xtd::ustring name 
)
static

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

Parameters
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
nameThe name of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [21/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [22/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
bool  three_state,
xtd::forms::check_state  check_state 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
three_statetrue if the toggle_button is able to display three check states; otherwise, false.
check_stateOne of the check_state enumeration values.
Returns
New xtd::forms::toggle_button created.

◆ create() [23/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
bool  three_state,
xtd::forms::check_state  check_state,
const drawing::point location 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
three_statetrue if the toggle_button is able to display three check states; otherwise, false.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [24/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
bool  three_state,
xtd::forms::check_state  check_state,
const drawing::point location,
const drawing::size size 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
three_statetrue if the toggle_button is able to display three check states; otherwise, false.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [25/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
bool  three_state,
xtd::forms::check_state  check_state,
const drawing::point location,
const drawing::size size,
const xtd::ustring name 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
three_statetrue if the toggle_button is able to display three check states; otherwise, false.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
nameThe name of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [26/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
const drawing::point location 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [27/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
const drawing::point location,
const drawing::size size 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [28/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
const drawing::point location,
const drawing::size size,
const xtd::ustring name 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
nameThe name of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [29/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
xtd::forms::check_state  check_state 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
check_stateOne of the check_state enumeration values.
Returns
New xtd::forms::toggle_button created.

◆ create() [30/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
xtd::forms::check_state  check_state,
const drawing::point location 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [31/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
xtd::forms::check_state  check_state,
const drawing::point location,
const drawing::size size 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create() [32/32]

static toggle_button xtd::forms::toggle_button::create ( const xtd::ustring text,
xtd::forms::check_state  check_state,
const drawing::point location,
const drawing::size size,
const xtd::ustring name 
)
static

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

Parameters
textA string that represent text of the xtd::forms::toggle_button.
check_stateOne of the check_state enumeration values.
locationA xtd::drawing::point that represent location of the xtd::forms::toggle_button.
sizeA xtd::drawing::size that represent size of the xtd::forms::toggle_button.
nameThe name of the xtd::forms::toggle_button.
Returns
New xtd::forms::toggle_button created.

◆ create_params()

forms::create_params xtd::forms::toggle_button::create_params ( ) const
overrideprotectedvirtualnoexcept

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

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

Reimplemented from xtd::forms::button_base.

◆ measure_control()

drawing::size xtd::forms::toggle_button::measure_control ( ) const
overrideprotectedvirtualnoexcept

Measure this control.

Returns
The drawing::size size of this control.
Remarks
This metod is not relevant for this class.

Reimplemented from xtd::forms::button_base.

◆ on_check_state_changed()

virtual void xtd::forms::toggle_button::on_check_state_changed ( const event_args e)
protectedvirtual

Raises the toggle_button::check_state_changed event.

Parameters
eAn 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_checked_changed()

virtual void xtd::forms::toggle_button::on_checked_changed ( const event_args e)
protectedvirtual

Raises the toggle_button::checked_changed event.

Parameters
eAn 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_enabled_changed()

void xtd::forms::toggle_button::on_enabled_changed ( const event_args e)
overrideprotectedvirtual

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

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_handle_created()

void xtd::forms::toggle_button::on_handle_created ( const event_args e)
overrideprotectedvirtual

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

Parameters
eAn event_args that contains the event data.

Reimplemented from xtd::forms::control.

◆ on_mouse_down()

void xtd::forms::toggle_button::on_mouse_down ( const mouse_event_args e)
overrideprotectedvirtual

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

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_mouse_enter()

void xtd::forms::toggle_button::on_mouse_enter ( const event_args e)
overrideprotectedvirtual

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

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_mouse_leave()

void xtd::forms::toggle_button::on_mouse_leave ( const event_args e)
overrideprotectedvirtual

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

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_mouse_up()

void xtd::forms::toggle_button::on_mouse_up ( const mouse_event_args e)
overrideprotectedvirtual

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

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_paint()

void xtd::forms::toggle_button::on_paint ( paint_event_args e)
overrideprotectedvirtual

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

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

◆ state()

xtd::forms::visual_styles::toggle_button_state xtd::forms::toggle_button::state ( ) const
protectednoexcept

Gets state.

Returns
One of xtd::forms::visual_styles::toggle_button_state values.

◆ three_state() [1/2]

virtual bool xtd::forms::toggle_button::three_state ( ) const
virtualnoexcept

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

Returns
true if the toggle_button 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.

◆ three_state() [2/2]

virtual toggle_button & xtd::forms::toggle_button::three_state ( bool  three_state)
virtual

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

Parameters
three_statetrue if the toggle_button 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.

◆ wnd_proc()

void xtd::forms::toggle_button::wnd_proc ( message m)
overrideprotectedvirtual

Processes Windows messages.

Parameters
mThe 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

◆ check_state_changed

event<toggle_button, event_handler> xtd::forms::toggle_button::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.

◆ checked_changed

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

Occurs when the value of the checked 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: