Definition

Represents a common dialog box that displays input dialog.

Header: #include <xtd/forms/input_dialog>

Namespace: xtd::forms

Library: xtd.forms

Appearance

	Windows	macOS	Gnome
Light	html dialog_input_dialog_m.png html dialog_input_dialog_g.png
Dark	html dialog_input_dialog_md.png html dialog_input_dialog_gd.png

Examples: The following code example demonstrates the use of input_dialog dialog.
#include <xtd/forms/application>
#include <xtd/forms/button>
#include <xtd/forms/form>
#include <xtd/forms/input_dialog>
#include <xtd/forms/label>
using namespace xtd::forms;
namespace input_dialog_example {
class form1 : public form {
public:
form1() {
text("Input dialog example");
controls().push_back_range({button1, label1});

button1.location({10, 10});
button1.text("Text...");
button1.click += [&] {
auto dialog = input_dialog {};
dialog.text("Caption text");
dialog.message("Message text");
dialog.value(label1.text());
if (dialog.show_sheet_dialog(*this) == dialog_result::ok)
label1.text(dialog.value());
};

label1.location({10, 50});
label1.auto_size(true);
label1.text("Default value");
}

private:
button button1;
label label1;
};
}
auto main()->int {
application::run(input_dialog_example::form1 {});
}

Examples: The following code example demonstrates the use of input_dialog dialog with multiline.
#include <xtd/forms/application>
#include <xtd/forms/button>
#include <xtd/forms/form>
#include <xtd/forms/input_dialog>
#include <xtd/forms/label>
using namespace xtd;
using namespace xtd::forms;
namespace input_dialog_multiline_example {
class form1 : public form {
public:
form1() {
auto_scroll(true);
text("Input dialog multiline example");
controls().push_back_range({button1, label1});

button1.location({10, 10});
button1.auto_size(true);
button1.text("Lines...");
button1.click += [&] {
input_dialog input_dialog;
input_dialog.multiline(true);
input_dialog.word_wrap(false);
input_dialog.text("Enter lines");
input_dialog.value(label1.text());
if (input_dialog.show_dialog(*this) == dialog_result::ok)
label1.text(input_dialog.value());
};

label1.location({10, 50});
label1.auto_size(true);
label1.text("line 1\nline 2");
}

private:
button button1;
label label1;
};
}
auto main()->int {
application::run(input_dialog_multiline_example::form1 {});
}

Examples: The following code example demonstrates the use of input_dialog dialog with password.
#include <xtd/forms/application>
#include <xtd/forms/button>
#include <xtd/forms/form>
#include <xtd/forms/input_dialog>
#include <xtd/forms/label>
using namespace xtd;
using namespace xtd::forms;
namespace input_dialog_password_example {
class form1 : public form {
public:
form1() {
text("Input dialog password example");
controls().push_back_range({button1, label1});

button1.location({10, 10});
button1.auto_size(true);
button1.text("Password...");
button1.click += [&] {
input_dialog input_dialog;
input_dialog.text("User password");
input_dialog.message("user: admin");
input_dialog.use_system_password_char(true);
input_dialog.value(label1.text());
if (input_dialog.show_sheet_dialog(*this) == dialog_result::ok)
label1.text(input_dialog.value());
};

label1.location({10, 50});
label1.auto_size(true);
label1.text("sysad47@74dasys");
}

private:
button button1;
label label1;
};
}
auto main()->int {
application::run(input_dialog_password_example::form1 {});
}

Examples:: input_dialog.cpp, input_dialog_multiline.cpp, and input_dialog_password.cpp.

Constructors
	input_dialog ()
	Initializes a new instance of the input_dialog class. More...

Properties
xtd::forms::character_casing	character_casing () const noexcept
	Gets the character casing. More...

input_dialog &	character_casing (xtd::forms::character_casing character_casing)
	Sets the character casing. More...

xtd::forms::dialog_appearance	dialog_appearance () const noexcept
	Gets the dialog appearance. More...

input_dialog &	dialog_appearance (xtd::forms::dialog_appearance dialog_appearance)
	Sets the dialog appearance. More...

bool	multiline () const noexcept
	Gets multiline status. More...

input_dialog &	multiline (bool multiline)
	Sets multiline status. More...

xtd::ustring	message () const noexcept
	Gets the text message. More...

input_dialog &	message (const xtd::ustring &message)
	Sets the text message. More...

xtd::ustring	text () const noexcept
	Gets the dialog caption text. More...

input_dialog &	text (const xtd::ustring &text)
	Sets the dialog caption text. More...

bool	use_system_password_char () const noexcept
	Gets use system password char status. More...

input_dialog &	use_system_password_char (bool use_system_password_char)
	Sets use system password char status. More...

xtd::ustring	value () const noexcept
	Gets the value. More...

input_dialog &	value (const xtd::ustring &value)
	Sets the value. More...

bool	word_wrap () const noexcept
	Gets word wrap status. More...

input_dialog &	word_wrap (bool word_wrap)
	Sets word wrap status. More...

Methods
void	reset () noexcept override
	Resets all properties to empty string. More...

Protected methods
bool	run_dialog (intptr owner) override
	When overridden in a derived class, specifies a common dialog box. More...

void	run_sheet (intptr owner) override
	When overridden in a derived class, specifies a common dialog box. More...

Additional Inherited Members
Public Attributes inherited from xtd::forms::common_dialog
event< common_dialog, help_event_handler >	help_request
	Occurs when the user clicks the Help button on a common dialog box. More...

event< common_dialog, dialog_closed_event_handler >	dialog_closed
	Occurs when the user close a common dialog box with dialog close button or other dialog buttons. More...

Public Member Functions inherited from xtd::forms::common_dialog
	common_dialog ()
	Initializes a new instance of the common_dialog class. More...

xtd::forms::dialog_result	dialog_result () const noexcept
	Gets async dialog_result result after dialog box is closing. More...

std::any	tag () const noexcept
	Gets an object that contains data about the control. More...

common_dialog &	tag (const std::any &tag)
	Sets an object that contains data about the control. More...

xtd::forms::dialog_result	show_dialog ()
	Runs a common dialog box with a default owner. More...

xtd::forms::dialog_result	show_dialog (const iwin32_window &owner)
	Runs a common dialog box with the specified owner. More...

void	show_sheet (const iwin32_window &owner)
	Runs a common dialog box with the specified owner. More...

xtd::forms::dialog_result	show_sheet_dialog (const iwin32_window &owner)
	Runs a common dialog box with the specified owner. More...

Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...

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

virtual type_object	get_type () const noexcept
	Gets the type of the current instance. More...

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object. More...

virtual xtd::ustring	to_string () const noexcept
	Returns a sxd::ustring that represents the current object. More...

Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal. More...

static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance. More...

Protected Member Functions inherited from xtd::forms::common_dialog
virtual void	on_dialog_closed (const dialog_closed_event_args &e)
	Raises the common_dialog::dialog_close event. More...

virtual void	on_help_request (help_event_args &e)
	Raises the common_dialog::help_request event. More...

void	set_dialog_result (xtd::forms::dialog_result value)
	Sets async dialog_result result after dialog box is closing. More...

Protected Member Functions inherited from xtd::forms::component
	component ()
	Initialises a new instance of the component class. More...

virtual bool	can_raise_events () const noexcept
	Gets a value indicating whether the component can raise an event. More...

bool	design_mode () const noexcept
	Gets a value that indicates whether the component is currently in design mode. More...

Constructor & Destructor Documentation

◆ input_dialog()

xtd::forms::input_dialog::input_dialog ( )

Initializes a new instance of the input_dialog class.

Member Function Documentation

◆ character_casing() [1/2]

xtd::forms::character_casing xtd::forms::input_dialog::character_casing ( ) const

noexcept

Gets the character casing.

Returns: One of the xtd::forms::character_casing values. The default value is xtd::forms::character_casing::normal.

◆ character_casing() [2/2]

input_dialog& xtd::forms::input_dialog::character_casing ( xtd::forms::character_casing character_casing )

Sets the character casing.

Parameters

dialog_appearance One of the xtd::forms::character_casing values. The default value is xtd::forms::character_casing::normal.

Returns: Current input instance.

◆ dialog_appearance() [1/2]

xtd::forms::dialog_appearance xtd::forms::input_dialog::dialog_appearance ( ) const

noexcept

Gets the dialog appearance.

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

◆ dialog_appearance() [2/2]

input_dialog& xtd::forms::input_dialog::dialog_appearance ( xtd::forms::dialog_appearance dialog_appearance )

Sets the dialog appearance.

Parameters

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

Returns: Current input instance.

◆ message() [1/2]

xtd::ustring xtd::forms::input_dialog::message ( ) const

noexcept

Gets the text message.

Returns: The text message.

Examples:: input_dialog_password.cpp.

◆ message() [2/2]

input_dialog& xtd::forms::input_dialog::message ( const xtd::ustring & message )

Sets the text message.

Parameters

message The text message.

Returns: Current input_dialog instance.

◆ multiline() [1/2]

bool xtd::forms::input_dialog::multiline ( ) const

noexcept

Gets multiline status.

Returns: true if dialog text box is multiline; otherwise false.

Remarks: The default value is false.

Examples:: input_dialog_multiline.cpp.

◆ multiline() [2/2]

input_dialog& xtd::forms::input_dialog::multiline ( bool multiline )

Sets multiline status.

Parameters

multiline true if dialog text box is multiline; otherwise false.

Returns: Current input_dialog instance.

Remarks: The default value is false.

◆ reset()

void xtd::forms::input_dialog::reset ( )

overridevirtualnoexcept

Resets all properties to empty string.

Implements xtd::forms::common_dialog.

◆ run_dialog()

bool xtd::forms::input_dialog::run_dialog ( intptr hwnd_owner )

overrideprotectedvirtual

When overridden in a derived class, specifies a common dialog box.

Parameters

hwnd_owner A value that represents the window handle of the owner window for the common dialog box.

Returns: true if the dialog box was successfully run; otherwise, false.

Implements xtd::forms::common_dialog.

◆ run_sheet()

void xtd::forms::input_dialog::run_sheet ( intptr hwnd_owner )

overrideprotectedvirtual

When overridden in a derived class, specifies a common dialog box.

Parameters

hwnd_owner A value that represents the window handle of the owner window for the common dialog box.

Returns: true if the dialog box was successfully run; otherwise, false.

Remarks: The result will done in async. Check result_dialog property after dialog box closed to obtain the result.

Implements xtd::forms::common_dialog.

◆ text() [1/2]

xtd::ustring xtd::forms::input_dialog::text ( ) const

noexcept

Gets the dialog caption text.

Returns: The current dialog caption text.

Examples:: input_dialog.cpp, input_dialog_multiline.cpp, and input_dialog_password.cpp.

◆ text() [2/2]

input_dialog& xtd::forms::input_dialog::text ( const xtd::ustring & text )

Sets the dialog caption text.

Parameters

text	The new dialog caption text.

Returns: Current input_dialog instance.

◆ use_system_password_char() [1/2]

bool xtd::forms::input_dialog::use_system_password_char ( ) const

noexcept

Gets use system password char status.

Returns: true if dialog text box use system password char status; otherwise false.

Remarks: The default value is false.

Examples:: input_dialog_password.cpp.

◆ use_system_password_char() [2/2]

input_dialog& xtd::forms::input_dialog::use_system_password_char ( bool use_system_password_char )

Sets use system password char status.

Parameters

use_system_password_char true if dialog text box use system password char status; otherwise false.

Returns: Current input_dialog instance.

Remarks: The default value is false.

◆ value() [1/2]

xtd::ustring xtd::forms::input_dialog::value ( ) const

noexcept

Gets the value.

Returns: The value.

Examples:: input_dialog_multiline.cpp, and input_dialog_password.cpp.

◆ value() [2/2]

input_dialog& xtd::forms::input_dialog::value ( const xtd::ustring & value )

Sets the value.

Parameters

value The value.

Returns: Current input_dialog instance.

◆ word_wrap() [1/2]

bool xtd::forms::input_dialog::word_wrap ( ) const

noexcept

Gets word wrap status.

Returns: true if dialog text box is word wrap; otherwise false.

Remarks: The default value is true.

Examples:: input_dialog_multiline.cpp.

◆ word_wrap() [2/2]

input_dialog& xtd::forms::input_dialog::word_wrap ( bool word_wrap )

Sets word wrap status.

Parameters

word_wrap true if dialog text box is word wrap; otherwise false.

Returns: Current input_dialog instance.

Remarks: The default value is true.

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

xtd.forms/include/xtd/forms/input_dialog.h

Definition

Constructors

Properties

Methods

Protected methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ input_dialog()

Member Function Documentation

◆ character_casing() [1/2]

◆ character_casing() [2/2]

◆ dialog_appearance() [1/2]

◆ dialog_appearance() [2/2]

◆ message() [1/2]

◆ message() [2/2]

◆ multiline() [1/2]

◆ multiline() [2/2]

◆ reset()

◆ run_dialog()

◆ run_sheet()

◆ text() [1/2]

◆ text() [2/2]

◆ use_system_password_char() [1/2]

◆ use_system_password_char() [2/2]

◆ value() [1/2]

◆ value() [2/2]

◆ word_wrap() [1/2]

◆ word_wrap() [2/2]