xtd - Reference Guide  0.1.1
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Public Attributes | Public Member Functions | Protected Member Functions | List of all members
xtd::forms::text_box Class Reference

#include <text_box.h>

Definition

Represents a standard Windows text box.

Namespace
xtd::forms
Library
xtd.forms
Examples
The following code example demonstrate the use of text box control.
#include <xtd/xtd>
using namespace xtd::forms;
namespace examples {
class form1 : public form {
public:
form1() {
text("Text box example");
text_box1.parent(*this);
text_box1.location({10, 10});
text_box1.text_changed += [&] {
text_box2.text(text_box1.text());
};
text_box1.text("text box");
text_box2.parent(*this);
text_box2.location({10, 50});
text_box2.text_changed += [&] {
text_box1.text(text_box2.text());
};
active_control(text_box2);
}
private:
text_box text_box1;
text_box text_box2;
};
}
int main() {
application::run(examples::form1());
}
static void run()
Begins running a standard application message loop on the current thread, without a form.
const xtd::ustring & text() const override
Gets the text associated with this control.
text_box()
initializes a new instance of the text_box class.
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition: about_box.h:13

Inherits xtd::forms::text_box_base.

Public Attributes

event< text_box, event_handleraccepts_return_changed
 Occurs when the value of the accepts_return property has changed. More...
 
- Public Attributes inherited from xtd::forms::text_box_base
event< text_box_base, event_handleraccepts_tab_changed
 Occurs when the value of the accepts_tab property has changed. More...
 
event< text_box_base, event_handlerborder_style_changed
 Occurs when the value of the accepts_tab border_style has changed. More...
 
event< text_box_base, event_handlermultiline_changed
 Occurs when the value of the accepts_tab border_style has changed. More...
 
event< text_box_base, event_handlerread_only_changed
 Occurs when the value of the read_only property has changed. More...
 
- Public Attributes inherited from xtd::forms::control
event< control, event_handlerauto_size_changed
 Occurs when the value of the auto_size property changes. More...
 
event< control, event_handlerback_color_changed
 Occurs when the value of the back_color property changes. More...
 
event< control, event_handlerbackground_image_changed
 Occurs when the value of the background_image property changes. More...
 
event< control, event_handlerbackground_image_layout_changed
 Occurs when the value of the background_image_layout property changes. More...
 
event< control, event_handlerclick
 Occurs when the control is clicked. More...
 
event< control, event_handlerclient_size_changed
 Occurs when the value of the client_size property changes. More...
 
event< control, control_event_handlercontrol_added
 Occurs when a new control is added to the control::control_collection. More...
 
event< control, control_event_handlercontrol_removed
 Occurs when a new control is removed to the control::control_collection. More...
 
event< control, event_handlercursor_changed
 Occurs when the value of the cursor property changes. More...
 
event< control, event_handlerdock_changed
 Occurs when the value of the dock property changes. More...
 
event< control, event_handlerdouble_click
 Occurs when the control is double-clicked. More...
 
event< control, event_handlerenabled_changed
 Occurs when the value of the enabled property changes. More...
 
event< control, event_handlerfont_changed
 Occurs when the value of the font property changes. More...
 
event< control, event_handlerfore_color_changed
 Occurs when the value of the fore_color property changes. More...
 
event< control, event_handlergot_focus
 Occurs when the control receives focus. More...
 
event< control, event_handlerhandle_created
 Occurs when a handle is created for the control. More...
 
event< control, event_handlerhandle_destroyed
 Occurs when the control's handle is in the process of being destroyed. More...
 
event< control, key_event_handlerkey_down
 Occurs when a key is pressed while the control has focus. More...
 
event< control, key_press_event_handlerkey_press
 Occurs when a character. space or backspace key is pressed while the control has focus. More...
 
event< control, key_event_handlerkey_up
 Occurs when a key is released while the control has focus. More...
 
event< control, event_handlerlayout
 Occurs when a control should reposition its child controls. More...
 
event< control, event_handlerlocation_changed
 Occurs when the value of the location property changes. More...
 
event< control, event_handlerlost_focus
 Occurs when the control loses focus. More...
 
event< control, mouse_event_handlermouse_click
 Occurs when the control is clicked by the mouse. More...
 
event< control, mouse_event_handlermouse_double_click
 Occurs when the control is double clicked by the mouse. More...
 
event< control, mouse_event_handlermouse_down
 Occurs when the mouse pointer is over the control and a mouse button is pressed. More...
 
event< control, event_handlermouse_enter
 Occurs when the mouse pointer enters the control. More...
 
event< control, mouse_event_handlermouse_horizontal_wheel
 Occurs when the mouse horizontal wheel moves while the control has focus. More...
 
event< control, event_handlermouse_leave
 Occurs when the mouse pointer leaves the control. More...
 
event< control, mouse_event_handlermouse_move
 Occurs when the mouse pointer is moved over the control. More...
 
event< control, mouse_event_handlermouse_up
 Occurs when the mouse pointer is over the control and a mouse button is released. More...
 
event< control, mouse_event_handlermouse_wheel
 Occurs when the mouse wheel moves while the control has focus. More...
 
event< control, paint_event_handlerpaint
 Occurs when the control is redrawn. More...
 
event< control, event_handlerparent_changed
 Occurs when the value of the parent property changes. More...
 
event< control, event_handlerresize
 Occurs when the control is resized. More...
 
event< control, event_handlersize_changed
 Occurs when the value of the size property changes. More...
 
event< control, event_handlertext_changed
 Occurs when the value of the text property changes. More...
 
event< control, event_handlervisible_changed
 Occurs when the value of the visible property changes. More...
 

Public Member Functions

 text_box ()
 initializes a new instance of the text_box class. More...
 
virtual bool accepts_return () const
 Gets a value indicating whether pressing ENTER in a multiline text_box control creates a new line of text in the control or activates the default button for the form. More...
 
virtual text_boxaccepts_return (bool value)
 Sets a value indicating whether pressing ENTER in a multiline text_box control creates a new line of text in the control or activates the default button for the form. More...
 
void append_text (const xtd::ustring &value) override
 Appends text to the current text of a text box. More...
 
virtual xtd::forms::character_casing character_casing () const
 Gets whether the text_box control modifies the case of characters as they are typed. More...
 
virtual text_boxcharacter_casing (xtd::forms::character_casing value)
 Sets whether the text_box control modifies the case of characters as they are typed. More...
 
drawing::color default_back_color () const override
 Gets the default background color of the control. More...
 
drawing::color default_fore_color () const override
 Gets the default foreground color of the control. More...
 
drawing::size default_size () const override
 Gets the default size of the control. More...
 
virtual char32_t password_char () const
 Gets the character used to mask characters of a password in a single-line TextBox control. More...
 
virtual text_boxpassword_char (char32_t value)
 Sets the character used to mask characters of a password in a single-line TextBox control. More...
 
void select (size_t start, size_t length) override
 Selects a range of text in the text box. More...
 
virtual size_t selection_length () const
 Gets the number of characters selected in the text box. More...
 
size_t selection_length () const override
 Gets the number of characters selected in the text box. More...
 
virtual text_box_baseselection_length (size_t value)
 Sets the number of characters selected in the text box. More...
 
virtual size_t selection_start () const
 Gets o the starting point of text selected in the text box. More...
 
size_t selection_start () const override
 Gets o the starting point of text selected in the text box. More...
 
virtual text_box_baseselection_start (size_t value)
 Gets o the starting point of text selected in the text box. More...
 
const xtd::ustringtext () const override
 Gets the text associated with this control. More...
 
controltext (const xtd::ustring &text) override
 Sets the text associated with this control. More...
 
virtual bool use_system_password_char () const
 Gets a value indicating whether the text in the TextBox control should appear as the default password character. More...
 
virtual text_boxuse_system_password_char (bool value)
 Sets a value indicating whether the text in the TextBox control should appear as the default password character. More...
 
- Public Member Functions inherited from xtd::forms::text_box_base
virtual bool accepts_tab () const
 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. More...
 
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. More...
 
virtual forms::border_style border_style () const
 Gets the border type of the text box control. More...
 
virtual text_box_baseborder_style (forms::border_style border_style)
 Sets the border type of the text box control. More...
 
void clear ()
 Clears all text from the text box control. More...
 
forms::cursor default_cursor () const override
 Gets the default cursor for the control. More...
 
std::vector< xtd::ustringlines () const
 Gets the lines of text in a text box control. More...
 
text_box_baselines (const std::vector< xtd::ustring > &lines)
 Sets the lines of text in a text box control. More...
 
virtual bool multiline () const
 Gets a value indicating whether this is a multiline text box control. More...
 
virtual text_box_basemultiline (bool value)
 Sets a value indicating whether this is a multiline text box control. More...
 
virtual bool read_only () const
 Gets a value indicating whether text in the text box is read-only. More...
 
virtual text_box_baseread_only (bool value)
 Sets a value indicating whether text in the text box is read-only. More...
 
void select_all ()
 Selects all text in the text box. More...
 
virtual text_box_baseselection_length (size_t value)
 Sets the number of characters selected in the text box. More...
 
virtual text_box_baseselection_start (size_t value)
 Gets o the starting point of text selected in the text box. More...
 
virtual bool word_wrap () const
 Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary. More...
 
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. More...
 
- Public Member Functions inherited from xtd::forms::control
 control ()
 Initializes a new instance of the control class with default settings. More...
 
 control (const control &parent, const xtd::ustring &text)
 Initializes a new instance of the control class as a child control, with specific text. 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 control class as a child control, with specific text, size, and location. More...
 
 control (const xtd::ustring &text)
 Initializes a new instance of the control class 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...
 
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 bool auto_size () const
 Gets a value that indicates whether the control resizes based on its contents. More...
 
virtual controlauto_size (bool auto_size)
 Sets a value that indicates whether the control resizes based on its contents. 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...
 
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 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 void bring_to_front ()
 Brings the control to the front of the z-order. More...
 
virtual bool can_focus () const
 Gets a value indicating whether the control can receive focus. More...
 
bool can_raise_events () const override
 Determines if events can be raised on the control. More...
 
virtual bool can_select () const
 Gets a value indicating whether the control can be selected. 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 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...
 
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 create_handle ()
 Creates a handle for 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::font default_font () const
 Gets the default font of 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...
 
virtual void destroy_handle ()
 Destroys the handle associated with 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 or sets 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 or 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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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_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_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...
 
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...
 
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)
 Computes the location of the specified screen point into client coordinates. More...
 
xtd::drawing::point point_to_screen (const xtd::drawing::point &p)
 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 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 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...
 
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...
 
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...
 
virtual const drawing::sizesize () 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...
 
void suspend_layout ()
 Temporarily suspends the layout logic for the control. 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...
 
xtd::ustring to_string () const noexcept override
 Returns a string containing the name of the control, if any. 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 void update () const
 Causes the control to redraw the invalidated regions within its client area. 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...
 
- 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...
 

Protected Member Functions

forms::create_params create_params () const override
 Gets the required creation parameters when the control handle is created. More...
 
drawing::size measure_control () const override
 Measure this control. More...
 
virtual void on_accepts_return_changed (const event_args &e)
 Raises the text_box::accepts_return_changed event. More...
 
void on_handle_created (const event_args &e) override
 Raises the control::handle_created event. More...
 
void on_text_changed (const event_args &e) override
 Raises the control::text_changed event. More...
 
void wnd_proc (message &message) override
 Processes Windows messages. More...
 
- Protected Member Functions inherited from xtd::forms::text_box_base
 text_box_base ()=default
 initializes a new instance of the text_box_base class. More...
 
virtual void on_accepts_tab_changed (const event_args &e)
 Raises the text_box_base::accepts_tab_changed event. More...
 
virtual void on_border_style_changed (const event_args &e)
 Raises the text_box_base::border_style_changed event. More...
 
virtual void on_multiline_changed (const event_args &e)
 Raises the text_box_base::text_box_base::multiline_changed event. More...
 
virtual void on_read_only_changed (const event_args &e)
 Raises the text_box_base::read_only_changed event. More...
 
- Protected Member Functions inherited from xtd::forms::control
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 control::auto_size_changed event. More...
 
virtual void on_back_color_changed (const event_args &e)
 Raises the control::back_color_changed event. More...
 
virtual void on_background_image_changed (const event_args &e)
 Raises the control::background_image_changed event. More...
 
virtual void on_background_image_layout_changed (const event_args &e)
 Raises the control::background_image_layout_changed event. More...
 
virtual void on_click (const event_args &e)
 Raises the control::click event. More...
 
virtual void on_client_size_changed (const event_args &e)
 Raises the control::client_size_changed event. More...
 
virtual void on_control_added (const control_event_args &e)
 Raises the control::control_added event. More...
 
virtual void on_control_removed (const control_event_args &e)
 Raises the control::control_removed event. More...
 
virtual void on_create_control ()
 Raises the control::create_control event. More...
 
virtual void on_cursor_changed (const event_args &e)
 Raises the control::cursor_changed event. More...
 
virtual void on_dock_changed (const event_args &e)
 Raises the control::dock_changed event. More...
 
virtual void on_double_click (const event_args &e)
 Raises the double_click event. More...
 
virtual void on_enabled_changed (const event_args &e)
 Raises the control::enabled_changed event. More...
 
virtual void on_font_changed (const event_args &e)
 Raises the control::font_changed event. More...
 
virtual void on_fore_color_changed (const event_args &e)
 Raises the control::fore_color_changed event. More...
 
virtual void on_got_focus (const event_args &e)
 Raises the control::got_focus event. More...
 
virtual void on_handle_destroyed (const event_args &e)
 Raises the control::handle_destroyed event. More...
 
virtual void on_key_down (key_event_args &e)
 Raises the control::key_down event. More...
 
virtual void on_key_press (key_press_event_args &e)
 Raises the control::key_press event. More...
 
virtual void on_key_up (key_event_args &e)
 Raises the control::key_up event. More...
 
virtual void on_layout (const event_args &e)
 Raises the control::layout event. More...
 
virtual void on_location_changed (const event_args &e)
 Raises the control::location_changed event. More...
 
virtual void on_lost_focus (const event_args &e)
 Raises the control::lost_focus event. More...
 
virtual void on_mouse_click (const mouse_event_args &e)
 Raises the control::mouse_click event. More...
 
virtual void on_mouse_double_click (const mouse_event_args &e)
 Raises the control::mouse_double_click event. More...
 
virtual void on_mouse_down (const mouse_event_args &e)
 Raises the control::mouse_down event. More...
 
virtual void on_mouse_enter (const event_args &e)
 Raises the control::mouse_enter event. More...
 
virtual void on_mouse_horizontal_wheel (const mouse_event_args &e)
 Raises the control::mouse_horizontal_wheel event. More...
 
virtual void on_mouse_leave (const event_args &e)
 Raises the control::mouse_leave event. More...
 
virtual void on_mouse_move (const mouse_event_args &e)
 Raises the control::mouse_move event. More...
 
virtual void on_mouse_up (const mouse_event_args &e)
 Raises the control::mouse_up event. More...
 
virtual void on_mouse_wheel (const mouse_event_args &e)
 Raises the control::mouse_wheel event. More...
 
virtual void on_paint (paint_event_args &e)
 Raises the control::paint event. More...
 
virtual void on_parent_back_color_changed (const event_args &e)
 Raises the control::parent_back_color_changed event. More...
 
virtual void on_parent_changed (const event_args &e)
 Raises the control::parent_changed event. More...
 
virtual void on_parent_cursor_changed (const event_args &e)
 Raises the control::parent_cursor_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 control::parent_font_changed event. More...
 
virtual void on_parent_fore_color_changed (const event_args &e)
 Raises the control::parent_fore_color_changed event. More...
 
virtual void on_resize (const event_args &e)
 Raises the control::resize event. More...
 
virtual void on_size_changed (const event_args &e)
 Raises the control::size_changed event. More...
 
virtual void on_visible_changed (const event_args &e)
 Raises the control::visible_changed event. More...
 
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...
 
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_style (control_styles flag, bool value)
 Sets a specified control_styles flag to either true or false. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from xtd::forms::control
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 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...
 
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 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...
 
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 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 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...
 

Constructor & Destructor Documentation

◆ text_box()

xtd::forms::text_box::text_box ( )

initializes a new instance of the text_box class.

Member Function Documentation

◆ accepts_return() [1/2]

virtual bool xtd::forms::text_box::accepts_return ( ) const
inlinevirtual

Gets a value indicating whether pressing ENTER in a multiline text_box control creates a new line of text in the control or activates the default button for the form.

Returns
true if the ENTER key creates a new line of text in a multiline version of the control; false if the ENTER key activates the default button for the form. The default is false.
Remarks
If the value of this property is false, the user must press CTRL+ENTER to create a new line in a multiline text_box control. If there is no default button for the form, the ENTER key will always create a new line of text in the control, regardless of the value of this property.

◆ accepts_return() [2/2]

virtual text_box& xtd::forms::text_box::accepts_return ( bool  value)
inlinevirtual

Sets a value indicating whether pressing ENTER in a multiline text_box control creates a new line of text in the control or activates the default button for the form.

Parameters
valuetrue if the ENTER key creates a new line of text in a multiline version of the control; false if the ENTER key activates the default button for the form. The default is false.
Returns
Current text_box instance.
Remarks
If the value of this property is false, the user must press CTRL+ENTER to create a new line in a multiline text_box control. If there is no default button for the form, the ENTER key will always create a new line of text in the control, regardless of the value of this property.

◆ append_text()

void xtd::forms::text_box::append_text ( const xtd::ustring value)
overridevirtual

Appends text to the current text of a text box.

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

Reimplemented from xtd::forms::text_box_base.

◆ character_casing() [1/2]

virtual xtd::forms::character_casing xtd::forms::text_box::character_casing ( ) const
inlinevirtual

Gets whether the text_box control modifies the case of characters as they are typed.

Returns
One of the xtd::forms::character_casing enumeration values that specifies whether the text_box control modifies the case of characters. The default is xtd::forms::character_casing::normal.
Remarks
You can use the character_casing property to change the case of characters as required by your application. For example, you could change the case of all characters entered in a text_box control used for password entry to uppercase or lowercase to enforce a policy for passwords.

◆ character_casing() [2/2]

virtual text_box& xtd::forms::text_box::character_casing ( xtd::forms::character_casing  value)
virtual

Sets whether the text_box control modifies the case of characters as they are typed.

Parameters
valueOne of the xtd::forms::character_casing enumeration values that specifies whether the text_box control modifies the case of characters. The default is xtd::forms::character_casing::normal.
Returns
Current text_box instance.
Remarks
You can use the character_casing property to change the case of characters as required by your application. For example, you could change the case of all characters entered in a text_box control used for password entry to uppercase or lowercase to enforce a policy for passwords.

◆ create_params()

forms::create_params xtd::forms::text_box::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.
Remarks
The create_params property should not be overridden and used to adjust the properties of your derived control. Properties such as the create_params::caption, create_params::width, and create_params::height should be set by the corresponding properties in your control such as control::text, control::width and control::height. The create_params should only be extended when you are wrapping a standard Windows control class or to set styles not provided by the forms namespace.
Notes for inheritors
When overriding the create_params property in a derived class, use the base class's create_params property to extend the base implementation. Otherwise, you must provide all the implementation.

Reimplemented from xtd::forms::control.

◆ default_back_color()

drawing::color xtd::forms::text_box::default_back_color ( ) const
inlineoverridevirtual

Gets the default background color of the control.

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

Reimplemented from xtd::forms::control.

◆ default_fore_color()

drawing::color xtd::forms::text_box::default_fore_color ( ) const
inlineoverridevirtual

Gets the default foreground color of the control.

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

Reimplemented from xtd::forms::control.

◆ default_size()

drawing::size xtd::forms::text_box::default_size ( ) const
inlineoverridevirtual

Gets the default size of the control.

Returns
The default size of the control.

Reimplemented from xtd::forms::control.

◆ measure_control()

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

Measure this control.

Returns
The drawing::size size of this control.

Reimplemented from xtd::forms::control.

◆ on_accepts_return_changed()

virtual void xtd::forms::text_box::on_accepts_return_changed ( const event_args e)
inlineprotectedvirtual

Raises the text_box::accepts_return_changed event.

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

◆ on_handle_created()

void xtd::forms::text_box::on_handle_created ( const event_args e)
overrideprotectedvirtual

Raises the control::handle_created event.

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

Reimplemented from xtd::forms::control.

◆ on_text_changed()

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

Raises the control::text_changed event.

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

Reimplemented from xtd::forms::control.

◆ password_char() [1/2]

virtual char32_t xtd::forms::text_box::password_char ( ) const
inlinevirtual

Gets the character used to mask characters of a password in a single-line TextBox control.

Returns
The character used to mask characters entered in a single-line text_box control. Set the value of this property to '0' (U+0000) if you do not want the control to mask characters as they are typed. The default value is '0' (U+0000).
Remarks
The use_system_password_char property has precedence over the password_char property. Whenever the use_system_password_char is set to true, the default system password character is used and any character set by password_char is ignored.
When the password_char property is set, cut and copy actions in the control using the keyboard cannot be performed.

◆ password_char() [2/2]

virtual text_box& xtd::forms::text_box::password_char ( char32_t  value)
virtual

Sets the character used to mask characters of a password in a single-line TextBox control.

Parameters
valueThe character used to mask characters entered in a single-line text_box control. Set the value of this property to '0' (U+0000) if you do not want the control to mask characters as they are typed. The default value is '0' (U+0000).
Returns
Current text_box instance.
Remarks
The use_system_password_char property has precedence over the password_char property. Whenever the use_system_password_char is set to true, the default system password character is used and any character set by password_char is ignored.
When the password_char property is set, cut and copy actions in the control using the keyboard cannot be performed.

◆ select()

void xtd::forms::text_box::select ( size_t  start,
size_t  length 
)
overridevirtual

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

◆ selection_length() [1/3]

virtual size_t xtd::forms::text_box_base::selection_length
inline

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

◆ selection_length() [2/3]

size_t xtd::forms::text_box::selection_length ( ) const
overridevirtual

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

◆ selection_length() [3/3]

virtual text_box_base& xtd::forms::text_box_base::selection_length
inline

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

◆ selection_start() [1/3]

virtual size_t xtd::forms::text_box_base::selection_start
inline

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.

◆ selection_start() [2/3]

size_t xtd::forms::text_box::selection_start ( ) const
overridevirtual

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

◆ selection_start() [3/3]

virtual text_box_base& xtd::forms::text_box_base::selection_start
inline

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.

◆ text() [1/2]

const xtd::ustring& xtd::forms::text_box::text ( ) const
overridevirtual

Gets the text associated with this control.

Returns
The text associated with this control.

Reimplemented from xtd::forms::control.

◆ text() [2/2]

control& xtd::forms::text_box::text ( const xtd::ustring text)
overridevirtual

Sets the text associated with this control.

Parameters
textThe text associated with this control.
Returns
Current control.

Reimplemented from xtd::forms::control.

◆ use_system_password_char() [1/2]

virtual bool xtd::forms::text_box::use_system_password_char ( ) const
inlinevirtual

Gets a value indicating whether the text in the TextBox control should appear as the default password character.

Returns
true if the text in the TextBox control should appear as the default password character; otherwise, false.
Remarks
The use_system_password_char property has precedence over the password_char property. Whenever the use_system_password_char is set to true, the default system password character is used and any character set by password_char is ignored.

◆ use_system_password_char() [2/2]

virtual text_box& xtd::forms::text_box::use_system_password_char ( bool  value)
virtual

Sets a value indicating whether the text in the TextBox control should appear as the default password character.

Parameters
valuetrue if the text in the TextBox control should appear as the default password character; otherwise, false.
Returns
Current text_box instance.
Remarks
The use_system_password_char property has precedence over the password_char property. Whenever the use_system_password_char is set to true, the default system password character is used and any character set by password_char is ignored.

◆ wnd_proc()

void xtd::forms::text_box::wnd_proc ( message message)
overrideprotectedvirtual

Processes Windows messages.

Parameters
mThe Windows Message to process.
Remarks
All messages are sent to the wnd_proc method after getting filtered through the pre_process_message method.

Reimplemented from xtd::forms::control.


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