xtd.forms - Reference Guide  0.1.0
Modern c++17 library containing classes for creating Windows-based applications that take full advantage of the rich user interface features available in the Microsoft Windows, Apple macOS and Linux like Ubuntu operating system.
xtd::forms::check_box Class Reference

Represents a Windows check_box. More...

#include <check_box.hpp>

Inheritance diagram for xtd::forms::check_box:
xtd::forms::button_base xtd::forms::control xtd::forms::component xtd::forms::iwin32_window

Public Member Functions

 check_box ()
 Initializes a new instance of the CheckBox class. More...
 
virtual forms::appearance appearance () const
 Gets the value that determines the appearance of a check_box control. More...
 
virtual check_boxappearance (forms::appearance appearance)
 Gets the value that determines the appearance of a check_box control. More...
 
virtual bool auto_check () const
 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. More...
 
virtual check_boxauto_check (bool auto_check)
 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. More...
 
virtual content_alignment check_align () const
 Gets the horizontal and vertical alignment of the check mark on a check_box control. More...
 
virtual check_boxcheck_align (content_alignment check_align)
 Sets the horizontal and vertical alignment of the check mark on a check_box control. More...
 
virtual forms::check_state check_state () const
 Gets the state of the check_box. More...
 
virtual check_boxcheck_state (forms::check_state check_state)
 Sets the state of the check_box. More...
 
virtual bool checked () const
 Gets a value indicating whether the check_box is in the checked state. More...
 
virtual check_boxchecked (bool checked)
 Sets a value indicating whether the check_box is in the checked state. More...
 
drawing::size default_size () const override
 Gets the default size of the control. More...
 
virtual bool three_state () const
 Gets a value indicating whether the check_box will allow three check states rather than two. More...
 
virtual check_boxthree_state (bool three_state)
 Gets a value indicating whether the check_box will allow three check states rather than two. More...
 
- Public Member Functions inherited from xtd::forms::button_base
bool auto_ellipsis () const
 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. More...
 
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. More...
 
bool auto_size () const override
 Gets a value that indicates whether the control resizes based on its contents. More...
 
controlauto_size (bool auto_size) override
 Sets a value that indicates whether the control resizes based on its contents. More...
 
virtual const drawing::imageimage () const
 
virtual button_baseimage (const drawing::image &value)
 
virtual content_alignment image_align () const
 Gets the alignment of the image on the button control. More...
 
virtual button_baseimage_align (content_alignment value)
 Gets the alignment of the image on the button control. More...
 
virtual int32_t image_index () const
 
virtual button_baseimage_index (int32_t value)
 
virtual const forms::image_listimage_list () const
 
virtual button_baseimage_list (const forms::image_list &value)
 
virtual content_alignment text_align () const
 Gets the alignment of the text on the button control. More...
 
virtual button_basetext_align (content_alignment value)
 Gets the alignment of the text on the button control. More...
 
- Public Member Functions inherited from xtd::forms::control
 control ()
 Initializes a new instance of the Control class with default settings. More...
 
 control (const ustring &text)
 Initializes a new instance of the control class with specific text. More...
 
 control (const control &parent, const ustring &text)
 nitializes a new instance of the control class as a child control, with specific text. More...
 
 control (const ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
 Initializes a new instance of the control class with specific text, size, and location. More...
 
 control (const control &parent, const ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
 Initializes a new instance of the control class as a child control, with specific text, size, and location. More...
 
virtual anchor_styles anchor () const
 Gets the edges of the container to which a control is bound and determines how a control is resized with its parent. More...
 
virtual controlanchor (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. More...
 
virtual drawing::point auto_scroll_point () const
 Gets where this control is scrolled to in scroll_control_into_view(control). More...
 
virtual drawing::color back_color () const
 Gets the background color for the control. More...
 
virtual controlback_color (const drawing::color &color)
 Sets the background color for the control. More...
 
virtual int32_t bottom () const
 Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. More...
 
virtual drawing::rectangle bounds () const
 Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. More...
 
virtual controlbounds (const drawing::rectangle &bounds)
 Sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. More...
 
virtual bool can_focus () const
 Gets a value indicating whether the control can receive focus. More...
 
bool can_raise_events () const override
 Determines if events can be raised on the control. More...
 
virtual bool can_select () const
 Gets a value indicating whether the control can be selected. More...
 
virtual const drawing::rectangleclient_rectangle () const
 Gets the rectangle that represents the client area of the control. More...
 
virtual const drawing::sizeclient_size () const
 Gets the height and width of the client area of the control. More...
 
virtual controlclient_size (const drawing::size &client_size)
 Sets the height and width of the client area of the control. More...
 
virtual ustring compagny_name () const
 Gets the name of the company or creator of the application containing the control. More...
 
virtual control_collectioncontrols ()
 Gets the collection of controls contained within the control. More...
 
virtual const control_collectioncontrols () const
 Gets the collection of controls contained within the control. More...
 
void create_control ()
 
drawing::graphics create_graphics () const
 
virtual void create_handle ()
 
virtual bool created ()
 Gets a value indicating whether the control has been created. More...
 
virtual forms::cursor cursor () const
 
virtual controlcursor (const forms::cursor &cursor)
 
virtual drawing::color default_back_color () const
 Gets the default background color of the control. More...
 
virtual forms::cursor default_cursor () const
 
virtual drawing::font default_font () const
 
virtual drawing::color default_fore_color () const
 
void destroy_control ()
 
virtual void destroy_handle ()
 
virtual drawing::rectangle display_rectangle () const
 
virtual dock_style dock () const
 Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. More...
 
virtual controldock (dock_style dock)
 
virtual bool enabled () const
 
virtual controlenabled (bool enabled)
 
bool focus ()
 
virtual bool focused () const
 
virtual drawing::font font () const
 
virtual controlfont (const drawing::font &font)
 
virtual drawing::color fore_color () const
 
virtual controlfore_color (const drawing::color &color)
 
intptr_t handle () const override
 Gets the handle to the window represented by the implementer. More...
 
virtual int32_t height () const
 
virtual controlheight (int32_t height)
 
virtual void hide ()
 
virtual void invalidate () const
 
virtual void invalidate (bool invalidate_children) const
 
virtual void invalidate (const drawing::rectangle &rect) const
 
virtual void invalidate (const drawing::rectangle &rect, bool invalidate_children) const
 
void invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
 
void invoke (delegate< void()> value)
 
bool is_handle_created () const
 
virtual int32_t left () const
 
virtual controlleft (int32_t left)
 
virtual drawing::point location () const
 
virtual controllocation (const drawing::point &location)
 
virtual const ustringname () const
 
virtual controlname (const ustring &name)
 
virtual std::optional< control_refparent () const
 
virtual controlparent (const control &parent)
 
virtual controlparent (std::nullptr_t)
 
void perform_layout ()
 Forces the control to apply layout logic to all its child controls. More...
 
xtd::drawing::point point_to_client (const xtd::drawing::point &p)
 
xtd::drawing::point point_to_screen (const xtd::drawing::point &p)
 
virtual ustring product_name () const
 
bool recreating_handle () const
 
virtual void refresh () const
 
void resume_layout ()
 Resumes usual layout logic. More...
 
void resume_layout (bool perform_layout)
 Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. More...
 
virtual int32_t right () const
 
intptr_t send_message (intptr_t hwnd, int32_t msg, intptr_t wparam, intptr_t lparam) const
 
void set_auto_size_mode (auto_size_mode auto_size_mode)
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height)
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
 
virtual void show ()
 
virtual drawing::size size () const
 
virtual controlsize (const drawing::size &size)
 
void suspend_layout ()
 Temporarily suspends the layout logic for the control. More...
 
virtual std::any tag () const
 Gets the object that contains data about the control. More...
 
virtual controltag (std::any tag)
 Sets the object that contains data about the control. More...
 
virtual const ustringtext () const
 
virtual controltext (const ustring &text)
 
virtual ustring to_string () const
 
virtual int32_t top () const
 
virtual controltop (int32_t top)
 
virtual std::optional< control_reftop_level_control () const
 
virtual void update () const
 
virtual bool visible () const
 
virtual controlvisible (bool visible)
 
virtual int32_t width () const
 
virtual controlwidth (int32_t width)
 

Public Attributes

event< check_box, event_handler< control & > > appearance_changed
 Occurs when the value of the appearance property changes. More...
 
event< check_box, event_handler< control & > > check_state_changed
 Occurs when the value of the check_state property changes. More...
 
event< check_box, event_handler< control & > > checked_changed
 Occurs when the value of the checked property changes. More...
 
- Public Attributes inherited from xtd::forms::control
event< control, event_handler< control & > > auto_size_changed
 
event< control, event_handler< control & > > back_color_changed
 
event< control, event_handler< control & > > click
 
event< control, event_handler< control & > > client_size_changed
 
event< control, control_event_handler< control & > > control_added
 
event< control, control_event_handler< control & > > control_removed
 
event< control, event_handler< control & > > cursor_changed
 
event< control, event_handler< control & > > dock_changed
 
event< control, event_handler< control & > > double_click
 
event< control, event_handler< control & > > enabled_changed
 
event< control, event_handler< control & > > font_changed
 
event< control, event_handler< control & > > fore_color_changed
 
event< control, event_handler< control & > > got_focus
 
event< control, event_handler< control & > > handle_created
 
event< control, event_handler< control & > > handle_destroyed
 
event< control, key_event_handler< control & > > key_down
 
event< control, key_press_event_handler< control & > > key_press
 
event< control, key_event_handler< control & > > key_up
 
event< control, event_handler< control & > > layout
 Occurs when a control should reposition its child controls. More...
 
event< control, event_handler< control & > > location_changed
 
event< control, event_handler< control & > > lost_focus
 
event< control, mouse_event_handler< control & > > mouse_click
 
event< control, mouse_event_handler< control & > > mouse_double_click
 
event< control, mouse_event_handler< control & > > mouse_down
 
event< control, event_handler< control & > > mouse_enter
 
event< control, mouse_event_handler< control & > > mouse_horizontal_wheel
 
event< control, event_handler< control & > > mouse_leave
 
event< control, mouse_event_handler< control & > > mouse_move
 
event< control, mouse_event_handler< control & > > mouse_up
 
event< control, mouse_event_handler< control & > > mouse_wheel
 
event< control, paint_event_handler< control & > > paint
 
event< control, event_handler< control & > > parent_changed
 
event< control, event_handler< control & > > resize
 
event< control, event_handler< control & > > size_changed
 
event< control, event_handler< control & > > text_changed
 
event< control, event_handler< control & > > visible_changed
 

Protected Member Functions

forms::create_params create_params () const override
 Gets the required creation parameters when the control handle is created. More...
 
drawing::size measure_control () const override
 Measure this control. More...
 
virtual void on_appearance_changed (const event_args &e)
 Raises the appearance_changed event. More...
 
virtual void on_check_state_changed (const event_args &e)
 Raises the check_state_changed event. More...
 
virtual void on_checked_changed (const event_args &e)
 Raises the checked_changed event. More...
 
void on_handle_created (const event_args &e) override
 Raises the handle_created event. More...
 
- Protected Member Functions inherited from xtd::forms::button_base
 button_base ()
 Initializes a new instance of the ButtonBase class. More...
 
- Protected Member Functions inherited from xtd::forms::control
virtual void def_wnd_proc (message &message)
 
bool get_style (control_styles flag) const
 Retrieves the value of the specified control style bit for the control. More...
 
drawing::size measure_text () const
 
virtual void on_auto_size_changed (const event_args &e)
 
virtual void on_back_color_changed (const event_args &e)
 
virtual void on_click (const event_args &e)
 
virtual void on_client_size_changed (const event_args &e)
 
virtual void on_control_added (const control_event_args &e)
 
virtual void on_control_removed (const control_event_args &e)
 
virtual void on_create_control ()
 
virtual void on_cursor_changed (const event_args &e)
 
virtual void on_dock_changed (const event_args &e)
 
virtual void on_double_click (const event_args &e)
 
virtual void on_enabled_changed (const event_args &e)
 
virtual void on_font_changed (const event_args &e)
 
virtual void on_fore_color_changed (const event_args &e)
 
virtual void on_got_focus (const event_args &e)
 
virtual void on_handle_destroyed (const event_args &e)
 
virtual void on_key_down (key_event_args &e)
 
virtual void on_key_press (key_press_event_args &e)
 
virtual void on_key_up (key_event_args &e)
 
virtual void on_layout (const event_args &e)
 
virtual void on_location_changed (const event_args &e)
 
virtual void on_lost_focus (const event_args &e)
 
virtual void on_mouse_click (const mouse_event_args &e)
 
virtual void on_mouse_double_click (const mouse_event_args &e)
 
virtual void on_mouse_down (const mouse_event_args &e)
 
virtual void on_mouse_enter (const event_args &e)
 
virtual void on_mouse_horizontal_wheel (const mouse_event_args &e)
 
virtual void on_mouse_leave (const event_args &e)
 
virtual void on_mouse_move (const mouse_event_args &e)
 
virtual void on_mouse_up (const mouse_event_args &e)
 
virtual void on_mouse_wheel (const mouse_event_args &e)
 
virtual void on_paint (paint_event_args &e)
 
virtual void on_parent_back_color_changed (const event_args &e)
 
virtual void on_parent_changed (const event_args &e)
 
virtual void on_parent_cursor_changed (const event_args &e)
 
virtual void on_parent_font_changed (const event_args &e)
 
virtual void on_parent_fore_color_changed (const event_args &e)
 
virtual void on_resize (const event_args &e)
 
virtual void on_size_changed (const event_args &e)
 
virtual void on_text_changed (const event_args &e)
 
virtual void on_visible_changed (const event_args &e)
 
virtual void recreate_handle ()
 
virtual void set_bounds_core (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
 Performs the work of setting the specified bounds of this control. More...
 
virtual void set_client_size_core (int32_t width, int32_t height)
 Sets the size of the client area of the control. More...
 
void set_style (control_styles flag, bool value)
 Sets a specified control_styles flag to either true or false. More...
 
virtual void wnd_proc (message &m)
 Processes Windows messages. More...
 
- Protected Member Functions inherited from xtd::forms::component
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 

Additional Inherited Members

- Public Types inherited from xtd::forms::control
using control_collection = layout::arranged_element_collection< control_ref >
 Represents a collection of controls. More...
 
- Static Public Member Functions inherited from xtd::forms::control
template<typename control_t >
static std::unique_ptr< control_t > create (const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 
template<typename control_t >
static std::unique_ptr< control_t > create (const ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 
static std::optional< control_reffrom_child_handle (intptr_t handle)
 
static std::optional< control_reffrom_handle (intptr_t handle)
 
static forms::mouse_buttons mouse_buttons ()
 

Detailed Description

Represents a Windows check_box.

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.
Example
The following code example demonstrate the use of check_box control.
#include <xtd/xtd.forms>
using namespace xtd;
using namespace xtd::forms;
namespace examples {
class form1 : public form {
public:
form1() {
text("Check box example");
controls().push_back(panel1);
panel1.parent(*this);
panel1.dock(dock_style::fill);
panel1.controls().push_back_range({check_box1, check_box2, check_box3, check_box4, check_box5});
check_box1.auto_check(false);
check_box1.click += [&](control& sender, const event_args& e) {
//check_box1.checked(!check_box1.checked());
check_box1.text(strings::format("{}", check_box1.check_state()));
};
check_box1.location({30, 30});
check_box1.text(strings::format("{}", check_box1.check_state()));
check_box2.check_state_changed += [&](control& sender, const event_args& e) {
check_box2.text(strings::format("{}", check_box2.check_state()));
};
check_box2.checked(true);
check_box2.location({30, 60});
check_box3.auto_size(true);
check_box3.check_state_changed += [this](control& sender, const event_args& e) {
check_box3.text(strings::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 += [this](control& sender, const event_args& e) {
check_box4.text(strings::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 += [&](control& sender, const event_args& e) {
//check_box5.checked(!check_box5.checked());
check_box5.text(strings::format("{}", check_box5.check_state()));
};
check_box5.location({30, 150});
check_box5.text(strings::format("{}", check_box5.check_state()));
}
private:
panel panel1;
check_box check_box1;
check_box check_box2;
check_box check_box3;
check_box check_box4;
check_box check_box5;
};
}
int main() {
application::run(examples::form1());
}

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.

Member Function Documentation

§ appearance() [1/2]

virtual forms::appearance xtd::forms::check_box::appearance ( ) const
inlinevirtual

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.

§ appearance() [2/2]

virtual check_box& xtd::forms::check_box::appearance ( forms::appearance  appearance)
virtual

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

Parameters
appearanceOne 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 bool xtd::forms::check_box::auto_check ( ) const
inlinevirtual

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.

§ auto_check() [2/2]

virtual check_box& xtd::forms::check_box::auto_check ( bool  auto_check)
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
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::check_box::check_align ( ) const
inlinevirtual

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 check_box& xtd::forms::check_box::check_align ( content_alignment  check_align)
virtual

Sets the horizontal and vertical alignment of the check mark on a check_box 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::check_box::check_state ( ) const
inlinevirtual

Gets the state of the check_box.

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

§ check_state() [2/2]

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

Sets the state of the check_box.

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

§ checked() [1/2]

virtual bool xtd::forms::check_box::checked ( ) const
inlinevirtual

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.

§ checked() [2/2]

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

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

Parameters
checkedtrue 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.

§ create_params()

forms::create_params xtd::forms::check_box::create_params ( ) const
overrideprotectedvirtual

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.

§ default_size()

drawing::size xtd::forms::check_box::default_size ( ) const
inlineoverridevirtual

Gets the default size of the control.

Returns
The default size.

Reimplemented from xtd::forms::button_base.

§ measure_control()

drawing::size xtd::forms::check_box::measure_control ( ) const
overrideprotectedvirtual

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

virtual void xtd::forms::check_box::on_appearance_changed ( const event_args e)
inlineprotectedvirtual

Raises the appearance_changed event.

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

virtual void xtd::forms::check_box::on_check_state_changed ( const event_args e)
inlineprotectedvirtual

Raises the 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::check_box::on_checked_changed ( const event_args e)
inlineprotectedvirtual

Raises the 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_handle_created()

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

Raises the handle_created event.

Parameters
eAn event_args that contains the event data.

Reimplemented from xtd::forms::control.

§ three_state() [1/2]

virtual bool xtd::forms::check_box::three_state ( ) const
inlinevirtual

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.

§ three_state() [2/2]

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

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

Parameters
three_statetrue 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.

Member Data Documentation

§ appearance_changed

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

Occurs when the value of the appearance property changes.

§ check_state_changed

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

Occurs when the value of the check_state property changes.

§ checked_changed

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

Occurs when the value of the checked property changes.


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