xtd - Reference Guide 0.2.0
xtd::forms::button_base Class Reference

#include <button_base.h>

Definition

Implements the basic functionality common to button controls.

class forms_export_ button_base : public xtd::forms::control
Inheritance
xtd::objectxtd::forms::componentxtd::forms::controlxtd::forms::button_base
Derived
xtd::forms::button, xtd::forms::check_box, xtd::forms::command_link_button, xtd::forms::light_button, xtd::forms::radio_button, xtd::forms::switch_button, xtd::forms::toggle_button, xtd::forms::up_down_button
Namespace
xtd::forms
Library
xtd.forms
Remarks
You do not typically inherit from button_base. To create your own button class, inherit from the button, check_box, or radio_button class.
To have the derived button control display an image, set the Image property or the image_list and image_index properties. The image can be aligned on the button control by setting the image_align property. Likewise, to align the text displayed on the button control, set the text_align property.
The flat_style property determines the style and appearance of the control. If the flat_style property is set to flat_style::system, the user's operating system determines the appearance of the control.

Properties

bool auto_ellipsis () const
 Gets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control. More...
 
virtual button_baseauto_ellipsis (bool auto_ellipsis)
 Sets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control. More...
 
bool auto_size () const override
 Gets a value that indicates whether the control resizes based on its contents. More...
 
controlauto_size (bool auto_size) override
 Sets a value that indicates whether the control resizes based on its contents. More...
 
controlcontrol_appearance (forms::control_appearance value) override
 Sets control appearance. More...
 
virtual const xtd::forms::flat_button_appearanceflat_appearance () const
 Gets the appearance of the border and the colors used to indicate check state and mouse state. More...
 
virtual xtd::forms::button_baseflat_appearance (const xtd::forms::flat_button_appearance &value)
 Sets the appearance of the border and the colors used to indicate check state and mouse state. More...
 
virtual xtd::forms::flat_style flat_style () const
 Gets the flat style appearance of the button control. More...
 
virtual xtd::forms::button_baseflat_style (xtd::forms::flat_style value)
 Sets the flat style appearance of the button control. More...
 
virtual const drawing::imageimage () const
 Gets the image that is displayed on a button control. More...
 
virtual button_baseimage (const drawing::image &value)
 Sets the image that is displayed on a button control. More...
 
virtual content_alignment image_align () const
 Gets the alignment of the image on the button control. More...
 
virtual button_baseimage_align (content_alignment value)
 Gets the alignment of the image on the button control. More...
 
virtual int32_t image_index () const
 Gets the image list index value of the image displayed on the button control. More...
 
virtual button_baseimage_index (int32_t value)
 Sets the image list index value of the image displayed on the button control. More...
 
virtual const forms::image_listimage_list () const
 Gets the image_list that contains the image displayed on a button control. More...
 
virtual forms::image_listimage_list ()
 Gets the image_list that contains the image displayed on a button control. More...
 
virtual button_baseimage_list (const forms::image_list &value)
 Sets the image_list that contains the image displayed on a button control. More...
 
virtual content_alignment text_align () const
 Gets the alignment of the text on the button control. More...
 
virtual button_basetext_align (content_alignment value)
 Gets the alignment of the text on the button control. More...
 

Events

event< button_base, event_handlerimage_changed
 Occurs when the value of the image property changes. More...
 

Protected constructor

 button_base ()
 Initializes a new instance of the ButtonBase class. More...
 

Protected properties

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

Protected methods

drawing::size measure_control () const override
 Measure this control. More...
 
void on_back_color_changed (const event_args &e) override
 Raises the xtd::forms::control::back_color_changed event. More...
 
void on_enabled_changed (const event_args &e) override
 Raises the xtd::forms::control::enabled_changed event. More...
 
void on_font_changed (const xtd::event_args &e) override
 Raises the xtd::forms::control::font_changed event. More...
 
void on_fore_color_changed (const event_args &e) override
 Raises the xtd::forms::control::fore_color_changed event. More...
 
virtual void on_image_changed (const xtd::event_args &e)
 Raises the button_base::image_changed event. More...
 
void on_mouse_down (const mouse_event_args &e) override
 Raises the xtd::forms::control::mouse_down event. More...
 
void on_mouse_enter (const event_args &e) override
 Raises the xtd::forms::control::mouse_enter event. More...
 
void on_mouse_leave (const event_args &e) override
 Raises the xtd::forms::control::mouse_leave event. More...
 
void on_mouse_up (const mouse_event_args &e) override
 Raises the xtd::forms::control::mouse_up event. More...
 
void on_parent_back_color_changed (const event_args &e) override
 Raises the xtd::forms::control::parent_back_color_changed event. More...
 
void on_parent_fore_color_changed (const event_args &e) override
 Raises the xtd::forms::control::parent_fore_color_changed event. More...
 
void on_resize (const xtd::event_args &e) override
 Raises the xtd::forms::control::region event. More...
 
void on_text_changed (const xtd::event_args &e) override
 Raises the xtd::forms::control::text_changed event. More...
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ button_base()

xtd::forms::button_base::button_base ( )
protected

Initializes a new instance of the ButtonBase class.

Member Function Documentation

◆ auto_ellipsis() [1/2]

bool xtd::forms::button_base::auto_ellipsis ( ) const
inline

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

Returns
true if the additional label text is to be indicated by an ellipsis; otherwise, false. The default is true.
Remarks
Set auto_ellipsis to true to display text that extends beyond the width of the control when the user passes over the control with the mouse. You must set the control's auto_size property to false if you want AutoEllipsis to be true. If AutoSize is true, the control will grow to fit the text and an ellipsis will not appear.

◆ auto_ellipsis() [2/2]

virtual button_base& xtd::forms::button_base::auto_ellipsis ( bool  auto_ellipsis)
inlinevirtual

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

Parameters
trueif the additional label text is to be indicated by an ellipsis; otherwise, false. The default is true.
Remarks
Set auto_ellipsis to true to display text that extends beyond the width of the control when the user passes over the control with the mouse. You must set the control's auto_size property to false if you want AutoEllipsis to be true. If AutoSize is true, the control will grow to fit the text and an ellipsis will not appear.

◆ auto_size() [1/2]

bool xtd::forms::button_base::auto_size ( ) const
inlineoverridevirtual

Gets a value that indicates whether the control resizes based on its contents.

Returns
true if enabled; otherwise, false.
Remarks
This property is not relevant for this class.

Reimplemented from xtd::forms::control.

◆ auto_size() [2/2]

control& xtd::forms::button_base::auto_size ( bool  auto_size)
inlineoverridevirtual

Sets a value that indicates whether the control resizes based on its contents.

Parameters
auto_sizetrue if enabled; otherwise, false.
Returns
Current control.
Remarks
This property is not relevant for this class.

Reimplemented from xtd::forms::control.

◆ control_appearance()

control& xtd::forms::button_base::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. 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.

◆ create_params()

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

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

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::check_box, xtd::forms::light_button, xtd::forms::toggle_button, xtd::forms::up_down_button, xtd::forms::radio_button, and xtd::forms::command_link_button.

◆ flat_appearance() [1/2]

virtual const xtd::forms::flat_button_appearance& xtd::forms::button_base::flat_appearance ( ) const
inlinevirtual

Gets the appearance of the border and the colors used to indicate check state and mouse state.

Returns
The xtd::forms::flat_button_appearance appearance.

◆ flat_appearance() [2/2]

virtual xtd::forms::button_base& xtd::forms::button_base::flat_appearance ( const xtd::forms::flat_button_appearance value)
virtual

Sets the appearance of the border and the colors used to indicate check state and mouse state.

Parameters
valueThe xtd::forms::flat_button_appearance appearance.

◆ flat_style() [1/2]

virtual xtd::forms::flat_style xtd::forms::button_base::flat_style ( ) const
inlinevirtual

Gets the flat style appearance of the button control.

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

◆ flat_style() [2/2]

virtual xtd::forms::button_base& xtd::forms::button_base::flat_style ( xtd::forms::flat_style  value)
virtual

Sets the flat style appearance of the button control.

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

◆ image() [1/2]

virtual const drawing::image& xtd::forms::button_base::image ( ) const
inlinevirtual

Gets the image that is displayed on a button control.

Returns
The Image displayed on the button 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 button_base& xtd::forms::button_base::image ( const drawing::image value)
virtual

Sets the image that is displayed on a button control.

Parameters
valueThe Image displayed on the button 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_align() [1/2]

virtual content_alignment xtd::forms::button_base::image_align ( ) const
inlinevirtual

Gets the alignment of the image on the button control.

Returns
One of the content_alignment values. The default is middle_center.

◆ image_align() [2/2]

virtual button_base& xtd::forms::button_base::image_align ( content_alignment  value)
virtual

Gets the alignment of the image on the button control.

Parameters
valueOne of the content_alignment values. The default is middle_center.

◆ image_index() [1/2]

virtual int32_t xtd::forms::button_base::image_index ( ) const
inlinevirtual

Gets the image list index value of the image displayed on the button 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 button 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 button, the image_index value changes to 1.

◆ image_index() [2/2]

virtual button_base& xtd::forms::button_base::image_index ( int32_t  value)
virtual

Sets the image list index value of the image displayed on the button 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 button 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 button, the image_index value changes to 1.

◆ image_list() [1/3]

virtual const forms::image_list& xtd::forms::button_base::image_list ( ) const
inlinevirtual

Gets the image_list that contains the image displayed on a button 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::button_base::image_list ( )
inlinevirtual

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

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

◆ image_list() [3/3]

virtual button_base& xtd::forms::button_base::image_list ( const forms::image_list value)
virtual

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

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

◆ measure_control()

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

Measure this control.

Returns
The drawing::size size of this control.
Remarks
This method is used when auto_size is true.

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::check_box, xtd::forms::light_button, xtd::forms::toggle_button, xtd::forms::radio_button, and xtd::forms::command_link_button.

◆ on_back_color_changed()

void xtd::forms::button_base::on_back_color_changed ( const event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

◆ on_enabled_changed()

void xtd::forms::button_base::on_enabled_changed ( const event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::check_box, xtd::forms::light_button, xtd::forms::toggle_button, and xtd::forms::radio_button.

◆ on_font_changed()

void xtd::forms::button_base::on_font_changed ( const xtd::event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

◆ on_fore_color_changed()

void xtd::forms::button_base::on_fore_color_changed ( const event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

◆ on_image_changed()

virtual void xtd::forms::button_base::on_image_changed ( const xtd::event_args e)
inlineprotectedvirtual

Raises the button_base::image_changed event.

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

Reimplemented in xtd::forms::light_button, and xtd::forms::button.

◆ on_mouse_down()

void xtd::forms::button_base::on_mouse_down ( const mouse_event_args e)
inlineoverrideprotectedvirtual

◆ on_mouse_enter()

void xtd::forms::button_base::on_mouse_enter ( const event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::check_box, xtd::forms::light_button, xtd::forms::radio_button, and xtd::forms::toggle_button.

◆ on_mouse_leave()

void xtd::forms::button_base::on_mouse_leave ( const event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::check_box, xtd::forms::light_button, xtd::forms::radio_button, and xtd::forms::toggle_button.

◆ on_mouse_up()

void xtd::forms::button_base::on_mouse_up ( const mouse_event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::check_box, xtd::forms::light_button, xtd::forms::radio_button, and xtd::forms::toggle_button.

◆ on_parent_back_color_changed()

void xtd::forms::button_base::on_parent_back_color_changed ( const event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

◆ on_parent_fore_color_changed()

void xtd::forms::button_base::on_parent_fore_color_changed ( const event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

◆ on_resize()

void xtd::forms::button_base::on_resize ( const xtd::event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

Reimplemented in xtd::forms::switch_button.

◆ on_text_changed()

void xtd::forms::button_base::on_text_changed ( const xtd::event_args e)
inlineoverrideprotectedvirtual

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

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

Reimplemented from xtd::forms::control.

◆ text_align() [1/2]

virtual content_alignment xtd::forms::button_base::text_align ( ) const
inlinevirtual

Gets the alignment of the text on the button control.

Returns
One of the content_alignment values. The default is middle_center.

◆ text_align() [2/2]

virtual button_base& xtd::forms::button_base::text_align ( content_alignment  value)
virtual

Gets the alignment of the text on the button control.

Parameters
valueOne of the content_alignment values. The default is middle_center.

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