xtd::forms::label Class Reference

Inheritance diagram for xtd::forms::label:

Definition

Represents a standard Windows label.

Header

#include <xtd/forms/label>

Namespace

xtd::forms

Library

xtd.forms

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples

The following code example demonstrates the use of label control.

#include <xtd/xtd>
 
namespace label_example {
  class form1 : public form {
  public:
    form1() {
      text("Label example");
      client_size({390, 360});
      
      label1.parent(*this);
      label1.text("Lorem ipsum");
      label1.location({10, 50});
      
      label2.parent(*this);
      label2.auto_size(true);
      label2.text("Lorem ipsum dolor sit amet, consectetur adipiscing elit.");
      label2.location({10, 100});
      
      label3.parent(*this);
      label3.auto_ellipsis(true);
      label3.text("Lorem ipsum dolor sit amet, consectetur adipiscing elit.");
      label3.location({10, 150});
      
      label4.parent(*this);
      label4.text("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non risus.Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor.Cras elementum ultrices diam. Maecenas ligula massa, varius a, semper congue, euismod non, mi. Proin porttitor, orci nec nonummy molestie, enim est eleifend mi, non fermentum diam nisl sit amet erat. Duis semper. Duis arcu massa, scelerisque vitae, consequat in, pretium a, enim.Pellentesque congue. Ut in risus volutpat libero pharetra tempor.Cras vestibulum bibendum augue. Praesent egestas leo in pede.Praesent blandit odio eu enim.Pellentesque sed dui ut augue blandit sodales.Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Aliquam nibh. Mauris ac mauris sed pede pellentesque fermentum.Maecenas adipiscing ante non diam sodales hendrerit.\n\nUt velit mauris, egestas sed, gravida nec, ornare ut, mi. Aenean ut orci vel massa suscipit pulvinar.Nulla sollicitudin. Fusce varius, ligula non tempus aliquam, nunc turpis ullamcorper nibh, in tempus sapien eros vitae ligula.Pellentesque rhoncus nunc et augue.Integer id felis.Curabitur aliquet pellentesque diam. Integer quis metus vitae elit lobortis egestas.Lorem ipsum dolor sit amet, consectetuer adipiscing elit.Morbi vel erat non mauris convallis vehicula.Nulla et sapien.Integer tortor tellus, aliquam faucibus, convallis id, congue eu, quam. Mauris ullamcorper felis vitae erat.Proin feugiat, augue non elementum posuere, metus purus iaculis lectus, et tristique ligula justo vitae magna.\n\nAliquam convallis sollicitudin purus. Praesent aliquam, enim at fermentum mollis, ligula massa adipiscing nisl, ac euismod nibh nisl eu lectus.Fusce vulputate sem at sapien.Vivamus leo. Aliquam euismod libero eu enim.Nulla nec felis sed leo placerat imperdiet.Aenean suscipit nulla in justo.Suspendisse cursus rutrum augue. Nulla tincidunt tincidunt mi. Curabitur iaculis, lorem vel rhoncus faucibus, felis magna fermentum augue, et ultricies lacus lorem varius purus.Curabitur eu amet.\n");
      label4.location({10, 200});
      label4.size({350, 150});
      label4.anchor(anchor_styles::all);
      label4.text_align(xtd::forms::content_alignment::top_center);
    }
    
  private:
    label label1;
    label label2;
    label label3;
    label label4;
  };
}
 
auto main() -> int {
  application::run(label_example::form1 {});
}

Examples

The following code example demonstrates the use of label control.

#include <xtd/xtd>
 
namespace hello_world_label_example {
  class main_form : public form {
  public:
    main_form() {
      text("Hello world (label)");
      controls().add(label1);
      
      label1.dock(dock_style::fill);
      label1.font({label1.font(), 32, font_style::bold | font_style::italic});
      label1.fore_color(color::green);
      label1.shadow(true);
      label1.text("Hello, World!");
      label1.text_align(content_alignment::middle_center);
    }
    
  private:
    label label1;
  };
}
 
auto main() -> int {
  application::run(hello_world_label_example::main_form {});
}

Examples

tutorial_communicate.cpp.

Public Events
xtd::event< label, xtd::event_handler >	image_changed
	Occurs when the value of the image property changes.
xtd::event< label, xtd::event_handler >	text_align_changed
	Occurs when the value of the xtd::forms::label::text_align property has changed.

Public Constructors
	label ()
	Initialize a new instance of label class.

Public Properties
virtual auto	auto_ellipsis () const noexcept -> bool
	Gets a value indicating whether the ellipsis character (...) appears at the right edge of the xtd::forms::label, denoting that the xtd::forms::label text extends beyond the specified length of the xtd::forms::label.
virtual auto	auto_ellipsis (bool value) -> label &
	Sets a value indicating whether the ellipsis character (...) appears at the right edge of the xtd::forms::label, denoting that the xtd::forms::label text extends beyond the specified length of the xtd::forms::label.
virtual auto	border_sides () const noexcept -> xtd::forms::border_sides
	Gets the border sides for the control.
virtual auto	border_sides (xtd::forms::border_sides value) -> label &
	Sets the border sides for the control.
virtual auto	border_style () const noexcept -> xtd::forms::border_style
	Gets the border style for the control.
virtual auto	border_style (xtd::forms::border_style value) -> label &
	Sets the border style for the control.
virtual auto	border_style (xtd::null_ptr) -> label &
	Resets the border style for the control.
auto	control_appearance (xtd::forms::control_appearance value) -> xtd::forms::control &override
	Sets control appearance.
virtual auto	flat_style () const noexcept -> xtd::forms::flat_style
	Gets the flat style appearance of the label control.
virtual auto	flat_style (xtd::forms::flat_style value) -> label &
	Sets the flat style appearance of the label control.
virtual auto	image () const noexcept -> const xtd::drawing::image &
	Gets the image that is displayed on a label control.
virtual auto	image (const xtd::drawing::image &value) -> label &
	Sets the image that is displayed on a label control.
virtual auto	image_align () const noexcept -> xtd::forms::content_alignment
	Gets the alignment of the image on the label control.
virtual auto	image_align (xtd::forms::content_alignment value) -> label &
	Gets the alignment of the image on the label control.
virtual auto	image_index () const noexcept -> xtd::int32
	Gets the image list index value of the image displayed on the label control.
virtual auto	image_index (xtd::int32 value) -> label &
	Sets the image list index value of the image displayed on the label control.
virtual auto	image_list () const noexcept -> const xtd::forms::image_list &
	Gets the image_list that contains the image displayed on a label control.
virtual auto	image_list () noexcept -> xtd::forms::image_list &
	Gets the image_list that contains the image displayed on a label control.
virtual auto	image_list (const xtd::forms::image_list &value) -> label &
	Sets the image_list that contains the image displayed on a label control.
virtual auto	shadow () const noexcept -> bool
	Gets a value that allows to draw a drop shadow under the text.
virtual auto	shadow (bool value) -> label &
	Sets a value that allows to draw a drop shadow under the text.
virtual auto	shadows () const noexcept -> const xtd::forms::shadows &
	Gets an xtd::forms::shadow array used to draw shadows under the text.
virtual auto	shadows (const xtd::forms::shadows &value) -> label &
	Sets an xtd::forms::shadow array used to draw shadows under the text.
virtual auto	text_align () const noexcept -> xtd::forms::content_alignment
	Gets the alignment of the text on the label control.
virtual auto	text_align (xtd::forms::content_alignment value) -> label &
	Gets the alignment of the text on the label control.
virtual auto	control_appearance () const noexcept -> xtd::forms::control_appearance
	Gets control appearance.

Public Static Methods
static auto	create () -> label
	A factory to create an xtd::forms::label.
static auto	create (const xtd::drawing::point &location) -> label
	A factory to create an xtd::forms::label with specified location.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size) -> label
	A factory to create an xtd::forms::label with specified location, and size.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> label
	A factory to create an xtd::forms::label with specified location, size, and name.
static auto	create (const xtd::string &text) -> label
	A factory to create an xtd::forms::label with specified text.
static auto	create (const xtd::string &text, const xtd::drawing::point &location) -> label
	A factory to create an xtd::forms::label with specified text, and location.
static auto	create (const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size) -> label
	A factory to create an xtd::forms::label with specified text, location, and size.
static auto	create (const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> label
	A factory to create an xtd::forms::label with specified text, location, size, and name.
static auto	create (const xtd::forms::control &parent) -> label
	A factory to create an xtd::forms::label with specified parent,.
static auto	create (const xtd::forms::control &parent, const xtd::drawing::point &location) -> label
	A factory to create an xtd::forms::label with specified parent, location.
static auto	create (const xtd::forms::control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size) -> label
	A factory to create an xtd::forms::label 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) -> label
	A factory to create an xtd::forms::label with specified parent, location, size, and name.
static auto	create (const xtd::forms::control &parent, const xtd::string &text) -> label
	A factory to create an xtd::forms::label with specified parent, and text.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, const xtd::drawing::point &location) -> label
	A factory to create an xtd::forms::label with specified parent, text, and location.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size) -> label
	A factory to create an xtd::forms::label with specified parent, text, location, and size.
static auto	create (const xtd::forms::control &parent, const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> label
	A factory to create an xtd::forms::label with specified parent, text, location, size, and name.

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

Protected Methods
auto	measure_control () const noexcept -> xtd::drawing::size override
	Measure this control.
auto	on_font_changed (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::font_changed event.
virtual auto	on_image_changed (const xtd::event_args &e) -> void
	Raises the image_changed event.
auto	on_paint (xtd::forms::paint_event_args &e) -> void override
	Raises the xtd::forms::control::paint event.
auto	on_resize (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::region event.
virtual auto	on_text_align_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::label::text_align_changed event.
auto	on_text_changed (const xtd::event_args &e) -> void override
	Raises the xtd::forms::control::text_changed event.

Additional Inherited Members
using	context_menu_ref
	Represent an xtd::forms::context_menu reference.
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.
	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	controls () noexcept -> control_collection &
	Gets the collection of controls contained within the control.
virtual auto	controls () const noexcept -> const control_collection &
	Gets the collection of controls contained within the control.
virtual auto	created () const noexcept -> bool
	Gets a value indicating whether the control has been created.
virtual auto	cursor () const noexcept -> xtd::forms::cursor
	Gets the cursor that is displayed when the mouse pointer is over the control.
virtual auto	cursor (const xtd::forms::cursor &value) -> control &
	Sets the cursor that is displayed when the mouse pointer is over the control.
virtual auto	cursor (xtd::null_ptr) -> control &
	Resets the cursor that is displayed when the mouse pointer is over the control.
virtual auto	display_rectangle () const noexcept -> xtd::drawing::rectangle
	Gets the rectangle that represents the display area of the control.
virtual auto	dock () const noexcept -> xtd::forms::dock_style
	Gets which control borders are docked to its parent control and determines how a control is resized with its parent.
virtual auto	dock (xtd::forms::dock_style value) -> control &
	Sets which control borders are docked to its parent control and determines how a control is resized with its parent.
virtual auto	double_buffered () const noexcept -> bool
	Gets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
virtual auto	double_buffered (bool value) -> control &
	Sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
virtual auto	enabled () const noexcept -> bool
	Gets a value indicating whether the control can respond to user interaction.
virtual auto	enabled (bool value) -> control &
	Sets a value indicating whether the control can respond to user interaction.
virtual auto	focused () const noexcept -> bool
	Gets a value indicating whether the control has input focus.
virtual auto	font () const noexcept -> xtd::drawing::font
	Gets the font of the text displayed by the control.
virtual auto	font (const xtd::drawing::font &value) -> control &
	Sets the font of the text displayed by the control.
virtual auto	font (xtd::null_ptr) -> control &
	Resets the font of the text displayed by the control.
virtual auto	fore_color () const noexcept -> xtd::drawing::color
	Gets the foreground color of the control.
virtual auto	fore_color (const xtd::drawing::color &value) -> control &
	Sets the foreground color of the control.
virtual auto	fore_color (xtd::null_ptr) -> control &
	Resets the foreground color of the control.
auto	handle () const -> xtd::intptr override
	Gets the window handle that the control is bound to.
virtual auto	height () const noexcept -> xtd::int32
	Gets the height of the control.
virtual auto	height (xtd::int32 value) -> control &
	Sets the height of the control.
auto	invoke_required () const noexcept -> bool override
	Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on.
auto	is_handle_created () const noexcept -> bool
	Gets a value indicating whether the control has a handle associated with it.
virtual auto	left () const noexcept -> xtd::int32
	Gets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual auto	left (xtd::int32 value) -> control &
	Sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual auto	location () const noexcept -> xtd::drawing::point
	Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
virtual auto	location (const xtd::drawing::point &value) -> control &
	Sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
virtual auto	margin () const noexcept -> xtd::forms::padding
	Gets the space between controls.
virtual auto	margin (const xtd::forms::padding &value) -> control &
	Sets the space between controls.
virtual auto	maximum_client_size () const noexcept -> const xtd::drawing::size &
	Gets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	maximum_client_size (const xtd::drawing::size &size) -> control &
	Sets the client size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	maximum_size () const noexcept -> const xtd::drawing::size &
	Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	maximum_size (const xtd::drawing::size &value) -> control &
	Sets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	minimum_client_size () const noexcept -> const xtd::drawing::size &
	Gets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	minimum_client_size (const xtd::drawing::size &value) -> control &
	Sets the client size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	minimum_size () const noexcept -> const xtd::drawing::size &
	Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual auto	minimum_size (const xtd::drawing::size &value) -> control &
	Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
auto	native_handle () const noexcept -> xtd::intptr
	Gets the native handle that the control is bound to.
virtual auto	name () const noexcept -> const xtd::string &
	Gets the name of the control.
virtual auto	name (const xtd::string &value) -> control &
	Sets the name of the control.
virtual auto	padding () const noexcept -> xtd::forms::padding
	Gets padding within the control.
virtual auto	padding (const xtd::forms::padding &value) -> control &
	Sets padding within the control.
virtual auto	parent () const noexcept -> std::optional< xtd::forms::control_ref >
	Gets the parent container of the control.
virtual auto	parent (const control &value) -> control &
	Sets the parent container of the control.
virtual auto	parent (xtd::null_ptr) -> control &
	Resets the parent container of the control.
virtual auto	product_name () const noexcept -> xtd::string
	Gets the product name of the assembly containing the control.
auto	recreating_handle () const noexcept -> bool
	Gets a value indicating whether the control is currently re-creating its handle.
virtual auto	region () const noexcept -> const xtd::drawing::region &
	Gets the window region associated with the control.
virtual auto	region (const xtd::drawing::region &value) -> control &
	Sets the window region associated with the control.
virtual auto	right () const noexcept -> xtd::int32
	Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
virtual auto	right_to_left () const noexcept -> xtd::forms::right_to_left
	Gets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
virtual auto	right_to_left (xtd::forms::right_to_left value) -> control &
	Sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
virtual auto	right_to_left (xtd::null_ptr) -> control &
	Resets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
virtual auto	size () const noexcept -> xtd::drawing::size
	Gets the height and width of the control.
virtual auto	size (const xtd::drawing::size &value) -> control &
	Sets the height and width of the control.
virtual auto	style_sheet () const noexcept -> xtd::forms::style_sheets::style_sheet
	Gets the contol style sheet.
virtual auto	style_sheet (const xtd::forms::style_sheets::style_sheet &value) -> control &
	Sets the contol style sheet.
virtual auto	style_sheet (const xtd::string &value) -> control &
	Sets the contol style sheet.
virtual auto	style_sheet (xtd::null_ptr) -> control &
	Resets the contol style sheet.
virtual auto	tab_stop () const noexcept -> bool
	Gets a value indicating whether the user can give the focus to this control using the TAB key.
virtual auto	tab_stop (bool value) -> control &
	Sets a value indicating whether the user can give the focus to this control using the TAB key.
virtual auto	tag () const noexcept -> const xtd::any_object &
	Gets the object that contains data about the control.
virtual auto	tag (const xtd::any_object &value) -> control &
	Sets the object that contains data about the control.
virtual auto	text () const noexcept -> const xtd::string &
	Gets the text associated with this control.
virtual auto	text (const xtd::string &value) -> control &
	Sets the text associated with this control.
auto	toolkit_handle () const noexcept -> xtd::intptr
	Gets the toolkit handle that the control is bound to.
virtual auto	top () const noexcept -> xtd::int32
	Gets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual auto	top (xtd::int32 value) -> control &
	Sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual auto	top_level_control () const noexcept -> std::optional< xtd::forms::control_ref >
	Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
virtual auto	visible () const noexcept -> bool
	Gets a value indicating whether the control and all its child controls are displayed.
virtual auto	visible (bool value) -> control &
	Sets a value indicating whether the control and all its child controls are displayed.
virtual auto	width () const noexcept -> xtd::int32
	Gets the width of the control.
virtual auto	width (xtd::int32 value) -> control &
	Sets the width of the control.
auto	begin_invoke (xtd::delegate< void()> method) -> xtd::async_result override
	Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
auto	begin_invoke (xtd::delegate< void(xtd::array< xtd::any_object >)> method, const xtd::array< xtd::any_object > &args) -> xtd::async_result override
	Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
virtual auto	bring_to_front () -> void
	Brings the control to the front of the z-order.
auto	compare_to (const control &value) const noexcept -> xtd::int32 override
auto	create_control () -> void
	Forces the creation of the visible control, including the creation of the handle and any visible child controls.
auto	create_graphics () const -> xtd::drawing::graphics
	Creates the xtd::drawing::graphics for the control.
virtual auto	destroy_control () -> void
	Forces the destruction of the visible control, including the destruction of the handle and any visible child controls.
auto	end_invoke (xtd::async_result async) -> std::optional< xtd::object_ref > override
	Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed.
auto	equals (const xtd::object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const control &value) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	focus () -> bool
	Sets input focus to the control.
auto	get_auto_size_mode () const -> xtd::forms::auto_size_mode
	Gets a value indicating how a control will behave when its auto_size property is enabled.
auto	get_child_index (xtd::intptr child) const -> xtd::usize
	Retrieves the index of a control within the control collection.
auto	get_child_index (xtd::intptr child, bool &throw_exception) const -> xtd::usize
	Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
virtual auto	hide () -> void
	Conceals the control from the user.
virtual auto	invalidate () const -> void
	Invalidates the entire surface of the control and causes the control to be redrawn.
virtual auto	invalidate (bool invalidate_children) const -> void
	Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
virtual auto	invalidate (const xtd::drawing::rectangle &rect) const -> void
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
virtual auto	invalidate (const xtd::drawing::rectangle &rect, bool invalidate_children) const -> void
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
virtual auto	invalidate (const xtd::drawing::region &region) const -> void
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
virtual auto	invalidate (const xtd::drawing::region &region, bool invalidate_children) const -> void
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
auto	invoke (xtd::delegate< void()> method) -> std::optional< xtd::object_ref > override
	Executes the specified delegate on the thread that owns the control's underlying window handle.
auto	invoke (xtd::delegate< void(xtd::array< xtd::any_object >)> method, const xtd::array< xtd::any_object > &args) -> std::optional< xtd::object_ref > override
	Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
auto	invoke (xtd::delegate< void(xtd::array< xtd::any_object >)> method, const xtd::any_object &arg) -> std::optional< xtd::object_ref > override
	Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
auto	perform_layout () -> void
	Forces the control to apply layout logic to all its child controls.
auto	point_to_client (const xtd::drawing::point &p) const -> xtd::drawing::point
	Computes the location of the specified screen point into client coordinates.
auto	point_to_screen (const xtd::drawing::point &p) const -> xtd::drawing::point
	Computes the location of the specified client point into screen coordinates.
auto	post_message (xtd::intptr hwnd, xtd::int32 msg, xtd::intptr wparam, xtd::intptr lparam) const -> bool
	Places (posts) a message in the message queue with specified hwnd, message, wparam and lparam.
virtual auto	pre_process_message (const xtd::forms::message &message) -> bool
	Preprocesses keyboard or input messages within the message loop before they are dispatched.
virtual auto	refresh () const -> void
	Forces the control to invalidate its client area and immediately redraw itself and any child controls.
auto	resume_layout () -> void
	Resumes usual layout logic.
auto	resume_layout (bool perform_layout) -> void
	Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
auto	send_message (xtd::intptr hwnd, xtd::int32 msg, xtd::intptr wparam, xtd::intptr lparam) const -> xtd::intptr
	Send a message with specified hwnd, message, wparam and lparam.
auto	set_auto_size_mode (xtd::forms::auto_size_mode auto_size_modeauto_size_mode) -> void
	Sets a value indicating how a control will behave when its auto_size property is enabled.
auto	set_bounds (xtd::int32 x, xtd::int32 y, xtd::int32 width, xtd::int32 height) -> void
	Sets the bounds of the control to the specified location and size.
auto	set_bounds (xtd::int32 x, xtd::int32 y, xtd::int32 width, xtd::int32 height, xtd::forms::bounds_specified specified) -> void
	Sets the specified bounds of the control to the specified location and size.
virtual auto	show () -> void
	Displays the control to the user.
auto	suspend_layout () -> void
	Temporarily suspends the layout logic for the control.
auto	to_string () const noexcept -> xtd::string override
	Returns a string containing the name of the control, if any.
virtual auto	update () const -> void
	Causes the control to redraw the invalidated regions within its client area.
auto	operator<< (control &child) -> control &
	Add child control.
auto	operator>> (control &child) -> control &
	Remove child control.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	compare_to (const control &obj) const noexcept -> xtd::int32=0
	Compares the current instance with another object of the same type.
virtual auto	equals (const control &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
static auto	check_for_illegal_cross_thread_calls () noexcept -> bool
	Gets a value indicating whether to catch calls on the wrong thread that access a xtd::forms::contrtol::handle property when an application is being debugged.
static auto	check_for_illegal_cross_thread_calls (bool value) -> void
	Sets a value indicating whether to catch calls on the wrong thread that access a xtd::forms::contrtol::handle property when an application is being debugged.
static auto	modifier_keys () noexcept -> xtd::forms::keys
	Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
static auto	mouse_buttons () noexcept -> xtd::forms::mouse_buttons
	Gets a value indicating which of the mouse buttons is in a pressed state.
static auto	mouse_position () noexcept -> xtd::drawing::point
	Gets the position of the mouse cursor in screen coordinates.
static auto	create () -> control
	A factory to create a specified control.
static auto	create (const xtd::drawing::point &location) -> control
	A factory to create a specified control with specified location.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size) -> control
	A factory to create a specified control with specified location, and size.
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control
	A factory to create a specified control with specified location, size, and name.
static auto	create (const control &paren) -> control
	A factory to create a specified control with specified parent.
static auto	create (const control &parent, const xtd::drawing::point &location) -> control
	A factory to create a specified control with specified parent, location, size, and name.
static auto	create (const control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size) -> control
	A factory to create a specified control with specified parent, location, and size.
static auto	create (const control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control
	A factory to create a specified control with specified parent, location, size, and name.
template<typename control_t>
static auto	create () -> control_t
	A factory to create a specified control.
template<typename control_t>
static auto	create (const xtd::drawing::point &location) -> control_t
	A factory to create a specified control with specified location.
template<typename control_t>
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size) -> control_t
	A factory to create a specified control with specified location, and size.
template<typename control_t>
static auto	create (const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control_t
	A factory to create a specified control with specified location, size, and name.
template<typename control_t>
static auto	create (const control &parent) -> control_t
	A factory to create a specified control with specified parent.
template<typename control_t>
static auto	create (const control &parent, const xtd::drawing::point &location) -> control_t
	A factory to create a specified control with specified parent, and location.
template<typename control_t>
static auto	create (const control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size) -> control_t
	A factory to create a specified control with specified parent, location, and size.
template<typename control_t>
static auto	create (const control &parent, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control_t
	A factory to create a specified control with specified parent, location, size, and name.
template<typename control_t>
static auto	create (const xtd::string &text) -> control_t
	A factory to create a specified control with specified text.
template<typename control_t>
static auto	create (const xtd::string &text, const xtd::drawing::point &location) -> control_t
	A factory to create a specified control with specified text, and location.
template<typename control_t>
static auto	create (const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size) -> control_t
	A factory to create a specified control with specified text, location, and size.
template<typename control_t>
static auto	create (const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control_t
	A factory to create a specified control with specified text, location,size, and name.
template<typename control_t>
static auto	create (const control &parent, const xtd::string &text) -> control_t
	A factory to create a specified control with specified parent, and text.
template<typename control_t>
static auto	create (const control &parent, const xtd::string &text, const xtd::drawing::point &location) -> control_t
	A factory to create a specified control with specified parent, text, and location.
template<typename control_t>
static auto	create (const control &parent, const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size) -> control_t
	A factory to create a specified control with specified parent, text, location, and size.
template<typename control_t>
static auto	create (const control &parent, const xtd::string &text, const xtd::drawing::point &location, const xtd::drawing::size &size, const xtd::string &name) -> control_t
	A factory to create a specified control with specified parent, text, location, size, and name.
static auto	from_child_handle (xtd::intptr handle) -> std::optional< xtd::forms::control_ref >
	Retrieves the control that contains the specified handle.
static auto	from_handle (xtd::intptr handle) -> std::optional< xtd::forms::control_ref >
	Returns the control that is currently associated with the specified handle.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.
auto	control_state () const noexcept -> xtd::forms::visual_styles::control_state
	Gets state.
virtual auto	default_back_color () const noexcept -> xtd::drawing::color
	Gets the default background color of the control.
virtual auto	default_cursor () const noexcept -> xtd::forms::cursor
	Gets the default cursor for the control.
virtual auto	default_font () const noexcept -> xtd::drawing::font
	Gets the default font of the control.
virtual auto	default_fore_color () const noexcept -> xtd::drawing::color
	Gets the default foreground color of the control.
virtual auto	default_size () const noexcept -> xtd::drawing::size
	Gets the default size of the control.
virtual auto	create_handle () -> void
	Creates a handle for the control.
virtual auto	destroy_handle () -> void
	Destroys the handle associated with the control.
virtual auto	def_wnd_proc (xtd::forms::message &message) -> void
	Sends the specified message to the default window procedure.
auto	get_style (xtd::forms::control_styles flag) const noexcept -> bool
	Retrieves the value of the specified control style bit for the control.
auto	measure_text () const noexcept -> xtd::drawing::size
	Measure this control text.
virtual auto	on_auto_size_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::auto_size_changed event.
virtual auto	on_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_got_focus (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::got_focus event.
virtual auto	on_handle_created (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::handle_created 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_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_region_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::region_changed event.
virtual auto	on_right_to_left_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::right_to_left_changed event.
virtual auto	on_size_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::size_changed event.
virtual auto	on_style_sheet_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::style_sheet_changed event.
virtual auto	on_system_colors_changed (const xtd::event_args &e) -> void
	Raises the control::system_colors_changed event.
virtual auto	on_tab_stop_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::tab_stop_changed event.
virtual auto	on_visible_changed (const xtd::event_args &e) -> void
	Raises the xtd::forms::control::visible_changed event.
auto	post_recreate_handle () noexcept -> void
virtual auto	recreate_handle () -> void
	Forces the re-creation of the handle for the control.
virtual auto	set_bounds_core (xtd::int32 x, xtd::int32 y, xtd::int32 width, xtd::int32 height, xtd::forms::bounds_specified specified) -> void
	Performs the work of setting the specified bounds of this control.
auto	set_can_focus (bool value) -> void
	Sets a value indicating whether the control can receive focus.
virtual auto	set_text (const xtd::string &text) -> void
	Sets the text associated with this control.
virtual auto	set_client_size_core (xtd::int32 width, xtd::int32 height) -> void
	Sets the size of the client area of the control.
auto	set_parent (xtd::intptr handle) -> void
	Sets the parent handle of the control.
auto	set_style (xtd::forms::control_styles flag, bool value) -> void
	Sets a specified control_styles flag to either true or false.
virtual auto	wnd_proc (xtd::forms::message &m) -> void
	Processes Windows messages.
	component ()
	Initialises a new instance of the component class.
auto	design_mode () const noexcept -> bool
	Gets a value that indicates whether the component is currently in design mode.
static auto	set_mouse_buttons (xtd::forms::mouse_buttons value) -> void
	Sets a value indicating which of the mouse buttons is in a pressed state.

Constructor & Destructor Documentation

label()

xtd::forms::label::label

(

)

Initialize a new instance of label class.

Member Function Documentation

auto_ellipsis() [1/2]

virtual auto xtd::forms::label::auto_ellipsis ( ) const -> bool

nodiscardvirtualnoexcept

Gets a value indicating whether the ellipsis character (...) appears at the right edge of the xtd::forms::label, denoting that the xtd::forms::label text extends beyond the specified length of the xtd::forms::label.

Returns

true if the additional label text is to be indicated by an ellipsis; otherwise, false. The default is false.

Remarks

Set xtd::forms::label::auto_ellipsis to true to display text that extends beyond the width of the xtd::forms::label in a tooltip when the user passes over the control with the mouse. If xtd::forms::label::auto_size is true, the label will grow to fit the text and an ellipsis will not appear.

Note

If the font is taller than the height of the xtd::forms::label and xtd::forms::label::auto_ellipsis is true, you must set xtd::forms::label::auto_size to false for text to be drawn.

auto_ellipsis() [2/2]

virtual auto xtd::forms::label::auto_ellipsis ( bool value ) -> label &

virtual

Sets a value indicating whether the ellipsis character (...) appears at the right edge of the xtd::forms::label, denoting that the xtd::forms::label text extends beyond the specified length of the xtd::forms::label.

Parameters

value

true if the additional label text is to be indicated by an ellipsis; otherwise, false. The default is false.

Returns

Current label instance.

Remarks

Set xtd::forms::label::auto_ellipsis to true to display text that extends beyond the width of the xtd::forms::label in a tooltip when the user passes over the control with the mouse. If xtd::forms::label::auto_size is true, the label will grow to fit the text and an ellipsis will not appear.

Note

If the font is taller than the height of the xtd::forms::label and xtd::forms::label::auto_ellipsis is true, you must set xtd::forms::label::auto_size to false for text to be drawn.

border_sides() [1/2]

virtual auto xtd::forms::label::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::label::border_sides ( xtd::forms::border_sides value ) -> label &

virtual

Sets the border sides for the control.

Parameters

value

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

Returns

Current label instance.

border_style() [1/3]

virtual auto xtd::forms::label::border_style ( ) const -> xtd::forms::border_style

nodiscardvirtualnoexcept

Gets the border style for the control.

Returns

One of the xtd::forms::border_style values. The default is xtd::forms::border_style::none.

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.

border_style() [2/3]

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

virtual

Sets the border style for the control.

Parameters

value

One of the xtd::forms::border_style values. The default is xtd::forms::border_style::none.

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.

border_style() [3/3]

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

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.

control_appearance() [1/2]

auto xtd::forms::label::control_appearance ( xtd::forms::control_appearance value ) -> xtd::forms::control &override

overridevirtual

Sets control appearance.

Parameters

value

One of xtd::forms::control_appearance values. THe default is xtd::forms::control_appearance::standard.

Remarks

The control appearance determine how the control is drawed :

• xtd::control::control_appearance::standard : The appearance of the control is determined by current theme of xtd.
• xtd::control::control_appearance::system : The appearance of the control is determined by the user's operating system.

Reimplemented from xtd::forms::control.

flat_style() [1/2]

virtual auto xtd::forms::label::flat_style ( ) const -> xtd::forms::flat_style

nodiscardvirtualnoexcept

Gets the flat style appearance of the label control.

Returns

One of the xtd::forms::flat_style values. The default value is xtd::forms::flat_style::standard.

Remarks

When the flat_style property is set to xtd::forms::flat_style::system, any values assigned to the image_list, image, image_index, and image_align properties are ignored. In addition, the text_align property ignores any property values that are not vertical property settings. Horizontally aligned settings of the text_align property are aligned to the top of the control. For example, if you set the text_align property to content_alignment::top_center, content_alignment::middle_center, or content_alignment::bottom_center, when the flat_style property is set to xtd::forms::flat_style::system, the text in the label control will be aligned to the top and center locations within the bounds of the control.

flat_style() [2/2]

virtual auto xtd::forms::label::flat_style ( xtd::forms::flat_style value ) -> label &

virtual

Sets the flat style appearance of the label control.

Parameters

value

One of the xtd::forms::flat_style values. The default value is xtd::forms::flat_style::standard.

Returns

Current label instance.

Remarks

When the flat_style property is set to xtd::forms::flat_style::system, any values assigned to the image_list, image, image_index, and image_align properties are ignored. In addition, the text_align property ignores any property values that are not vertical property settings. Horizontally aligned settings of the text_align property are aligned to the top of the control. For example, if you set the text_align property to content_alignment::top_center, content_alignment::middle_center, or content_alignment::bottom_center, when the flat_style property is set to xtd::forms::flat_style::system, the text in the label control will be aligned to the top and center locations within the bounds of the control.

image() [1/2]

virtual auto xtd::forms::label::image ( ) const -> const xtd::drawing::image &

nodiscardvirtualnoexcept

Gets the image that is displayed on a label control.

Returns

The Image displayed on the label control. The default value is xtd::drawing::image::empty.

Remarks

When the image property is set, the image_list property will be set to xtd::forms::image_list::empty, and the image_index property will be set to its default, -1.

Note

If the flat_style property is set to xtd::forms::flat_style::system, any images assigned to the image property are not displayed.

image() [2/2]

virtual auto xtd::forms::label::image ( const xtd::drawing::image & value ) -> label &

virtual

Sets the image that is displayed on a label control.

Parameters

value

The Image displayed on the label control. The default value is xtd::drawing::image::empty.

Returns

Current label instance.

Remarks

When the image property is set, the image_list property will be set to xtd::forms::image_list::empty, and the image_index property will be set to its default, -1.

Note

If the flat_style property is set to xtd::forms::flat_style::system, any images assigned to the image property are not displayed.

image_align() [1/2]

virtual auto xtd::forms::label::image_align ( ) const -> xtd::forms::content_alignment

nodiscardvirtualnoexcept

Gets the alignment of the image on the label control.

Returns

One of the content_alignment values. The default is middle_center.

image_align() [2/2]

virtual auto xtd::forms::label::image_align ( xtd::forms::content_alignment value ) -> label &

virtual

Gets the alignment of the image on the label control.

Parameters

value

One of the content_alignment values. The default is xtd::forms::content_alignment::middle_center.

Returns

Current label instance.

image_index() [1/2]

virtual auto xtd::forms::label::image_index ( ) const -> xtd::int32

nodiscardvirtualnoexcept

Gets the image list index value of the image displayed on the label control.

Returns

A zero-based index, which represents the image position in an image_list. The default is -1.

Remarks

When the image_index or image_list properties are set, the Image property is set to its default value, xtd::drawing::image::empty.

image_key and image_index are mutually exclusive, meaning if one is set, the other is set to an invalid value and ignored. If you set the image_key property, the image_index property is automatically set to -1. Alternatively, if you set the image_index property, the image_key is automatically set to an empty string ("").

If the image_list property value is changed to xtd::forms::image_list::empty, the image_index property returns its default value, -1. However, the assigned image_index value is retained internally and used when another image_list object is assigned to the image_list property. If the new image_list assigned to the image_list property has an imageList::_image_collection::size property value that is less than or equal to the value assigned to the image_index property minus one (to account for the collection being a zero-based index), the image_index property value is adjusted to one less than the size property value. For example, consider a label control whose image_list has three images and whose image_index property is set to 2. If a new image_list that has only two images is assigned to the label, the image_index value changes to 1.

image_index() [2/2]

virtual auto xtd::forms::label::image_index ( xtd::int32 value ) -> label &

virtual

Sets the image list index value of the image displayed on the label control.

Parameters

value

A zero-based index, which represents the image position in an image_list. The default is -1.

Returns

Current label instance.

Remarks

When the image_index or image_list properties are set, the Image property is set to its default value, xtd::drawing::image::empty.

image_key and image_index are mutually exclusive, meaning if one is set, the other is set to an invalid value and ignored. If you set the image_key property, the image_index property is automatically set to -1. Alternatively, if you set the image_index property, the image_key is automatically set to an empty string ("").

If the image_list property value is changed to xtd::forms::image_list::empty, the image_index property returns its default value, -1. However, the assigned image_index value is retained internally and used when another image_list object is assigned to the image_list property. If the new image_list assigned to the image_list property has an imageList::_image_collection::size property value that is less than or equal to the value assigned to the image_index property minus one (to account for the collection being a zero-based index), the image_index property value is adjusted to one less than the size property value. For example, consider a label control whose image_list has three images and whose image_index property is set to 2. If a new image_list that has only two images is assigned to the label, the image_index value changes to 1.

image_list() [1/3]

virtual auto xtd::forms::label::image_list ( ) const -> const xtd::forms::image_list &

nodiscardvirtualnoexcept

Gets the image_list that contains the image displayed on a label control.

Returns

An xtd::drawing::image_list. The default value is xtd::drawing::image_list::empty.

image_list() [2/3]

virtual auto xtd::forms::label::image_list ( ) -> xtd::forms::image_list &

nodiscardvirtualnoexcept

Gets the image_list that contains the image displayed on a label control.

Returns

An xtd::drawing::image_list. The default value is xtd::drawing::image_list::empty.

image_list() [3/3]

virtual auto xtd::forms::label::image_list ( const xtd::forms::image_list & value ) -> label &

virtual

Sets the image_list that contains the image displayed on a label control.

Parameters

value

An xtd::drawing::image_list. The default value is xtd::drawing::image_list::empty.

Returns

Current label instance.

shadow() [1/2]

virtual auto xtd::forms::label::shadow ( ) const -> bool

nodiscardvirtualnoexcept

Gets a value that allows to draw a drop shadow under the text.

Returns

true allows to draw a drop shadow under the text; otherwise false. The default is false.

shadow() [2/2]

virtual auto xtd::forms::label::shadow ( bool value ) -> label &

virtual

Sets a value that allows to draw a drop shadow under the text.

Parameters

value

true allows to draw a drop shadow under the text; otherwise false. The default is false.

Returns

Current label instance.

shadows() [1/2]

virtual auto xtd::forms::label::shadows ( ) const -> const xtd::forms::shadows &

nodiscardvirtualnoexcept

Gets an xtd::forms::shadow array used to draw shadows under the text.

Returns

An xtd::forms::shadow array used to draw shadows under the text.

shadows() [2/2]

virtual auto xtd::forms::label::shadows ( const xtd::forms::shadows & value ) -> label &

virtual

Sets an xtd::forms::shadow array used to draw shadows under the text.

Parameters

value

An xtd::forms::shadow array used to draw shadows under the text.

Returns

Current label instance.

text_align() [1/2]

virtual auto xtd::forms::label::text_align ( ) const -> xtd::forms::content_alignment

nodiscardvirtualnoexcept

Gets the alignment of the text on the label control.

Returns

One of the content_alignment values. The default is middle_center.

Remarks

You can use this property to align the text within a label to match the layout of controls on your form. For example, if your controls are located to the right edge of the labels, you can set the text_align property to one of the right-aligned horizontal alignments (top_right, middle_right, bottom_right) and the text will be aligned with the right edge of the labels to align with your controls.

text_align() [2/2]

virtual auto xtd::forms::label::text_align ( xtd::forms::content_alignment value ) -> label &

virtual

Gets the alignment of the text on the label control.

Parameters

value

One of the content_alignment values. The default is middle_center.

Returns

Current label instance.

Remarks

You can use this property to align the text within a label to match the layout of controls on your form. For example, if your controls are located to the right edge of the labels, you can set the text_align property to one of the right-aligned horizontal alignments (top_right, middle_right, bottom_right) and the text will be aligned with the right edge of the labels to align with your controls.

create() [1/16]

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

staticnodiscard

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

Returns

New xtd::forms::label created.

create() [2/16]

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

staticnodiscard

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

Parameters

location

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

Returns

New xtd::forms::label created.

create() [3/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [4/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [5/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [6/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [7/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [8/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [9/16]

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

staticnodiscard

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

Parameters

parent

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

Returns

New xtd::forms::label created.

create() [10/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [11/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [12/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [13/16]

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

staticnodiscard

A factory to create an xtd::forms::label with specified parent, and text.

Parameters

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

Returns

New xtd::forms::label created.

create() [14/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [15/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create() [16/16]

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

staticnodiscard

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

Parameters

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

Returns

New xtd::forms::label created.

create_params()

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

measure_control()

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

nodiscardoverrideprotectedvirtualnoexcept

Measure this control.

Returns

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::link_label.

on_font_changed()

auto xtd::forms::label::on_font_changed ( const xtd::event_args & e ) -> void

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

on_image_changed()

virtual auto xtd::forms::label::on_image_changed ( const xtd::event_args & e ) -> void

protectedvirtual

Raises the image_changed event.

Parameters

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

on_paint()

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

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::link_label.

on_resize()

auto xtd::forms::label::on_resize ( const xtd::event_args & e ) -> void

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

on_text_align_changed()

virtual auto xtd::forms::label::on_text_align_changed ( const xtd::event_args & e ) -> void

protectedvirtual

Raises the xtd::forms::label::text_align_changed event.

Remarks

Raising an event invokes the event handler through a delegate.

Notes to Inheritors

When overriding xtd::forms::label::on_text_align_changed in a derived class, be sure to call the base class's xtd::forms::label::on_text_align_changed method.

Reimplemented in xtd::forms::link_label.

on_text_changed()

auto xtd::forms::label::on_text_changed ( const xtd::event_args & e ) -> void

overrideprotectedvirtual

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

Parameters

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::link_label.

control_appearance() [2/2]

virtual auto xtd::forms::control::control_appearance ( ) const -> xtd::forms::control_appearance

nodiscardvirtualnoexcept

Gets control appearance.

Returns

One of xtd::forms::control_appearance values. THe default is xtd::forms::control_appearance::standard.

Remarks

The control appearance determine how the control is drawed :

• xtd::control::control_appearance::standard : The appearance of the control is determined by current theme of xtd.
• xtd::control::control_appearance::system : The appearance of the control is determined by the user's operating system.

Reimplemented from xtd::forms::control.

Member Data Documentation

image_changed

xtd::event<label, xtd::event_handler> xtd::forms::label::image_changed

Occurs when the value of the image property changes.

Remarks

This event is raised if the image property is changed by either a programmatic modification or user interaction.

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

text_align_changed

xtd::event<label, xtd::event_handler> xtd::forms::label::text_align_changed

Occurs when the value of the xtd::forms::label::text_align property has changed.

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