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

Definition

Implements the basic functionality required by text controls.

Header
#include <xtd/forms/text_box_base>
Namespace
xtd::forms
Library
xtd.forms
Remarks
This class implements the core features of text manipulation controls, such as xtd::forms::text_box and xtd::forms::rich_text_box. These include text selection, xtd::forms::clipboard functionality, multiline text control support, and many events.

Public Events

event< text_box_base, event_handleraccepts_tab_changed
 Occurs when the value of the accepts_tab property has changed.
event< text_box_base, event_handlerborder_style_changed
 Occurs when the value of the accepts_tab border_style has changed.
event< text_box_base, event_handlermultiline_changed
 Occurs when the value of the accepts_tab border_style has changed.
event< text_box_base, event_handlerread_only_changed
 Occurs when the value of the read_only property has changed.

Public Properties

virtual bool accepts_tab () const noexcept
 Gets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order.
virtual text_box_baseaccepts_tab (bool value)
 Sets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order.
virtual forms::border_sides border_sides () const noexcept
 Gets the border sides for the control.
virtual text_box_baseborder_sides (forms::border_sides border_sidesborder_sides)
 Sets the border sides for the control.
virtual forms::border_style border_style () const noexcept
 Gets the border type of the text box control.
virtual text_box_baseborder_style (forms::border_style border_styleborder_style)
 Sets the border type of the text box control.
virtual text_box_baseborder_style (std::nullptr_t)
 Resets the border style for the control.
xtd::array< xtd::stringlines () const noexcept
 Gets the lines of text in a text box control.
text_box_baselines (const xtd::array< xtd::string > &lines)
 Sets the lines of text in a text box control.
virtual bool multiline () const noexcept
 Gets a value indicating whether this is a multiline text box control.
virtual text_box_basemultiline (bool value)
 Sets a value indicating whether this is a multiline text box control.
virtual bool read_only () const noexcept
 Gets a value indicating whether text in the text box is read-only.
virtual text_box_baseread_only (bool value)
 Sets a value indicating whether text in the text box is read-only.
virtual xtd::usize selection_length () const noexcept
 Gets the number of characters selected in the text box.
virtual text_box_baseselection_length (xtd::usize value)
 Sets the number of characters selected in the text box.
virtual xtd::usize selection_start () const noexcept
 Gets o the starting point of text selected in the text box.
virtual text_box_baseselection_start (xtd::usize value)
 Gets o the starting point of text selected in the text box.
virtual bool word_wrap () const noexcept
 Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary.
virtual text_box_baseword_wrap (bool value)
 Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary.
virtual void append_text (const xtd::string &value)
 Appends text to the current text of a text box.

Public Methods

void clear ()
 Clears all text from the text box control.
virtual void select (xtd::usize start, xtd::usize length)
 Selects a range of text in the text box.
void select_all ()
 Selects all text in the text box.

Protected constructors

 text_box_base ()
 initializes a new instance of the text_box_base class.

Protected Properties

forms::create_params create_params () const noexcept override
 Gets the required creation parameters when the control handle is created.
forms::cursor default_cursor () const noexcept override
 Gets the default cursor for the control.

Protected Methods

virtual void on_accepts_tab_changed (const event_args &e)
 Raises the text_box_base::accepts_tab_changed event.
virtual void on_border_style_changed (const event_args &e)
 Raises the text_box_base::border_style_changed event.
virtual void on_multiline_changed (const event_args &e)
 Raises the text_box_base::text_box_base::multiline_changed event.
virtual void on_read_only_changed (const event_args &e)
 Raises the text_box_base::read_only_changed event.

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ text_box_base()

xtd::forms::text_box_base::text_box_base ( )
protected

initializes a new instance of the text_box_base class.

Member Function Documentation

◆ accepts_tab() [1/2]

virtual bool xtd::forms::text_box_base::accepts_tab ( ) const
virtualnoexcept

Gets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order.

Returns
true if users can enter tabs in a multiline text box using the TAB key; false if pressing the TAB key moves the focus. The default is false.

◆ accepts_tab() [2/2]

virtual text_box_base & xtd::forms::text_box_base::accepts_tab ( bool value)
virtual

Sets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order.

Parameters
valuetrue if users can enter tabs in a multiline text box using the TAB key; false if pressing the TAB key moves the focus. The default is false.
Returns
Current text_box_base instance.

◆ border_sides() [1/2]

virtual forms::border_sides xtd::forms::text_box_base::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 text_box_base & xtd::forms::text_box_base::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.

◆ border_style() [1/3]

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

Gets the border type of the text box control.

Returns
A xtd::forms::border_style that represents the border type of the text box control. The default is fixed_single.

◆ border_style() [2/3]

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

Sets the border type of the text box control.

Parameters
border_styleA xtd::forms::border_style that represents the border type of the text box control. The default is fixed_single.
Returns
Current text_box_base instance.

◆ border_style() [3/3]

virtual text_box_base & xtd::forms::text_box_base::border_style ( std::nullptr_t )
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.

◆ lines() [1/2]

xtd::array< xtd::string > xtd::forms::text_box_base::lines ( ) const
noexcept

Gets the lines of text in a text box control.

Returns
An array of strings that contains the text in a text box control.
Remarks
Each element in the array becomes a line of text in the text box control. If the multiline property of the text box control is set to true and a newline character appears in the text, the text following the newline character is added to a new element in the array and displayed on a separate line.

◆ lines() [2/2]

text_box_base & xtd::forms::text_box_base::lines ( const xtd::array< xtd::string > & lines)

Sets the lines of text in a text box control.

Parameters
linesAn array of strings that contains the text in a text box control.
Returns
Current text_box_base instance.
Remarks
Each element in the array becomes a line of text in the text box control. If the multiline property of the text box control is set to true and a newline character appears in the text, the text following the newline character is added to a new element in the array and displayed on a separate line.

◆ multiline() [1/2]

virtual bool xtd::forms::text_box_base::multiline ( ) const
virtualnoexcept

Gets a value indicating whether this is a multiline text box control.

Returns
true if the control is a multiline text box control; otherwise, false. The default is false.
Remarks
A multiline text box allows you to display more than one line of text in the control. If the word_wrap property is set to true, text entered into the multiline text box is wrapped to the next line in the control. If the word_wrap property is set to false, text entered into the multiline text box control will be displayed on the same line until a newline character is entered.
Examples
test_forms.cpp.

◆ multiline() [2/2]

virtual text_box_base & xtd::forms::text_box_base::multiline ( bool value)
virtual

Sets a value indicating whether this is a multiline text box control.

Parameters
valuetrue if the control is a multiline text box control; otherwise, false. The default is false.
Returns
Current text_box_base instance.
Remarks
A multiline text box allows you to display more than one line of text in the control. If the word_wrap property is set to true, text entered into the multiline text box is wrapped to the next line in the control. If the word_wrap property is set to false, text entered into the multiline text box control will be displayed on the same line until a newline character is entered.

◆ read_only() [1/2]

virtual bool xtd::forms::text_box_base::read_only ( ) const
virtualnoexcept

Gets a value indicating whether text in the text box is read-only.

Returns
true if the text box is read-only; otherwise, false. The default is false.
Remarks
When this property is set to true, the contents of the control cannot be changed by the user at runtime. With this property set to true, you can still set the value of the Text property in code. You can use this feature instead of disabling the control with the Enabled property to allow the contents to be copied and ToolTips to be shown.

◆ read_only() [2/2]

virtual text_box_base & xtd::forms::text_box_base::read_only ( bool value)
virtual

Sets a value indicating whether text in the text box is read-only.

Parameters
valuetrue if the text box is read-only; otherwise, false. The default is false.
Returns
Current text_box_base instance.
Remarks
When this property is set to true, the contents of the control cannot be changed by the user at runtime. With this property set to true, you can still set the value of the Text property in code. You can use this feature instead of disabling the control with the Enabled property to allow the contents to be copied and ToolTips to be shown.

◆ selection_length() [1/2]

virtual xtd::usize xtd::forms::text_box_base::selection_length ( ) const
virtualnoexcept

Gets the number of characters selected in the text box.

Returns
The number of characters selected in the text box.
Remarks
You can use this property to determine if any characters are currently selected in the text box control before performing operations on the selected text. When the value of the selection_length property is set to a value that is larger than the number of characters within the text of the control, the value of the selection_length property is set to the entire length of text within the control minus the value of the selection_start property (if any value is specified for the selection_start property).

Reimplemented in xtd::forms::text_box.

◆ selection_length() [2/2]

virtual text_box_base & xtd::forms::text_box_base::selection_length ( xtd::usize value)
virtual

Sets the number of characters selected in the text box.

Parameters
valueThe number of characters selected in the text box.
Returns
Current text_box_base instance.
Remarks
You can use this property to determine if any characters are currently selected in the text box control before performing operations on the selected text. When the value of the selection_length property is set to a value that is larger than the number of characters within the text of the control, the value of the selection_length property is set to the entire length of text within the control minus the value of the selection_start property (if any value is specified for the selection_start property).

Reimplemented in xtd::forms::text_box.

◆ selection_start() [1/2]

virtual xtd::usize xtd::forms::text_box_base::selection_start ( ) const
virtualnoexcept

Gets o the starting point of text selected in the text box.

Returns
The starting position of text selected in the text box.
Remarks
If no text is selected in the control, this property indicates the insertion point, or caret, for new text. If you set this property to a location beyond the length of the text in the control, the selection start position will be placed after the last character. When text is selected in the text box control, changing this property might decrease the value of the SelectionLength property. If the remaining text in the control after the position indicated by the selection_start property is less than the value of the selection_length property, the value of the selection_length property is automatically decreased. The value of the selection_start property never causes an increase in the selection_length property.

Reimplemented in xtd::forms::text_box.

◆ selection_start() [2/2]

virtual text_box_base & xtd::forms::text_box_base::selection_start ( xtd::usize value)
virtual

Gets o the starting point of text selected in the text box.

Parameters
valueThe starting position of text selected in the text box.
Returns
Current text_box_base instance.
Remarks
If no text is selected in the control, this property indicates the insertion point, or caret, for new text. If you set this property to a location beyond the length of the text in the control, the selection start position will be placed after the last character. When text is selected in the text box control, changing this property might decrease the value of the SelectionLength property. If the remaining text in the control after the position indicated by the selection_start property is less than the value of the selection_length property, the value of the selection_length property is automatically decreased. The value of the selection_start property never causes an increase in the selection_length property.

Reimplemented in xtd::forms::text_box.

◆ word_wrap() [1/2]

virtual bool xtd::forms::text_box_base::word_wrap ( ) const
virtualnoexcept

Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary.

Returns
true if the multiline text box control wraps words; false if the text box control automatically scrolls horizontally when the user types past the right edge of the control. The default is true.

◆ word_wrap() [2/2]

virtual text_box_base & xtd::forms::text_box_base::word_wrap ( bool value)
virtual

Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary.

Parameters
valuetrue if the multiline text box control wraps words; false if the text box control automatically scrolls horizontally when the user types past the right edge of the control. The default is true.
Returns
Current text_box_base instance.

◆ append_text()

virtual void xtd::forms::text_box_base::append_text ( const xtd::string & value)
virtual

Appends text to the current text of a text box.

Parameters
valueThe text to append to the current contents of the text box.

Reimplemented in xtd::forms::text_box.

◆ clear()

void xtd::forms::text_box_base::clear ( )

Clears all text from the text box control.

Remarks
You can use this method to clear the contents of the control instead of assigning the text property an empty string.

◆ select()

virtual void xtd::forms::text_box_base::select ( xtd::usize start,
xtd::usize length )
virtual

Selects a range of text in the text box.

Parameters
startThe position of the first character in the current text selection within the text box.
lengthThe number of characters to select.
Exceptions
argument_out_of_range_exceptionThe value of the start parameter is less than zero.

Reimplemented in xtd::forms::text_box.

◆ select_all()

void xtd::forms::text_box_base::select_all ( )

Selects all text in the text box.

Remarks
This method enables you to select all text within the control. You can use this method in conjunction with the cut method, which requires text to be selected in the control, to cut the entire contents of the control and paste them into the clipboard.

◆ create_params()

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

◆ default_cursor()

forms::cursor xtd::forms::text_box_base::default_cursor ( ) const
overrideprotectedvirtualnoexcept

Gets the default cursor for the control.

Returns
An object of type xtd::forms::cursor representing the current default cursor.

Reimplemented from xtd::forms::control.

◆ on_accepts_tab_changed()

virtual void xtd::forms::text_box_base::on_accepts_tab_changed ( const event_args & e)
protectedvirtual

Raises the text_box_base::accepts_tab_changed event.

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

◆ on_border_style_changed()

virtual void xtd::forms::text_box_base::on_border_style_changed ( const event_args & e)
protectedvirtual

Raises the text_box_base::border_style_changed event.

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

◆ on_multiline_changed()

virtual void xtd::forms::text_box_base::on_multiline_changed ( const event_args & e)
protectedvirtual

Raises the text_box_base::text_box_base::multiline_changed event.

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

◆ on_read_only_changed()

virtual void xtd::forms::text_box_base::on_read_only_changed ( const event_args & e)
protectedvirtual

Raises the text_box_base::read_only_changed event.

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

Member Data Documentation

◆ accepts_tab_changed

event<text_box_base, event_handler> xtd::forms::text_box_base::accepts_tab_changed

Occurs when the value of the accepts_tab property has changed.

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

◆ border_style_changed

event<text_box_base, event_handler> xtd::forms::text_box_base::border_style_changed

Occurs when the value of the accepts_tab border_style has changed.

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

◆ multiline_changed

event<text_box_base, event_handler> xtd::forms::text_box_base::multiline_changed

Occurs when the value of the accepts_tab border_style has changed.

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

◆ read_only_changed

event<text_box_base, event_handler> xtd::forms::text_box_base::read_only_changed

Occurs when the value of the read_only 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: