xtd 0.2.0
Loading...
Searching...
No Matches
xtd::forms::label Class Reference
Inheritance diagram for xtd::forms::label:
xtd::forms::control xtd::forms::component xtd::forms::iwin32_window xtd::iclonable xtd::icomparable< control > xtd::iequatable< control > xtd::isynchronize_invoke xtd::interface xtd::equality_operators< type_t, equatable_t > xtd::interface xtd::comparison_operators< type_t, comparable_t > xtd::interface xtd::interface xtd::interface xtd::object xtd::forms::link_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/forms/application>
#include <xtd/forms/form>
#include <xtd/forms/label>
using namespace xtd::forms;
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);
}
private:
label label1;
label label2;
label label3;
label label4;
};
}
auto main() -> int {
application::run(label_example::form1 {});
}
static void run()
Begins running a standard application message loop on the current thread, without a form.
Represents a window or dialog box that makes up an application's user interface.
Definition form.h:54
Represents a standard Windows label.
Definition label.h:38
@ text
The xtd::forms::status_bar_panel displays text in the standard font.
@ top_center
Content is vertically aligned at the top, and horizontally aligned at the center.
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition xtd_about_box.h:12
Examples
The following code example demonstrates the use of label control.
#include <xtd/xtd>
using namespace xtd::drawing;
using namespace xtd::forms;
namespace hello_world_label_example {
class main_form : public form {
public:
main_form() {
text("Hello world (label)");
controls().push_back(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 {});
}
The xtd::drawing namespace provides access to GDI+ basic graphics functionality. More advanced functi...
Definition actions_system_images.h:11
Examples
about_dialog_with_user_pages.cpp, application_enable_dark_mode.cpp, application_enable_light_mode.cpp, application_with_cmake_assembly_info.cpp, application_with_manual_assembly_info.cpp, background_worker.cpp, bitmap_button.cpp, border_style.cpp, button.cpp, button2.cpp, button3.cpp, button_appearance.cpp, calculator.cpp, change_color.cpp, change_parent.cpp, check_box_appearance.cpp, clock.cpp, color_dialog.cpp, color_picker.cpp, command_link_button.cpp, control_with_name_operator.cpp, countries.cpp, date_time_picker.cpp, demo.cpp, domain_up_down.cpp, emplace.cpp, folder_browser_box.cpp, folder_browser_dialog.cpp, font_dialog.cpp, font_families.cpp, font_picker.cpp, form_decoration.cpp, forms_timer.cpp, hello_world_emoticons.cpp, hello_world_label.cpp, image_converter.cpp, images.cpp, images2.cpp, images3.cpp, input_box.cpp, input_dialog.cpp, input_dialog_multiline.cpp, input_dialog_password.cpp, label.cpp, lcd_label2.cpp, lcd_label_appearance.cpp, lcd_label_with_dot_matrix.cpp, lcd_label_with_fourteen_segment.cpp, lcd_label_with_nine_segment.cpp, lcd_label_with_seven_segment.cpp, lcd_label_with_sixteen_segment.cpp, message_box.cpp, message_box_appearance.cpp, message_dialog.cpp, message_dialog_show_sheet.cpp, month_calendar.cpp, numeric_up_down.cpp, open_file_dialog.cpp, painting.cpp, radio_button.cpp, save_file_dialog.cpp, screenshot.cpp, some_controls.cpp, some_system_controls.cpp, switch_button.cpp, tab_control.cpp, text_box_password.cpp, text_box_password2.cpp, themes.cpp, track_bar.cpp, translator.cpp, translator_with_language.cpp, tutorial_communicate.cpp, up_down_button.cpp, user_dialog.cpp, and user_dialog_show_sheet.cpp.

Public Events

event< label, event_handlerimage_changed
 Occurs when the value of the image property changes.
 
event< label, event_handlertext_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 bool auto_ellipsis () const noexcept
 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 labelauto_ellipsis (bool value)
 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 forms::border_sides border_sides () const noexcept
 Gets the border sides for the control.
 
virtual labelborder_sides (forms::border_sides border_sides)
 Sets the border sides for the control.
 
virtual xtd::forms::border_style border_style () const noexcept
 Gets the border style for the control.
 
virtual xtd::forms::labelborder_style (xtd::forms::border_style border_style)
 Sets the border style for the control.
 
virtual xtd::forms::labelborder_style (std::nullptr_t border_style)
 Resets the border style for the control.
 
controlcontrol_appearance (forms::control_appearance value) override
 Sets control appearance.
 
virtual xtd::forms::flat_style flat_style () const noexcept
 Gets the flat style appearance of the label control.
 
virtual xtd::forms::labelflat_style (xtd::forms::flat_style flat_style)
 Sets the flat style appearance of the label control.
 
virtual const drawing::imageimage () const noexcept
 Gets the image that is displayed on a label control.
 
virtual xtd::forms::labelimage (const drawing::image &value)
 Sets the image that is displayed on a label control.
 
virtual xtd::forms::content_alignment image_align () const noexcept
 Gets the alignment of the image on the label control.
 
virtual xtd::forms::labelimage_align (content_alignment value)
 Gets the alignment of the image on the label control.
 
virtual int32 image_index () const noexcept
 Gets the image list index value of the image displayed on the label control.
 
virtual xtd::forms::labelimage_index (int32 value)
 Sets the image list index value of the image displayed on the label control.
 
virtual const forms::image_listimage_list () const noexcept
 Gets the image_list that contains the image displayed on a label control.
 
virtual forms::image_listimage_list () noexcept
 Gets the image_list that contains the image displayed on a label control.
 
virtual xtd::forms::labelimage_list (const forms::image_list &value)
 Sets the image_list that contains the image displayed on a label control.
 
virtual bool shadow () const noexcept
 Gets a value that allows to draw a drop shadow under the text.
 
virtual xtd::forms::labelshadow (bool value)
 Sets a value that allows to draw a drop shadow under the text.
 
virtual const xtd::forms::shadowsshadows () const noexcept
 Gets an xtd::forms::shadow array used to draw shadows under the text.
 
virtual xtd::forms::labelshadows (const xtd::forms::shadows &value)
 Sets an xtd::forms::shadow array used to draw shadows under the text.
 
virtual xtd::forms::content_alignment text_align () const noexcept
 Gets the alignment of the text on the label control.
 
virtual xtd::forms::labeltext_align (xtd::forms::content_alignment text_align)
 Gets the alignment of the text on the label control.
 
virtual forms::control_appearance control_appearance () const noexcept
 Gets control appearance.
 
virtual controlcontrol_appearance (xtd::forms::control_appearance value)
 Sets control appearance.
 

Public Static Methods

static label create ()
 A factory to create an xtd::forms::label.
 
static label create (const drawing::point &location)
 A factory to create an xtd::forms::label with specified location.
 
static label create (const drawing::point &location, const drawing::size &size)
 A factory to create an xtd::forms::label with specified location, and size.
 
static label create (const drawing::point &location, const drawing::size &size, const xtd::string &name)
 A factory to create an xtd::forms::label with specified location, size, and name.
 
static label create (const xtd::string &text)
 A factory to create an xtd::forms::label with specified text.
 
static label create (const xtd::string &text, const drawing::point &location)
 A factory to create an xtd::forms::label with specified text, and location.
 
static label create (const xtd::string &text, const drawing::point &location, const drawing::size &size)
 A factory to create an xtd::forms::label with specified text, location, and size.
 
static label create (const xtd::string &text, const drawing::point &location, const drawing::size &size, const xtd::string &name)
 A factory to create an xtd::forms::label with specified text, location, size, and name.
 
static label create (const control &parent)
 A factory to create an xtd::forms::label with specified parent,.
 
static label create (const control &parent, const drawing::point &location)
 A factory to create an xtd::forms::label with specified parent, location.
 
static label create (const control &parent, const drawing::point &location, const drawing::size &size)
 A factory to create an xtd::forms::label with specified parent, location, and size.
 
static label create (const control &parent, const drawing::point &location, const drawing::size &size, const xtd::string &name)
 A factory to create an xtd::forms::label with specified parent, location, size, and name.
 
static label create (const control &parent, const xtd::string &text)
 A factory to create an xtd::forms::label with specified parent, and text.
 
static label create (const control &parent, const xtd::string &text, const drawing::point &location)
 A factory to create an xtd::forms::label with specified parent, text, and location.
 
static label create (const control &parent, const xtd::string &text, const drawing::point &location, const drawing::size &size)
 A factory to create an xtd::forms::label with specified parent, text, location, and size.
 
static label create (const control &parent, const xtd::string &text, const drawing::point &location, const drawing::size &size, const xtd::string &name)
 A factory to create an xtd::forms::label with specified parent, text, location, size, and name.
 

Protected Properties

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

Protected Methods

xtd::uptr< xtd::objectclone () const override
 Creates a new object that is a copy of the current instance.
 
xtd::drawing::size measure_control () const noexcept override
 Measure this control.
 
void on_font_changed (const xtd::event_args &e) override
 Raises the xtd::forms::control::font_changed event.
 
virtual void on_image_changed (const xtd::event_args &e)
 Raises the image_changed event.
 
void on_paint (xtd::forms::paint_event_args &e) override
 Raises the xtd::forms::control::paint event.
 
void on_resize (const xtd::event_args &e) override
 Raises the xtd::forms::control::region event.
 
virtual void on_text_align_changed (const xtd::event_args &e)
 Raises the xtd::forms::label::text_align_changed event.
 
void on_text_changed (const xtd::event_args &e) override
 Raises the xtd::forms::control::text_changed event.
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ label()

xtd::forms::label::label ( )

Initialize a new instance of label class.

Member Function Documentation

◆ auto_ellipsis() [1/2]

virtual bool xtd::forms::label::auto_ellipsis ( ) const
virtualnoexcept

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 label & xtd::forms::label::auto_ellipsis ( bool  value)
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
valuetrue 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 forms::border_sides xtd::forms::label::border_sides ( ) const
virtualnoexcept

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

Sets the border sides for the control.

Parameters
border_styleA bitwise combination of the border_sides values. The default is border_style::all.
Returns
Current label instance.

◆ border_style() [1/3]

virtual xtd::forms::border_style xtd::forms::label::border_style ( ) const
virtualnoexcept

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.
Examples
demo.cpp.

◆ border_style() [2/3]

virtual xtd::forms::label & xtd::forms::label::border_style ( xtd::forms::border_style  border_style)
virtual

Sets the border style for the control.

Parameters
border_styleOne 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 xtd::forms::label & xtd::forms::label::border_style ( std::nullptr_t  border_style)
virtual

Resets the border style for the control.

Parameters
border_stylenullptr.
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/3]

control & xtd::forms::label::control_appearance ( forms::control_appearance  value)
overridevirtual

Sets control appearance.

Parameters
valueOne 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 xtd::forms::flat_style xtd::forms::label::flat_style ( ) const
virtualnoexcept

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

Sets the flat style appearance of the label control.

Parameters
flat_styleOne 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 const drawing::image & xtd::forms::label::image ( ) const
virtualnoexcept

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 xtd::forms::label & xtd::forms::label::image ( const drawing::image value)
virtual

Sets the image that is displayed on a label control.

Parameters
valueThe 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 xtd::forms::content_alignment xtd::forms::label::image_align ( ) const
virtualnoexcept

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

Gets the alignment of the image on the label control.

Parameters
valueOne of the content_alignment values. The default is xtd::forms::content_alignment::middle_center.
Returns
Current label instance.

◆ image_index() [1/2]

virtual int32 xtd::forms::label::image_index ( ) const
virtualnoexcept

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

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

Parameters
valueA 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 const forms::image_list & xtd::forms::label::image_list ( ) const
virtualnoexcept

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 forms::image_list & xtd::forms::label::image_list ( )
virtualnoexcept

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

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

Parameters
valueAn xtd::drawing::image_list. The default value is xtd::drawing::image_list::empty.
Returns
Current label instance.

◆ shadow() [1/2]

virtual bool xtd::forms::label::shadow ( ) const
virtualnoexcept

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

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

Parameters
valuetrue allows to draw a drop shadow under the text; otherwise false. The default is false.
Returns
Current label instance.

◆ shadows() [1/2]

virtual const xtd::forms::shadows & xtd::forms::label::shadows ( ) const
virtualnoexcept

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

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

Parameters
valueAn xtd::forms::shadow array used to draw shadows under the text.
Returns
Current label instance.

◆ text_align() [1/2]

virtual xtd::forms::content_alignment xtd::forms::label::text_align ( ) const
virtualnoexcept

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.
Examples
demo.cpp.

◆ text_align() [2/2]

virtual xtd::forms::label & xtd::forms::label::text_align ( xtd::forms::content_alignment  text_align)
virtual

Gets the alignment of the text on the label control.

Parameters
text_alignOne 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]

static label xtd::forms::label::create ( )
static

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

Returns
New xtd::forms::label created.
Examples
button4.cpp.

◆ create() [2/16]

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

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

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

◆ create() [3/16]

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

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

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

◆ create() [4/16]

static label xtd::forms::label::create ( const drawing::point location,
const drawing::size size,
const xtd::string name 
)
static

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

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

◆ create() [5/16]

static label xtd::forms::label::create ( const xtd::string text)
static

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

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

◆ create() [6/16]

static label xtd::forms::label::create ( const xtd::string text,
const drawing::point location 
)
static

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

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

◆ create() [7/16]

static label xtd::forms::label::create ( const xtd::string text,
const drawing::point location,
const drawing::size size 
)
static

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

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

◆ create() [8/16]

static label xtd::forms::label::create ( const xtd::string text,
const drawing::point location,
const drawing::size size,
const xtd::string name 
)
static

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

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

◆ create() [9/16]

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

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

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

◆ create() [10/16]

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

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

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

◆ create() [11/16]

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

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

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

◆ create() [12/16]

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

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

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

◆ create() [13/16]

static label xtd::forms::label::create ( const control parent,
const xtd::string text 
)
static

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

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

◆ create() [14/16]

static label xtd::forms::label::create ( const control parent,
const xtd::string text,
const drawing::point location 
)
static

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

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

◆ create() [15/16]

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

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

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

◆ create() [16/16]

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

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

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

◆ create_params()

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

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

Returns
A create_params that contains the required creation parameters when the handle to the control is created.
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.

◆ clone()

xtd::uptr< xtd::object > xtd::forms::label::clone ( ) const
overrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::link_label.

◆ measure_control()

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

Measure this control.

Returns
The drawing::size size of this control.

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::link_label.

◆ on_font_changed()

void xtd::forms::label::on_font_changed ( const xtd::event_args e)
overrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

◆ on_image_changed()

virtual void xtd::forms::label::on_image_changed ( const xtd::event_args e)
protectedvirtual

Raises the image_changed event.

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

◆ on_paint()

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

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

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::link_label.

◆ on_resize()

void xtd::forms::label::on_resize ( const xtd::event_args e)
overrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

◆ on_text_align_changed()

virtual void xtd::forms::label::on_text_align_changed ( const xtd::event_args e)
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()

void xtd::forms::label::on_text_changed ( const xtd::event_args e)
overrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::link_label.

◆ control_appearance() [2/3]

virtual forms::control_appearance xtd::forms::control::control_appearance ( ) const
virtualnoexcept

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.

◆ control_appearance() [3/3]

virtual control & xtd::forms::control::control_appearance ( xtd::forms::control_appearance  value)
virtual

Sets control appearance.

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

event<label, 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

event<label, 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: