Definition

Displays a message window, also known as a dialog box, which presents a message to the user. It is a modal window, blocking other actions in the application until the user closes it. A message_box can contain text, buttons, and symbols that inform and instruct the user.

Header: #include <xtd/forms/message_box>

Namespace: xtd::forms

Library: xtd.forms

Appearance

	Windows	macOS	Gnome
Light	html dialog_message_box_m.png html dialog_message_box_g.png
Dark	html dialog_message_box_md.png html dialog_message_box_gd.png

Examples: The following code example demonstrates the use of message_box dialog.
#include <xtd/forms/application>
#include <xtd/forms/button>
#include <xtd/forms/form>
#include <xtd/forms/label>
#include <xtd/forms/message_box>
using namespace xtd;
using namespace xtd::forms;
class form1 : public form {
public:
form1() {
controls().push_back_range({button_show_message, label_dialog_result});
location({400, 200});
start_position(form_start_position::manual);
text("Message box exemple");

button_show_message.location({10, 10});
button_show_message.text("Message...");
button_show_message.width(100);
button_show_message.click += [&] {
auto result = message_box::show(*this, "Hello, World!", "Message", message_box_buttons::ok_cancel, message_box_icon::warning);
label_dialog_result.text(ustring::format("dialog_result = {}", result));
};

label_dialog_result.location({10, 55});
label_dialog_result.width(200);
}

private:
button button_show_message;
label label_dialog_result;
};
auto main()->int {
application::run(form1 {});
}

Methods
static dialog_result	show (const iwin32_window &owner)
	Displays a message box in front of the specified window. More...

static dialog_result	show (const iwin32_window &owner, const xtd::ustring &text)
	Displays a message box in front of the specified window with specified text. More...

static dialog_result	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption)
	Displays a message box in front of the specified window with specified text and caption. More...

static dialog_result	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons)
	Displays a message box in front of the specified window with the specified text, caption, and buttons. More...

static dialog_result	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons, message_box_icon icon)
	Displays a message box in front of the specified window with the specified text, caption, buttons, and icon. More...

static dialog_result	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button)
	Displays a message box in front of the specified window with the specified text, caption, buttons, icon, and default button. More...

static dialog_result	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button, message_box_options options)
	Displays a message box in front of the specified window with the specified text, caption, buttons, icon, default button, and options. More...

static dialog_result	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button, message_box_options options, bool display_help_button)
	Displays a message box in front of the specified window with the specified text, caption, buttons, icon, default button, options, and Help button. More...

static dialog_result	show ()
	Displays a message box. More...

static dialog_result	show (const xtd::ustring &text)
	Displays a message box with specified text. More...

static dialog_result	show (const xtd::ustring &text, const xtd::ustring &caption)
	Displays a message box with specified text and caption. More...

static dialog_result	show (const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons)
	Displays a message box with the specified text, caption, and buttons. More...

static dialog_result	show (const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons, message_box_icon icon)
	Displays a message box with the specified text, caption, buttons, and icon. More...

static dialog_result	show (const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button)
	Displays a message box with the specified text, caption, buttons, icon, and default button. More...

static dialog_result	show (const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button, message_box_options options)
	Displays a message box with the specified text, caption, buttons, icon, default button, and options. More...

static dialog_result	show (const xtd::ustring &text, const xtd::ustring &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button, message_box_options options, bool display_help_button)
	Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button. More...

Member Function Documentation

◆ show() [1/16]

static dialog_result xtd::forms::message_box::show ( const iwin32_window & owner )

static

Displays a message box in front of the specified window.

Parameters

owner An implementation of iwin32_window that will own the modal dialog box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [2/16]

static dialog_result xtd::forms::message_box::show	(	const iwin32_window &	owner,
		const xtd::ustring &	text
	)

static

Displays a message box in front of the specified window with specified text.

Parameters

owner	An implementation of iwin32_window that will own the modal dialog box.
text	The text to display in the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [3/16]

static dialog_result xtd::forms::message_box::show	(	const iwin32_window &	owner,
		const xtd::ustring &	text,
		const xtd::ustring &	caption
	)

static

Displays a message box in front of the specified window with specified text and caption.

Parameters

owner	An implementation of iwin32_window that will own the modal dialog box.
text	The text to display in the message box.
caption	The text to display in the title bar of the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [4/16]

static dialog_result xtd::forms::message_box::show	(	const iwin32_window &	owner,
		const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons
	)

static

Displays a message box in front of the specified window with the specified text, caption, and buttons.

Parameters

owner	An implementation of iwin32_window that will own the modal dialog box.
text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [5/16]

static dialog_result xtd::forms::message_box::show	(	const iwin32_window &	owner,
		const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons,
		message_box_icon	icon
	)

static

Displays a message box in front of the specified window with the specified text, caption, buttons, and icon.

Parameters

owner	An implementation of iwin32_window that will own the modal dialog box.
text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.
icon	One of the message_box_icon values that specifies which icon to display in the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [6/16]

static dialog_result xtd::forms::message_box::show	(	const iwin32_window &	owner,
		const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons,
		message_box_icon	icon,
		message_box_default_button	default_button
	)

static

Displays a message box in front of the specified window with the specified text, caption, buttons, icon, and default button.

Parameters

owner	An implementation of iwin32_window that will own the modal dialog box.
text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.
icon	One of the message_box_icon values that specifies which icon to display in the message box.
default_button	One of the message_box_default_button values that specifies the default button for the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [7/16]

static dialog_result xtd::forms::message_box::show	(	const iwin32_window &	owner,
		const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons,
		message_box_icon	icon,
		message_box_default_button	default_button,
		message_box_options	options
	)

static

Displays a message box in front of the specified window with the specified text, caption, buttons, icon, default button, and options.

Parameters

owner	An implementation of iwin32_window that will own the modal dialog box.
text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.
icon	One of the message_box_icon values that specifies which icon to display in the message box.
default_button	One of the message_box_default_button values that specifies the default button for the message box.
options	One of the message_box_options values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [8/16]

static dialog_result xtd::forms::message_box::show	(	const iwin32_window &	owner,
		const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons,
		message_box_icon	icon,
		message_box_default_button	default_button,
		message_box_options	options,
		bool	display_help_button
	)

static

Displays a message box in front of the specified window with the specified text, caption, buttons, icon, default button, options, and Help button.

Parameters

owner	An implementation of iwin32_window that will own the modal dialog box.
text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.
icon	One of the message_box_icon values that specifies which icon to display in the message box.
default_button	One of the message_box_default_button values that specifies the default button for the message box.
options	One of the message_box_options values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
display_help_button	true to show the Help button; otherwise, false. The default is false.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [9/16]

static dialog_result xtd::forms::message_box::show ( )

static

Displays a message box.

Returns: One of the xtd::forms::dialog_result values.

Examples:: action1.cpp, action2.cpp, action3.cpp, context_menu.cpp, enable_changed_event.cpp, font_changed_event.cpp, form2.cpp, form_and_main.cpp, form_click.cpp, hello_world_message_box.cpp, hello_world_message_box2.cpp, hello_world_message_box3.cpp, hello_world_xtd.cpp, main_menu.cpp, message_box.cpp, open_file_box.cpp, save_file_box.cpp, and test_console.cpp.

◆ show() [10/16]

static dialog_result xtd::forms::message_box::show ( const xtd::ustring & text )

static

Displays a message box with specified text.

Parameters

text	The text to display in the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [11/16]

static dialog_result xtd::forms::message_box::show	(	const xtd::ustring &	text,
		const xtd::ustring &	caption
	)

static

Displays a message box with specified text and caption.

Parameters

text	The text to display in the message box.
caption	The text to display in the title bar of the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [12/16]

static dialog_result xtd::forms::message_box::show	(	const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons
	)

static

Displays a message box with the specified text, caption, and buttons.

Parameters

text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [13/16]

static dialog_result xtd::forms::message_box::show	(	const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons,
		message_box_icon	icon
	)

static

Displays a message box with the specified text, caption, buttons, and icon.

Parameters

text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.
icon	One of the message_box_icon values that specifies which icon to display in the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [14/16]

static dialog_result xtd::forms::message_box::show	(	const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons,
		message_box_icon	icon,
		message_box_default_button	default_button
	)

static

Displays a message box with the specified text, caption, buttons, icon, and default button.

Parameters

text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.
icon	One of the message_box_icon values that specifies which icon to display in the message box.
default_button	One of the message_box_default_button values that specifies the default button for the message box.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [15/16]

static dialog_result xtd::forms::message_box::show	(	const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons,
		message_box_icon	icon,
		message_box_default_button	default_button,
		message_box_options	options
	)

static

Displays a message box with the specified text, caption, buttons, icon, default button, and options.

Parameters

text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.
icon	One of the message_box_icon values that specifies which icon to display in the message box.
default_button	One of the message_box_default_button values that specifies the default button for the message box.
options	One of the message_box_options values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.

Returns: One of the xtd::forms::dialog_result values.

◆ show() [16/16]

static dialog_result xtd::forms::message_box::show	(	const xtd::ustring &	text,
		const xtd::ustring &	caption,
		message_box_buttons	buttons,
		message_box_icon	icon,
		message_box_default_button	default_button,
		message_box_options	options,
		bool	display_help_button
	)

static

Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button.

Parameters

text	The text to display in the message box.
caption	The text to display in the title bar of the message box.
buttons	One of the message_box_buttons values that specifies which buttons to display in the message box.
icon	One of the message_box_icon values that specifies which icon to display in the message box.
default_button	One of the message_box_default_button values that specifies the default button for the message box.
options	One of the message_box_options values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.
display_help_button	true to show the Help button; otherwise, false. The default is false.

Returns: One of the xtd::forms::dialog_result values.

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

xtd.forms/include/xtd/forms/message_box.h

Definition

Methods

Member Function Documentation

◆ show() [1/16]

◆ show() [2/16]

◆ show() [3/16]

◆ show() [4/16]

◆ show() [5/16]

◆ show() [6/16]

◆ show() [7/16]

◆ show() [8/16]

◆ show() [9/16]

◆ show() [10/16]

◆ show() [11/16]

◆ show() [12/16]

◆ show() [13/16]

◆ show() [14/16]

◆ show() [15/16]

◆ show() [16/16]