xtd::forms::checked_list_box Class Reference

Inheritance diagram for xtd::forms::checked_list_box:

Definition

Displays a xtd::forms::list_box in which a check box is displayed to the left of each item.

Header

#include <xtd/forms/checked_list_box>

Namespace

xtd::forms

Library

xtd.forms

Remarks

This control presents a list of items that the user can navigate by using the keyboard or the scrollbar on the right side of the control. The user can place a check mark by one or more items and the checked items can be navigated with the checked_list_box::checked_item_collection and checked_list_box::checked_index_collection.

To add objects to the list at run time, assign an array of object with the push_range method. The list then displays the default string value for each object. You can add individual items to the list with the push method.

The checked_list_box object supports three states through the check_state enumeration: checked, indeterminate, and unchecked. You must set the state of indeterminate in the code because the user interface for a checked_list_box does not provide a mechanism to do so.

If use_tab_stops is true, the checked_list_box will recognize and expand tab characters in an item's text, creating columns. These tab stops are preset and cannot be changed. To use custom tab stops, set use_tab_stops to false, set use_custom_tab_offsets to true, and add the custom values to the custom_tab_offsets collection.

Note

If the use_compatible_text_rendering property is false, the custom_tab_offsets property will be ignored and replaced with standard tab offsets.

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples

The following code example demonstrates the use of checked_list_box control.

#include <xtd/xtd>
 
namespace checked_list_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Checked list box example");
      client_size({200, 240});
      
      checked_list_box1.parent(*this);
      checked_list_box1.location({20, 20});
      checked_list_box1.size({160, 200});
      checked_list_box1.anchor(anchor_styles::top | anchor_styles::left | anchor_styles::bottom | anchor_styles::right);
      
      for (auto index = 1; index <= 10; ++index)
        checked_list_box1.items().add({string::format("Item {}", index), index % 2 != 0});
      checked_list_box1.selected_index(0);
      
      checked_list_box1.item_check += delegate_(object & sender, item_check_event_args & e) {
        cdebug << string::format("item_check, index={}, new_value={}, current_value={}", e.index(), e.new_value(), e.current_value()) << environment::new_line << std::flush;
      };
    }
    
  private:
    checked_list_box checked_list_box1;
  };
}
 
auto main() -> int {
  application::run(checked_list_box_example::form1 {});
}

Classes
class	item
	Represent an item contained in the checked_list_box::object_collection collection. More...

Public Aliases
using	object_collection
	Represents the collection of items in a checked_list_box.
using	checked_index_collection
	Encapsulates the collection of indexes of checked items (including items in an indeterminate state).
using	checked_item_collection
	Encapsulates the collection of checked items, including items in an indeterminate state, in a checked_list_box control.
using	selected_object_collection
	Represents the collection of selected items in the list_box.

Public Events
xtd::event< checked_list_box, xtd::forms::item_check_event_handler >	item_check
	Occurs when the checked state of an item changes.

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

Public Properties
auto	checked_indices () const noexcept -> checked_index_collection
	Collection of checked indexes in this checked_list_box.
auto	checked_items () const noexcept -> checked_item_collection
	Collection of checked items in this checked_list_box.
auto	items () noexcept -> object_collection &
	Gets the collection of items in this checked_list_box.
auto	items () const noexcept -> const object_collection &
	Gets the collection of items in this checked_list_box.
auto	items (const object_collection &value) -> const list_box &
	Sets the collection of items in this checked_list_box.
auto	selected_index (xtd::usize value) -> list_control &override
	When overridden in a derived class, Sets the zero-based index of the currently selected item.
auto	selected_indices () const noexcept -> selected_index_collection override
	Gets a collection that contains the zero-based indexes of all currently selected items in the list_box.
auto	selected_item () const noexcept -> const item &
	Gets the currently selected item in the checked_list_box.
auto	selected_item (const item &value) -> checked_list_box &
	Sets the currently selected item in the list_box.
auto	selected_items () const noexcept -> selected_object_collection
	Gets a collection containing the currently selected items in the list_box.
auto	text (const xtd::string &value) -> xtd::forms::control &override
	Sets the text associated with this control.

Public Methods
auto	begin_update () -> void
	Maintains performance while items are added to the checked_list_box one at a time by preventing the control from drawing until the end_update() method is called.
auto	end_update () -> void
	Resumes painting the checked_list_box control after painting is suspended by the begin_update method.
auto	get_item_checked (xtd::usize index) const -> bool
	Returns a value indicating whether the specified item is checked.
auto	get_item_check_state (xtd::usize index) const -> xtd::forms::check_state
	Returns a value indicating the check state of the current item.
auto	get_item_text (xtd::usize index) const -> const xtd::string &
	Returns the text value of the current item.
auto	set_item_checked (xtd::usize index, bool checked) -> void
	Sets check_state for the item at the specified index to checked.
auto	set_item_check_state (xtd::usize index, xtd::forms::check_state check_statecheck_state) -> void
	Sets the check state of the item at the specified index.
auto	set_item_text (xtd::usize index, const xtd::string &text) -> void
	Sets the text value of the item at the specified index.

Public Static Methods
static auto	create () -> checked_list_box
	A factory to create an xtd::forms::checked_list_box.
static auto	create (const xtd::drawing::point &location) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified location.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified location, and size.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified location, size, and name.
static auto	create (const object_collection &items) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified items.
static auto	create (const object_collection &items, const xtd::drawing::point &location) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified items, and location.
static auto	create (const object_collection &items, const xtd::drawing::point &location, const xtd::drawing::size &size) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified items, location, and size.
static auto	create (const object_collection &items, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified items, location, size, and name.
static auto	create (const object_collection &items, xtd::usize selected_index) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified items, and selected_index.
static auto	create (const object_collection &items, xtd::usize selected_index, const xtd::drawing::point &location) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified items, selected_index, and location.
static auto	create (const object_collection &items, xtd::usize selected_index, const xtd::drawing::point &location, const xtd::drawing::size &size) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified items, selected_index, location, and size.
static auto	create (const object_collection &items, xtd::usize selected_index, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified items, selected_index, location, size, and name.
static auto	create (const xtd::forms::control &parent) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent.
static auto	create (const xtd::forms::control &parent, const xtd::drawing::point &location) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, and location.
static auto	create (const xtd::forms::control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, location, and size.
static auto	create (const xtd::forms::control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, location, size, and name.
static auto	create (const xtd::forms::control &parent, const object_collection &items) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, and items.
static auto	create (const xtd::forms::control &parent, const object_collection &items, const xtd::drawing::point &location) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, items, and location.
static auto	create (const xtd::forms::control &parent, const object_collection &items, const xtd::drawing::point &location, const xtd::drawing::size &size) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, items, location, and size.
static auto	create (const xtd::forms::control &parent, const object_collection &items, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, items, location, size, and name.
static auto	create (const xtd::forms::control &parent, const object_collection &items, xtd::usize selected_index) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, items, and selected_index.
static auto	create (const xtd::forms::control &parent, const object_collection &items, xtd::usize selected_index, const xtd::drawing::point &location) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, items, selected_index, and location.
static auto	create (const xtd::forms::control &parent, const object_collection &items, xtd::usize selected_index, const xtd::drawing::point &location, const xtd::drawing::size &size) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, items, selected_index, location, and size.
static auto	create (const xtd::forms::control &parent, const object_collection &items, xtd::usize selected_index, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> checked_list_box
	A factory to create an xtd::forms::checked_list_box with specified parent, items, selected_index, location, size, and name.

Protected Properties
auto	allow_selection () const noexcept -> bool override
	Gets a value indicating whether the list enables selection of list items.
auto	create_params () const noexcept -> xtd::forms::create_params override
	Gets the required creation parameters when the control handle is created.

Protected Methods
auto	on_handle_created (const event_args &e) -> void override
	Raises the xtd::forms::control::handle_created event.
virtual auto	on_item_check (item_check_event_args &e) -> void
	Raises the checked_list_box::item_check event.
auto	on_selected_value_changed (const event_args &e) -> void override
	Raises the list_control::selected_value_changed event.
auto	wnd_proc (message &message) -> void override
	Processes Windows messages.

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

Member Typedef Documentation

object_collection

using xtd::forms::checked_list_box::object_collection

Represents the collection of items in a checked_list_box.

checked_index_collection

using xtd::forms::checked_list_box::checked_index_collection

Encapsulates the collection of indexes of checked items (including items in an indeterminate state).

checked_item_collection

using xtd::forms::checked_list_box::checked_item_collection

Encapsulates the collection of checked items, including items in an indeterminate state, in a checked_list_box control.

selected_object_collection

using xtd::forms::checked_list_box::selected_object_collection

Represents the collection of selected items in the list_box.

Constructor & Destructor Documentation

checked_list_box()

xtd::forms::checked_list_box::checked_list_box

(

)

Initializes a new instance of the checked_list_box class.

Remarks

By default, checked_list_box uses set_style and the resize_redraw value of control_styles to specify that the control is redrawn when resized.

Member Function Documentation

checked_indices()

auto xtd::forms::checked_list_box::checked_indices ( ) const -> checked_index_collection

nodiscardnoexcept

Collection of checked indexes in this checked_list_box.

Returns

The checked_list_box::checked_index_collection collection for the checked_list_box.

Remarks

The collection of checked indexes is a subset of the indexes into the collection of all items in the checked_list_box control. These indexes specify items in a checked or indeterminate state.

checked_items()

auto xtd::forms::checked_list_box::checked_items ( ) const -> checked_item_collection

nodiscardnoexcept

Collection of checked items in this checked_list_box.

Returns

The checked_list_box::checked_item_collection collection for the checked_list_box.

Remarks

The collection is a subset of the objects in the items collection, representing only those items whose xtd::forms::check_state is checked or indeterminate. The indexes in this collection are in ascending order.

items() [1/3]

auto xtd::forms::checked_list_box::items ( ) -> object_collection &

nodiscardnoexcept

Gets the collection of items in this checked_list_box.

Returns

The checked_list_box::object_collection collection representing the items in the checked_list_box.

Remarks

The items property enables you to obtain a reference to the list of items that are currently stored in a checked_list_box control. With this reference, you can add items, remove items, and obtain a count of the items in the collection.

items() [2/3]

auto xtd::forms::checked_list_box::items ( ) const -> const object_collection &

nodiscardnoexcept

Gets the collection of items in this checked_list_box.

Returns

The checked_list_box::object_collection collection representing the items in the checked_list_box.

Remarks

The items property enables you to obtain a reference to the list of items that are currently stored in a checked_list_box control. With this reference, you can add items, remove items, and obtain a count of the items in the collection.

items() [3/3]

auto xtd::forms::checked_list_box::items

(

const object_collection &

value

)

-> const list_box &

Sets the collection of items in this checked_list_box.

Parameters

value

The checked_list_box::object_collection collection representing the items in the checked_list_box.

selected_index()

auto xtd::forms::checked_list_box::selected_index ( xtd::usize value ) -> list_control &override

overridevirtual

When overridden in a derived class, Sets the zero-based index of the currently selected item.

Parameters

value

A zero-based index of the currently selected item. The xtd::forms::checked_list_box::object_collection::npos is returned if no item is selected.

Returns

Current list_control.

Implements xtd::forms::list_control.

selected_indices()

auto xtd::forms::checked_list_box::selected_indices ( ) const -> selected_index_collection

nodiscardoverridevirtualnoexcept

Gets a collection that contains the zero-based indexes of all currently selected items in the list_box.

A list_box.selected_index_collection containing the indexes of the currently selected items in the control. If no items are currently selected, an empty ListBox.SelectedIndexCollection is returned.

Remarks

For a multiple-selection list_box, this property returns a collection containing the indexes to all items that are selected in the list_box. For a single-selection ListBox, this property returns a collection containing a single element containing the index of the only selected item in the list_box. For more information about how to manipulate the items of the collection, see list_box::selected_index_collection.

The list_box class provides a number of ways to reference selected items. Instead of using the selected_indices property to obtain the index position of the currently selected item in a single-selection list_box, you can use the selected_index property. If you want to obtain the item that is currently selected in the list_box, instead of the index position of the item, use the selected_item property. In addition, you can use the selected_items property if you want to obtain all the selected items in a multiple-selection list_box.

Reimplemented from xtd::forms::list_box.

selected_item() [1/2]

auto xtd::forms::checked_list_box::selected_item ( ) const -> const item &

nodiscardnoexcept

Gets the currently selected item in the checked_list_box.

Returns

An object that represents the current selection in the control.

Remarks

For a standard list_box, you can use this property to determine which item is selected in the list_box. If the selection_mode property of the list_box is set to either selection_mode::multi_simple or selection_mode::multi_extended (which indicates a multiple-selection list_box) and multiple items are selected in the list, this property can return any selected item.

To retrieve a collection containing all selected items in a multiple-selection list_box, use the selected_items property. If you want to obtain the index position of the currently selected item in the list_box, use the selected_index property. In addition, you can use the selected_indices property to obtain all the selected indexes in a multiple-selection list_box.

selected_item() [2/2]

auto xtd::forms::checked_list_box::selected_item

(

const item &

value

)

-> checked_list_box &

Sets the currently selected item in the list_box.

Parameters

value

An object that represents the current selection in the control.

Remarks

For a standard list_box, you can use this property to determine which item is selected in the list_box. If the selection_mode property of the list_box is set to either selection_mode::multi_simple or selection_mode::multi_extended (which indicates a multiple-selection list_box) and multiple items are selected in the list, this property can return any selected item.

To retrieve a collection containing all selected items in a multiple-selection list_box, use the selected_items property. If you want to obtain the index position of the currently selected item in the list_box, use the selected_index property. In addition, you can use the selected_indices property to obtain all the selected indexes in a multiple-selection list_box.

selected_items()

auto xtd::forms::checked_list_box::selected_items ( ) const -> selected_object_collection

nodiscardnoexcept

Gets a collection containing the currently selected items in the list_box.

Returns

A list_box::selected_object_collection containing the currently selected items in the control.

Remarks

For a multiple-selection list_box, this property returns a collection containing all items that are selected in the list_box. For a single-selection list_box, this property returns a collection containing a single element containing the only selected item in the list_box. For more information about how to manipulate the items of the collection, see list_box::selected_object_collection.

The list_box class provides a number of ways to reference selected items. Instead of using the selected_items property to obtain the currently selected item in a single-selection list_box, you can use the selected_item property. If you want to obtain the index position of an item that is currently selected in the list_box, instead of the item itself, use the selected_index property. In addition, you can use the selected_indices property if you want to obtain the index positions of all selected items in a multiple-selection list_box.

text()

auto xtd::forms::checked_list_box::text ( const xtd::string & value ) -> xtd::forms::control &override

overridevirtual

Sets the text associated with this control.

Parameters

value

The text associated with this control.

Reimplemented from xtd::forms::control.

begin_update()

auto xtd::forms::checked_list_box::begin_update

(

)

-> void

Maintains performance while items are added to the checked_list_box one at a time by preventing the control from drawing until the end_update() method is called.

Remarks

The preferred way to add multiple items to the list_box is to use the push_back_range method of the list_box::object_collection class (through the items property of the list_box). This enables you to add an array of items to the list in a single operation. However, if you want to add items one at a time using the Add method of the list_box::object_collection class, you can use the begin_update method to prevent the control from repainting the list_box each time an item is added to the list. Once you have completed the task of adding items to the list, call the end_update method to enable the list_box to repaint. This way of adding items can prevent flickered drawing of the list_box when a large number of items are being added to the list.

end_update()

auto xtd::forms::checked_list_box::end_update

(

)

-> void

Resumes painting the checked_list_box control after painting is suspended by the begin_update method.

Remarks

The preferred way to add multiple items to the list_box is to use the push_back_range method of the list_box::object_collection class (through the items property of the list_box). This enables you to add an array of items to the list in a single operation. However, if you want to add items one at a time using the Add method of the list_box::object_collection class, you can use the begin_update method to prevent the control from repainting the list_box each time an item is added to the list. Once you have completed the task of adding items to the list, call the end_update method to enable the list_box to repaint. This way of adding items can prevent flickered drawing of the list_box when a large number of items are being added to the list.

get_item_checked()

auto xtd::forms::checked_list_box::get_item_checked ( xtd::usize index ) const -> bool

nodiscard

Returns a value indicating whether the specified item is checked.

Parameters

index

The index of the item.

Returns

true if the item is checked; otherwise, false.

Remarks

get_item_checked returns true if the value of CheckState is checked or indeterminate for the item. To determine the specific state the item is in, use the get_item_check_state method.

get_item_check_state()

auto xtd::forms::checked_list_box::get_item_check_state ( xtd::usize index ) const -> xtd::forms::check_state

nodiscard

Returns a value indicating the check state of the current item.

Parameters

index

The index of the item.

Returns

One of the check_state values.

Remarks

The get_item_check_state method provides the ability to get the check_state value of an item, given the index. If you never set the check state of an item to indeterminate, then use the getItem_checked method.

get_item_text()

auto xtd::forms::checked_list_box::get_item_text ( xtd::usize index ) const -> const xtd::string &

nodiscard

Returns the text value of the current item.

Parameters

index

The index of the item.

Returns

A string that represent the text value of the current item.

set_item_checked()

auto xtd::forms::checked_list_box::set_item_checked	(	xtd::usize	index,
		bool	checked ) -> void

Sets check_state for the item at the specified index to checked.

Parameters

index	The index of the item to set the check state for.
checked	true to set the item as checked; otherwise, false.

Remarks

When a value of true is passed, this method sets the check_state value to checked. A value of false sets check_state to unchecked.

set_item_check_state()

auto xtd::forms::checked_list_box::set_item_check_state	(	xtd::usize	index,
		xtd::forms::check_state	check_state ) -> void

Sets the check state of the item at the specified index.

Parameters

index	The index of the item to set the check state for.
check_state	One of the check_state values.

Remarks

The set_item_check_state method raises the item_check event.

Items whose check_state is set to indeterminate appear with a check mark in the check box, but the box is grayed to indicate the indeterminate status of the checked item.

set_item_text()

auto xtd::forms::checked_list_box::set_item_text	(	xtd::usize	index,
		const xtd::string &	text ) -> void

Sets the text value of the item at the specified index.

Parameters

index	The index of the item to set the check state for.
text	A string that represent the text value.

create() [1/24]

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

staticnodiscard

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

Returns

New xtd::forms::checked_list_box created.

create() [2/24]

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

staticnodiscard

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

Parameters

location

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

Returns

New xtd::forms::checked_list_box created.

create() [3/24]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::checked_list_box created.

create() [4/24]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::checked_list_box created.

create() [5/24]

auto xtd::forms::checked_list_box::create ( const object_collection & items ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified items.

Parameters

items

The checked_list_box::object_collection collection representing the items in the checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [6/24]

auto xtd::forms::checked_list_box::create ( const object_collection & items, const xtd::drawing::point & location ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified items, and location.

Parameters

items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [7/24]

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

staticnodiscard

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

Parameters

items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.
size	A xtd::drawing::size that represent size of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [8/24]

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

staticnodiscard

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

Parameters

items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.
size	A xtd::drawing::size that represent size of the xtd::forms::checked_list_box.
name	The name of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [9/24]

auto xtd::forms::checked_list_box::create ( const object_collection & items, xtd::usize selected_index ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified items, and selected_index.

Parameters

items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
selected_index	A zero-based index of the currently selected item. The xtd::forms::checked_list_box::object_collection::npos is returned if no item is selected.

Returns

New xtd::forms::checked_list_box created.

create() [10/24]

auto xtd::forms::checked_list_box::create ( const object_collection & items, xtd::usize selected_index, const xtd::drawing::point & location ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified items, selected_index, and location.

Parameters

items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
selected_index	A zero-based index of the currently selected item. The xtd::forms::checked_list_box::object_collection::npos is returned if no item is selected.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [11/24]

auto xtd::forms::checked_list_box::create ( const object_collection & items, xtd::usize selected_index, const xtd::drawing::point & location, const xtd::drawing::size & size ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified items, selected_index, location, and size.

Parameters

items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
selected_index	A zero-based index of the currently selected item. The xtd::forms::checked_list_box::object_collection::npos is returned if no item is selected.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.
size	A xtd::drawing::size that represent size of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [12/24]

auto xtd::forms::checked_list_box::create ( const object_collection & items, xtd::usize selected_index, const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> checked_list_box

staticnodiscard

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

Parameters

items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
selected_index	A zero-based index of the currently selected item. The xtd::forms::checked_list_box::object_collection::npos is returned if no item is selected.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.
size	A xtd::drawing::size that represent size of the xtd::forms::checked_list_box.
name	The name of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [13/24]

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

staticnodiscard

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

Parameters

parent

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

Returns

New xtd::forms::checked_list_box created.

create() [14/24]

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

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified parent, and location.

Parameters

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

Returns

New xtd::forms::checked_list_box created.

create() [15/24]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::checked_list_box created.

create() [16/24]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::checked_list_box created.

create() [17/24]

auto xtd::forms::checked_list_box::create ( const xtd::forms::control & parent, const object_collection & items ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified parent, and items.

Parameters

parent	The parent that contains the new created xtd::forms::checked_list_box.
items	The checked_list_box::object_collection collection representing the items in the checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [18/24]

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

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified parent, items, and location.

Parameters

parent	The parent that contains the new created xtd::forms::checked_list_box.
items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [19/24]

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

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified parent, items, location, and size.

Parameters

parent	The parent that contains the new created xtd::forms::checked_list_box.
items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.
size	A xtd::drawing::size that represent size of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [20/24]

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

staticnodiscard

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

Parameters

parent	The parent that contains the new created xtd::forms::checked_list_box.
items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.
size	A xtd::drawing::size that represent size of the xtd::forms::checked_list_box.
name	The name of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [21/24]

auto xtd::forms::checked_list_box::create ( const xtd::forms::control & parent, const object_collection & items, xtd::usize selected_index ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified parent, items, and selected_index.

Parameters

parent	The parent that contains the new created xtd::forms::checked_list_box.
items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
selected_index	A zero-based index of the currently selected item. The xtd::forms::checked_list_box::object_collection::npos is returned if no item is selected.

Returns

New xtd::forms::checked_list_box created.

create() [22/24]

auto xtd::forms::checked_list_box::create ( const xtd::forms::control & parent, const object_collection & items, xtd::usize selected_index, const xtd::drawing::point & location ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified parent, items, selected_index, and location.

Parameters

parent	The parent that contains the new created xtd::forms::checked_list_box.
items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
selected_index	A zero-based index of the currently selected item. The xtd::forms::checked_list_box::object_collection::npos is returned if no item is selected.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [23/24]

auto xtd::forms::checked_list_box::create ( const xtd::forms::control & parent, const object_collection & items, xtd::usize selected_index, const xtd::drawing::point & location, const xtd::drawing::size & size ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified parent, items, selected_index, location, and size.

Parameters

parent	The parent that contains the new created xtd::forms::checked_list_box.
items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
selected_index	A zero-based index of the currently selected item. The xtd::forms::checked_list_box::object_collection::npos is returned if no item is selected.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.
size	A xtd::drawing::size that represent size of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

create() [24/24]

auto xtd::forms::checked_list_box::create ( const xtd::forms::control & parent, const object_collection & items, xtd::usize selected_index, const xtd::drawing::point & location, const xtd::drawing::size & size, const xtd::string & name ) -> checked_list_box

staticnodiscard

A factory to create an xtd::forms::checked_list_box with specified parent, items, selected_index, location, size, and name.

Parameters

parent	The parent that contains the new created xtd::forms::checked_list_box.
items	The checked_list_box::object_collection collection representing the items in the checked_list_box.
selected_index	A zero-based index of the currently selected item. The xtd::forms::checked_list_box::object_collection::npos is returned if no item is selected.
location	A xtd::drawing::point that represent location of the xtd::forms::checked_list_box.
size	A xtd::drawing::size that represent size of the xtd::forms::checked_list_box.
name	The name of the xtd::forms::checked_list_box.

Returns

New xtd::forms::checked_list_box created.

allow_selection()

auto xtd::forms::checked_list_box::allow_selection ( ) const -> bool

nodiscardoverrideprotectedvirtualnoexcept

Gets a value indicating whether the list enables selection of list items.

Returns

true if the list enables list item selection; otherwise, false. The default is true.

Reimplemented from xtd::forms::list_control.

create_params()

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

nodiscardoverrideprotectedvirtualnoexcept

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

Returns

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

Remarks

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

Notes for inheritors

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

Reimplemented from xtd::forms::control.

on_handle_created()

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

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

on_item_check()

virtual auto xtd::forms::checked_list_box::on_item_check ( item_check_event_args & e ) -> void

protectedvirtual

Raises the checked_list_box::item_check event.

Parameters

e	An item_check_event_args that contains the event data.

on_selected_value_changed()

auto xtd::forms::checked_list_box::on_selected_value_changed ( const event_args & e ) -> void

overrideprotectedvirtual

Raises the list_control::selected_value_changed event.

Reimplemented from xtd::forms::list_control.

wnd_proc()

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

overrideprotectedvirtual

Processes Windows messages.

Parameters

m	The Windows Message to process.

Remarks

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

Notes to Inheritors

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

Reimplemented from xtd::forms::control.

Member Data Documentation

item_check

xtd::event<checked_list_box, xtd::forms::item_check_event_handler> xtd::forms::checked_list_box::item_check

Occurs when the checked state of an item changes.

Remarks

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

---

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

• xtd.forms/include/xtd/forms/checked_list_box.hpp