Inheritance diagram for xtd::forms::open_file_box:

Definition

Represents a common dialog box that displays a file selection dialog. This class cannot be inherited.

Header: #include <xtd/forms/open_file_box>

Namespace: xtd::forms

Library: xtd.forms

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples: The following code example demonstrates the use of xtd::forms::open_file_box dialog.
#include <xtd/xtd>

class form1 : public form {

public:

form1() {

text("Open file box example");

client_size({400, 200});

controls().add_range({button_open_single_file, button_open_multiple_files});

button_open_single_file.parent(*this)

.location({10, 10})

.size({150, 35})

.text("Select single file")

.click += delegate_ {

string file_name;

auto res = open_file_box::show(file_name, *this, "Please select a file...", ".", "Text Files (*.txt)|*.txt|All Files (*.*)|*.*");

if (res == dialog_result::ok)

message_box::show(string::format("Selected file is:\n{}", file_name));

};

button_open_multiple_files.parent(*this)

.location({10, 45})

.size({150, 35})

.text("Select multiple files")

.click += delegate_ {

auto file_names = array<string> {};

auto res = open_file_box::show(file_names, "Please select multiple files...", open_file_box_options::check_file_exists | open_file_box_options::show_hidden_files);

if (res == dialog_result::ok)

message_box::show(string::format("Selected files are:\n{}", string::join("\n", file_names)));

};

}

private:

button button_open_single_file;

button button_open_multiple_files;

};

auto main() -> int {

application::run(form1 {});

}

xtd::forms::form
Represents a window or dialog box that makes up an application's user interface.
Definition form.hpp:54

xtd::forms::message_box::show
static auto show() -> xtd::forms::dialog_result
Displays a message box.

xtd::forms::open_file_box::show
static auto show(xtd::string &file_name, const xtd::forms::iwin32_window &owner) -> xtd::forms::dialog_result
Displays a select file dialog box in front of a specified window.

delegate_
#define delegate_
The declaration of a delegate type is similar to a method signature. It has a return value and any nu...
Definition delegate.hpp:1018

xtd::forms::style_sheets::button
xtd::forms::style_sheets::control button
The buttton data allows you to specify the box of a button control.
Definition button.hpp:25

xtd::forms::status_bar_panel_style::text
@ text
The xtd::forms::status_bar_panel displays text in the standard font.
Definition status_bar_panel_style.hpp:25

xtd::text
Contains classes that represent ASCII and Unicode character encodings; abstract base classes for conv...
Definition basic_string_builder.hpp:14

xtd::size
constexpr auto size() const noexcept -> size_type
Returns the number of elements.
Definition read_only_span.hpp:213

Public Static Methods
static auto	show (xtd::string &file_name, const xtd::forms::iwin32_window &owner) -> xtd::forms::dialog_result
	Displays a select file dialog box in front of a specified window.
static auto	show (xtd::string &file_name, const xtd::forms::iwin32_window &owner, const xtd::string &title) -> xtd::forms::dialog_result
	Displays a select file dialog box in front of a specified window.
static auto	show (xtd::string &file_name, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a select file dialog box in front of a specified window.
static auto	show (xtd::string &file_name, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &initial_directory) -> xtd::forms::dialog_result
	Displays a select file dialog box in front of a specified window.
static auto	show (xtd::string &file_name, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &initial_directory, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a select file dialog box in front of a specified window.
static auto	show (xtd::string &file_name, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter) -> xtd::forms::dialog_result
	Displays a select file dialog box in front of a specified window.
static auto	show (xtd::string &file_name, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a select file dialog box in front of a specified window.
static auto	show (xtd::string &file_name) -> xtd::forms::dialog_result
	Displays a select file dialog box.
static auto	show (xtd::string &file_name, const xtd::string &title) -> xtd::forms::dialog_result
	Displays a select file dialog box.
static auto	show (xtd::string &file_name, const xtd::string &title, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a select file dialog box.
static auto	show (xtd::string &file_name, const xtd::string &title, const xtd::string &initial_directory) -> xtd::forms::dialog_result
	Displays a select file dialog box.
static auto	show (xtd::string &file_name, const xtd::string &title, const xtd::string &initial_directory, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a select file dialog box.
static auto	show (xtd::string &file_name, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter) -> xtd::forms::dialog_result
	Displays a select file dialog box.
static auto	show (xtd::string &file_name, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a select file dialog box.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::forms::iwin32_window &owner, const xtd::string &title) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box in front of a specified window.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box in front of a specified window.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &initial_directory) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box in front of a specified window.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &initial_directory, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box in front of a specified window.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box in front of a specified window.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box in front of a specified window.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::string &title) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::string &title, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::string &title, const xtd::string &initial_directory) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::string &title, const xtd::string &initial_directory, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box.
static auto	show (xtd::array< xtd::string > &file_names, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter, const xtd::forms::open_file_box_options options) -> xtd::forms::dialog_result
	Displays a multiple file select dialog box.

Member Function Documentation

◆ show() [1/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::forms::iwin32_window &	owner ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box in front of a specified window.

Parameters

file_name	An output xtd::string that will store the selected file name.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [2/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box in front of a specified window.

Parameters

file_name	An output xtd::string that will store the selected file name.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [3/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box in front of a specified window.

Parameters

file_name	An output xtd::string that will store the selected file name.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [4/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::string &	initial_directory ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box in front of a specified window.

Parameters

file_name	An output xtd::string that will store the selected file name.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [5/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box in front of a specified window.

Parameters

file_name	An output xtd::string that will store the selected file name.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [6/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::string &	filter ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box in front of a specified window.

Parameters

file_name	An output xtd::string that will store the selected file name.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
filter	An xtd::string that specifies the file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box, separated by vertical bar \| for example: (.txt)\|.txt\|All files (.)\|.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [7/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::string &	filter,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box in front of a specified window.

Parameters

file_name	An output xtd::string that will store the selected file name.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
filter	An xtd::string that specifies the file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box, separated by vertical bar \| for example: (.txt)\|.txt\|All files (.)\|.
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [8/26]

auto xtd::forms::open_file_box::show ( xtd::string & file_name ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box.

Parameters

file_name An output xtd::string that will store the selected file name.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [9/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::string &	title ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box.

Parameters

file_name	An output xtd::string that will store the selected file name.
title	An xtd::string that specifies the caption title of the file dialog box.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [10/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::string &	title,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box.

Parameters

file_name	An output xtd::string that will store the selected file name.
title	An xtd::string that specifies the caption title of the file dialog box.
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [11/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::string &	title,
		const xtd::string &	initial_directory ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box.

Parameters

file_name	An output xtd::string that will store the selected file name.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [12/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box.

Parameters

file_name	An output xtd::string that will store the selected file name.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [13/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::string &	filter ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box.

Parameters

file_name	An output xtd::string that will store the selected file name.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
filter	An xtd::string that specifies the file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box, separated by vertical bar \| for example: (.txt)\|.txt\|All files (.)\|.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [14/26]

auto xtd::forms::open_file_box::show	(	xtd::string &	file_name,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::string &	filter,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a select file dialog box.

Parameters

file_name	An output xtd::string that will store the selected file name.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
filter	An xtd::string that specifies the file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box, separated by vertical bar \| for example: (.txt)\|.txt\|All files (.)\|.
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_name parameter will contain the selected file path, otherwise it will be ignored.

◆ show() [15/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box in front of a specified window.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [16/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box in front of a specified window.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [17/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::string &	initial_directory ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box in front of a specified window.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [18/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box in front of a specified window.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [19/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::string &	filter ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box in front of a specified window.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
filter	An xtd::string that specifies the file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box, separated by vertical bar \| for example: (.txt)\|.txt\|All files (.)\|.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [20/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::forms::iwin32_window &	owner,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::string &	filter,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box in front of a specified window.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
owner	An xtd::forms::iwin32_window that represents the owner window of the file dialog box.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
filter	An xtd::string that specifies the file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box, separated by vertical bar \| for example: (.txt)\|.txt\|All files (.)\|.
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [21/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::string &	title ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
title	An xtd::string that specifies the caption title of the file dialog box.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [22/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::string &	title,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
title	An xtd::string that specifies the caption title of the file dialog box.
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [23/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::string &	title,
		const xtd::string &	initial_directory ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [24/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [25/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::string &	filter ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
filter	An xtd::string that specifies the file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box, separated by vertical bar \| for example: (.txt)\|.txt\|All files (.)\|.

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

◆ show() [26/26]

auto xtd::forms::open_file_box::show	(	xtd::array< xtd::string > &	file_names,
		const xtd::string &	title,
		const xtd::string &	initial_directory,
		const xtd::string &	filter,
		const xtd::forms::open_file_box_options	options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a multiple file select dialog box.

Parameters

file_names	An output xtd::array <xtd::string> that will store the selected file names.
title	An xtd::string that specifies the caption title of the file dialog box.
initial_directory	An xtd::string that specifies the initial directory displayed by the file dialog box
filter	An xtd::string that specifies the file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box, separated by vertical bar \| for example: (.txt)\|.txt\|All files (.)\|.
options	A bitwise combination of enum xtd::forms::open_file_box_options to specify additional options to the file dialog box

Returns: xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks: If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output file_names parameter will contain the selected file paths, otherwise it will be ignored.

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

xtd.forms/include/xtd/forms/open_file_box.hpp

Definition

Public Static Methods

Member Function Documentation

◆ show() [1/26]

◆ show() [2/26]

◆ show() [3/26]

◆ show() [4/26]

◆ show() [5/26]

◆ show() [6/26]

◆ show() [7/26]

◆ show() [8/26]

◆ show() [9/26]

◆ show() [10/26]

◆ show() [11/26]

◆ show() [12/26]

◆ show() [13/26]

◆ show() [14/26]

◆ show() [15/26]

◆ show() [16/26]

◆ show() [17/26]

◆ show() [18/26]

◆ show() [19/26]

◆ show() [20/26]

◆ show() [21/26]

◆ show() [22/26]

◆ show() [23/26]

◆ show() [24/26]

◆ show() [25/26]

◆ show() [26/26]