xtd 1.0.0
Loading...
Searching...
No Matches
xtd::forms::list_box Class Reference
Inheritance diagram for xtd::forms::list_box:
xtd::forms::list_control xtd::forms::control xtd::forms::component xtd::forms::iwin32_window xtd::icomparable< control > xtd::iequatable< control > xtd::isynchronize_invoke xtd::object xtd::interface xtd::interface xtd::extensions::comparison_operators< control, icomparable< control > > xtd::interface xtd::extensions::equality_operators< control, iequatable< control > > xtd::interface xtd::forms::checked_list_box

Definition

Represents a standard Windows list box.

Header
#include <xtd/forms/list_box>
Namespace
xtd::forms
Library
xtd.forms
Appearance
Windows macOS Gnome
Light
Dark
Examples
The following code example demonstrates the use of list_box control.
#include <xtd/xtd>
namespace list_box_example {
class form1 : public form {
public:
form1() {
text("List box example");
client_size({360, 240});
layout_panel.parent(self_);
layout_panel.controls().add_range({list_box_left, list_box_right});
layout_panel.control_layout_style(list_box_left, {size_type::auto_size, true});
layout_panel.control_layout_style(list_box_right, {size_type::auto_size, true});
layout_panel.dock(dock_style::fill);
layout_panel.padding(forms::padding(20));
list_box_left.double_click += delegate_ {
if (list_box_left.selected_index() != list_box_left.npos) {
list_box_right.items().add(list_box_left.selected_item());
list_box_right.selected_index(0);
list_box_left.items().remove_at(list_box_left.selected_index());
}
};
list_box_right.sorted(true);
list_box_right.double_click += delegate_ {
if (list_box_right.selected_index() != list_box_right.npos) {
list_box_left.items().add(list_box_right.selected_item());
list_box_left.selected_index(0);
list_box_right.items().remove_at(list_box_right.selected_index());
}
};
list_box_left.items().add_range({"draw", "cut", "paste", "delete", "open", "close", "remove", "edit", "find", "increment", "decrement", "write", "read", "post", "build", "make", "release", "create", "choose", "erase"});
list_box_left.selected_index(0);
}
private:
horizontal_layout_panel layout_panel;
list_box list_box_left;
list_box list_box_right;
};
}
auto main() -> int {
application::run(list_box_example::form1 {});
}
virtual auto client_size() const noexcept -> const xtd::drawing::size &
Gets the height and width of the client area of the control.
Represents a window or dialog box that makes up an application's user interface.
Definition form.hpp:54
auto text(const xtd::string &value) -> xtd::forms::control &override
Sets the text associated with this control.
#define self_
The self_ expression is a reference value expression whose value is the reference of the implicit obj...
Definition self.hpp:20
#define delegate_
The declaration of a delegate type is similar to a method signature. It has a return value and any nu...
Definition delegate.hpp:1018

Public Aliases

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.

Public Constructors

 list_box ()
 Initializes a new instance of the list_box class.

Public Properties

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.
virtual auto selected_indices () const noexcept -> selected_index_collection
 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 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.

Public Methods

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.

Public Static Methods

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.

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

Protetced methods

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.

Additional Inherited Members

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_handlerselected_index_changed
 Occurs when the selected_index property changes.
xtd::event< list_control, xtd::event_handlerselected_value_changed
 Occurs when the selected_value property changes.
xtd::event< control, xtd::event_handlerauto_size_changed
 Occurs when the value of the xtd::forms::control::auto_size property changes.
xtd::event< control, xtd::event_handlerback_color_changed
 Occurs when the value of the xtd::forms::control::back_color property changes.
xtd::event< control, xtd::event_handlerbackground_image_changed
 Occurs when the value of the xtd::forms::control::background_image property changes.
xtd::event< control, xtd::event_handlerbackground_image_layout_changed
 Occurs when the value of the xtd::forms::control::background_image_layout property changes.
xtd::event< control, xtd::event_handlercontrol_appearance_changed
 Occurs when the value of the xtd::forms::control::control_appearance property changes.
xtd::event< control, xtd::event_handlerclick
 Occurs when the xtd::forms::control is clicked.
xtd::event< control, xtd::event_handlerclient_size_changed
 Occurs when the value of the xtd::forms::control::client_size property changes.
xtd::event< control, xtd::event_handlercursor_changed
 Occurs when the value of the xtd::forms::control::cursor property changes.
xtd::event< control, xtd::forms::control_event_handlercontrol_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_handlercontrol_removed
 Occurs when a new xtd::forms::control:: is removed to the xtd::forms::control::control_collection.
xtd::event< control, xtd::event_handlerdock_changed
 Occurs when the value of the xtd::forms::control::dock property changes.
xtd::event< control, xtd::event_handlerdouble_click
 Occurs when the xtd::forms::control is double-clicked.
xtd::event< control, xtd::event_handlergot_focus
 Occurs when the xtd::forms::control receives focus.
xtd::event< control, xtd::event_handlerhandle_created
 Occurs when a handle is created for the xtd::forms::control.
xtd::event< control, xtd::event_handlerhandle_destroyed
 Occurs when the control's handle is in the process of being destroyed.
xtd::event< control, xtd::event_handlerenabled_changed
 Occurs when the value of the xtd::forms::control::enabled property changes.
xtd::event< control, xtd::event_handlerfore_color_changed
 Occurs when the value of the xtd::forms::control::fore_color property changes.
xtd::event< control, xtd::event_handlerfont_changed
 Occurs when the value of the xtd::forms::control::font property changes.
xtd::event< control, xtd::forms::help_event_handlerhelp_requested
 Occurs when the user requests help for a xtd::forms::control.
xtd::event< control, xtd::forms::key_event_handlerkey_down
 Occurs when a key is pressed while the xtd::forms::control has focus.
xtd::event< control, xtd::forms::key_press_event_handlerkey_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_handlerkey_up
 Occurs when a key is released while the xtd::forms::control has focus.
xtd::event< control, xtd::event_handlerlayout
 Occurs when a xtd::forms::control should reposition its child controls.
xtd::event< control, xtd::event_handlerlocation_changed
 Occurs when the value of the xtd::forms::control::location property changes.
xtd::event< control, xtd::event_handlerlost_focus
 Occurs when the xtd::forms::control loses focus.
xtd::event< control, xtd::forms::mouse_event_handlermouse_click
 Occurs when the xtd::forms::control is clicked by the mouse.
xtd::event< control, xtd::forms::mouse_event_handlermouse_double_click
 Occurs when the xtd::forms::control is double clicked by the mouse.
xtd::event< control, xtd::forms::mouse_event_handlermouse_down
 Occurs when the mouse pointer is over the xtd::forms::control and a mouse button is pressed.
xtd::event< control, xtd::event_handlermouse_enter
 Occurs when the mouse pointer enters the xtd::forms::control.
xtd::event< control, xtd::forms::mouse_event_handlermouse_horizontal_wheel
 Occurs when the mouse horizontal wheel moves while the xtd::forms::control has focus.
xtd::event< control, xtd::event_handlermouse_leave
 Occurs when the mouse pointer leaves the xtd::forms::control.
xtd::event< control, xtd::forms::mouse_event_handlermouse_move
 Occurs when the mouse pointer is moved over the xtd::forms::control.
xtd::event< control, xtd::forms::mouse_event_handlermouse_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_handlermouse_wheel
 Occurs when the mouse wheel moves while the xtd::forms::control has focus.
xtd::event< control, xtd::event_handlermove
 Occurs when the control is moved.
xtd::event< control, xtd::forms::paint_event_handlerpaint
 Occurs when the xtd::forms::control is redrawn.
xtd::event< control, xtd::event_handlerparent_changed
 Occurs when the value of the xtd::forms::control::parent property changes.
xtd::event< control, xtd::event_handlerregion_changed
 Occurs when the value of the xtd::forms::control::region property changes.
xtd::event< control, xtd::event_handlerresize
 Occurs when the xtd::forms::control is resized.
xtd::event< control, xtd::event_handlerright_to_left_changed
 Occurs when the value of the xtd::forms::control::right_to_left property changes.
xtd::event< control, xtd::event_handlersize_changed
 Occurs when the value of the xtd::forms::control::size property changes.
xtd::event< control, xtd::event_handlerstyle_sheet_changed
 Occurs when the value of the xtd::forms::control::style_sheet property changes or when xtd::application::style_sheet property changes.
xtd::event< control, xtd::event_handlersystem_colors_changed
 Occurs when the xtd::drwing::system_colors changes.
xtd::event< control, xtd::event_handlertab_stop_changed
 Occurs when the xtd::forms::control::tab_stop property value changes.
xtd::event< control, xtd::event_handlertext_changed
 Occurs when the value of the xtd::forms::control::text property changes.
xtd::event< control, xtd::event_handlervisible_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.
 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 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.
 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

◆ selected_index_collection

Represents the collection containing the indexes to the selected items in a list_box.

◆ selected_object_collection

Represents the collection of selected items in the list_box.

Constructor & Destructor Documentation

◆ list_box()

xtd::forms::list_box::list_box ( )

Initializes a new instance of the list_box class.

Member Function Documentation

◆ border_sides() [1/2]

virtual auto xtd::forms::list_box::border_sides ( ) const -> xtd::forms::border_sides
nodiscardvirtualnoexcept

Gets the border sides for the control.

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

◆ border_sides() [2/2]

virtual auto xtd::forms::list_box::border_sides ( forms::border_sides value) -> list_box &
virtual

Sets the border sides for the control.

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

◆ border_style() [1/3]

virtual auto xtd::forms::list_box::border_style ( ) const -> xtd::forms::border_style
nodiscardvirtualnoexcept

Gets the type of border that is drawn around the list_box.

Returns
One of the xtd::forms::border_styleforms::border_style values. The default is fixed_single.

◆ border_style() [2/3]

virtual auto xtd::forms::list_box::border_style ( forms::border_style value) -> list_box &
virtual

Sets the type of border that is drawn around the list_box.

Parameters
valueOne of the xtd::forms::border_styleforms::border_style values. The default is fixed_single.
Returns
Current list_box.

◆ border_style() [3/3]

virtual auto xtd::forms::list_box::border_style ( xtd::null_ptr ) -> list_box &
virtual

Resets the border style for the control.

Parameters
xtd::null.
Returns
Current label instance.
Remarks
You can use this property to add a border to the control. This property is typically used to differentiate a label that labels another control from a label that displays the status of a process in an application.

◆ items() [1/3]

auto xtd::forms::list_box::items ( ) -> object_collection &
nodiscardnoexcept

Gets the items of the list_box.

Returns
An list_box::object_collection representing the items in the list_box.
Remarks
This property enables you to obtain a reference to the list of items that are currently stored in the list_box. 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::list_box::items ( ) const -> const object_collection &
nodiscardnoexcept

Gets the items of the list_box.

Returns
An list_box::object_collection representing the items in the list_box.

◆ items() [3/3]

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

Sets the items of the list_box.

Parameters
valueAn list_box::object_collection representing the items in the list_box.
Returns
Current list_box.
Remarks
This property enables you to obtain a reference to the list of items that are currently stored in the list_box. With this reference, you can add items, remove items, and obtain a count of the items in the collection.

◆ selected_index() [1/2]

auto xtd::forms::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
valueA zero-based index of the currently selected item. A value of negative one (-1) is returned if no item is selected.
Returns
Current list_control.

Implements xtd::forms::list_control.

◆ selected_indices()

virtual auto xtd::forms::list_box::selected_indices ( ) const -> selected_index_collection
nodiscardvirtualnoexcept

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 in xtd::forms::checked_list_box.

◆ selected_item() [1/2]

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

Gets the currently selected item in the 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::list_box::selected_item ( const item & value) -> list_box &

Sets the currently selected item in the list_box.

Parameters
valueAn object that represents the current selection in the control.
Returns
Current list_box.
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::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.

◆ selection_mode() [1/2]

virtual auto xtd::forms::list_box::selection_mode ( ) const -> xtd::forms::selection_mode
nodiscardvirtualnoexcept

Gets the method in which items are selected in the list_box.

Returns
One of the selection_mode values. The default is selection_mode::one.
Remarks
The selection_mode property enables you to determine how many items in the list_box a user can select at one time and how the user can make multiple-selections. When the selection_mode property is set to selection_mode::multi_extended, pressing SHIFT and clicking the mouse or pressing SHIFT and one of the arrow keys (UP ARROW, DOWN ARROW, LEFT ARROW, and RIGHT ARROW) extends the selection from the previously selected item to the current item. Pressing CTRL and clicking the mouse selects or deselects an item in the list. When the property is set to selection_mode::multi_simple, a mouse click or pressing the SPACEBAR selects or deselects an item in the list.

◆ selection_mode() [2/2]

virtual auto xtd::forms::list_box::selection_mode ( forms::selection_mode value) -> list_box &
virtual

Sets the method in which items are selected in the list_box.

Parameters
valueOne of the selection_mode values. The default is selection_mode::one.
Returns
Current list_box.
Remarks
The selection_mode property enables you to determine how many items in the list_box a user can select at one time and how the user can make multiple-selections. When the selection_mode property is set to selection_mode::multi_extended, pressing SHIFT and clicking the mouse or pressing SHIFT and one of the arrow keys (UP ARROW, DOWN ARROW, LEFT ARROW, and RIGHT ARROW) extends the selection from the previously selected item to the current item. Pressing CTRL and clicking the mouse selects or deselects an item in the list. When the property is set to selection_mode::multi_simple, a mouse click or pressing the SPACEBAR selects or deselects an item in the list.

◆ sorted() [1/2]

virtual auto xtd::forms::list_box::sorted ( ) const -> bool
nodiscardvirtualnoexcept

Gets a value indicating whether the items in the list_box are sorted alphabetically.

Returns
true if items in the control are sorted; otherwise, false. The default is false.
Remarks
Use the sorted property to automatically sort strings alphabetically in a list_box. As items are added to a sorted list_box, the items are moved to the appropriate location in the sorted list. When adding items to a list_box, it is more efficient to sort the items first and then add new items.

◆ sorted() [2/2]

virtual auto xtd::forms::list_box::sorted ( bool value) -> list_box &
virtual

Sets a value indicating whether the items in the list_box are sorted alphabetically.

Parameters
valuetrue if items in the control are sorted; otherwise, false. The default is false.
Returns
Current list_box.
Remarks
Use the sorted property to automatically sort strings alphabetically in a list_box. As items are added to a sorted list_box, the items are moved to the appropriate location in the sorted list. When adding items to a list_box, it is more efficient to sort the items first and then add new items.

◆ text()

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

Sets the text associated with this control.

Parameters
valueThe text associated with this control.

Reimplemented from xtd::forms::control.

◆ begin_update()

auto xtd::forms::list_box::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.

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::list_box::end_update ( ) -> void

Resumes painting the 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.

◆ create() [1/24]

auto xtd::forms::list_box::create ( ) -> list_box
staticnodiscard

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

Returns
New xtd::forms::list_box created.

◆ create() [2/24]

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

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

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

◆ create() [3/24]

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

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

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

◆ create() [4/24]

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

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

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

◆ create() [5/24]

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

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

Parameters
itemsA choice::object_collection representing the items in the list_box.
Returns
New xtd::forms::list_box created.

◆ create() [6/24]

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

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

Parameters
itemsA choice::object_collection representing the items in the list_box.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [7/24]

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

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

Parameters
itemsA choice::object_collection representing the items in the list_box.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
sizeA xtd::drawing::size that represent size of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [8/24]

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

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

Parameters
itemsA choice::object_collection representing the items in the list_box.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
sizeA xtd::drawing::size that represent size of the xtd::forms::list_box.
nameThe name of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [9/24]

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

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

Parameters
itemsA choice::object_collection representing the items in the list_box.
selected_indexA zero-based index of the currently selected item. The xtd::forms::list_box::object_collection::npos is returned if no item is selected.
Returns
New xtd::forms::list_box created.

◆ create() [10/24]

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

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

Parameters
itemsA choice::object_collection representing the items in the list_box.
selected_indexA zero-based index of the currently selected item. The xtd::forms::list_box::object_collection::npos is returned if no item is selected.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [11/24]

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

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

Parameters
itemsA choice::object_collection representing the items in the list_box.
selected_indexA zero-based index of the currently selected item. The xtd::forms::list_box::object_collection::npos is returned if no item is selected.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
sizeA xtd::drawing::size that represent size of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [12/24]

auto xtd::forms::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 ) -> list_box
staticnodiscard

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

Parameters
itemsA choice::object_collection representing the items in the list_box.
selected_indexA zero-based index of the currently selected item. The xtd::forms::list_box::object_collection::npos is returned if no item is selected.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
sizeA xtd::drawing::size that represent size of the xtd::forms::list_box.
nameThe name of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [13/24]

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

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

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

◆ create() [14/24]

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

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

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

◆ create() [15/24]

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

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

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

◆ create() [16/24]

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

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

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

◆ create() [17/24]

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

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

Parameters
parentThe parent that contains the new created xtd::forms::list_box.
itemsA choice::object_collection representing the items in the list_box.
Returns
New xtd::forms::list_box created.

◆ create() [18/24]

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

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

Parameters
parentThe parent that contains the new created xtd::forms::list_box.
itemsA choice::object_collection representing the items in the list_box.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [19/24]

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

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

Parameters
parentThe parent that contains the new created xtd::forms::list_box.
itemsA choice::object_collection representing the items in the list_box.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
sizeA xtd::drawing::size that represent size of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [20/24]

auto xtd::forms::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 ) -> list_box
staticnodiscard

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

Parameters
parentThe parent that contains the new created xtd::forms::list_box.
itemsA choice::object_collection representing the items in the list_box.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
sizeA xtd::drawing::size that represent size of the xtd::forms::list_box.
nameThe name of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [21/24]

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

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

Parameters
parentThe parent that contains the new created xtd::forms::list_box.
itemsA choice::object_collection representing the items in the list_box.
selected_indexA zero-based index of the currently selected item. The xtd::forms::list_box::object_collection::npos is returned if no item is selected.
Returns
New xtd::forms::list_box created.

◆ create() [22/24]

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

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

Parameters
parentThe parent that contains the new created xtd::forms::list_box.
itemsA choice::object_collection representing the items in the list_box.
selected_indexA zero-based index of the currently selected item. The xtd::forms::list_box::object_collection::npos is returned if no item is selected.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [23/24]

auto xtd::forms::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 ) -> list_box
staticnodiscard

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

Parameters
parentThe parent that contains the new created xtd::forms::list_box.
itemsA choice::object_collection representing the items in the list_box.
selected_indexA zero-based index of the currently selected item. The xtd::forms::list_box::object_collection::npos is returned if no item is selected.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
sizeA xtd::drawing::size that represent size of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ create() [24/24]

auto xtd::forms::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 ) -> list_box
staticnodiscard

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

Parameters
parentThe parent that contains the new created xtd::forms::list_box.
itemsA choice::object_collection representing the items in the list_box.
selected_indexA zero-based index of the currently selected item. The xtd::forms::list_box::object_collection::npos is returned if no item is selected.
locationA xtd::drawing::point that represent location of the xtd::forms::list_box.
sizeA xtd::drawing::size that represent size of the xtd::forms::list_box.
nameThe name of the xtd::forms::list_box.
Returns
New xtd::forms::list_box created.

◆ allow_selection()

auto xtd::forms::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::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.

◆ default_back_color()

auto xtd::forms::list_box::default_back_color ( ) const -> xtd::drawing::color
nodiscardoverrideprotectedvirtualnoexcept

Gets the default background color of the control.

Returns
The default background color of the control. The default is control.
Remarks
This is the default back_color property value of a generic top-level control. Derived classes can have different defaults.

Reimplemented from xtd::forms::control.

◆ default_fore_color()

auto xtd::forms::list_box::default_fore_color ( ) const -> xtd::drawing::color
nodiscardoverrideprotectedvirtualnoexcept

Gets the default foreground color of the control.

Returns
The default foreground color of the control. The default is control_text.

Reimplemented from xtd::forms::control.

◆ on_handle_created()

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

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

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

Reimplemented from xtd::forms::control.

◆ on_selected_value_changed()

auto xtd::forms::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::list_box::wnd_proc ( message & m) -> void
overrideprotectedvirtual

Processes Windows messages.

Parameters
mThe Windows Message to process.
Remarks
All messages are sent to the wnd_proc method after getting filtered through the pre_process_message method.
Notes to Inheritors
Inheriting controls should call the base class's wnd_proc(message&) method to process any messages that they do not handle.

Reimplemented from xtd::forms::control.

◆ selected_index() [2/2]

virtual auto xtd::forms::list_control::selected_index ( ) const -> xtd::usize
nodiscardvirtualnoexcept

Gets the zero-based index of the currently selected item.

Returns
A zero-based index of the currently selected item. A value of negative one (-1) is returned if no item is selected.

Reimplemented from xtd::forms::list_control.


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