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

#include <open_file_box.h>

Definition

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

Namespace
xtd::forms
Library
xtd.forms
Examples
The following code example demonstrate the use of xtd::forms::open_file_box dialog.
#include <xtd/xtd>
using namespace xtd;
using namespace xtd::forms;
using namespace std;
class form1 : public form {
public:
form1() {
text("Open file box example");
client_size({400, 200});
controls().push_back_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 += [this] {
ustring 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(ustring::format("Selected file is:\n{}", file_name));
};
button_open_multiple_files.parent(*this)
.location({10, 45})
.size({150, 35})
.text("Select multiple files")
.click += [] {
vector<ustring> file_names;
if (res == dialog_result::ok) {
message_box::show(ustring::format("Selected files are:\n{}", ustring::join("\n", file_names)));
}
};
}
private:
button button_open_single_file;
button button_open_multiple_files;
};
int main() {
application::run(form1());
}

Static Public Member Functions

static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::forms::iwin32_window &owner, const xtd::ustring &title)
 Displays a select file dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const open_file_box_options options)
 Displays a select file dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &initial_directory)
 Displays a select file dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &initial_directory, const open_file_box_options options)
 Displays a select file dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &initial_directory, const xtd::ustring &filter)
 Displays a select file dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &initial_directory, const xtd::ustring &filter, const open_file_box_options options)
 Displays a select file dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::ustring &title)
 Displays a select file dialog box. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::ustring &title, const open_file_box_options options)
 Displays a select file dialog box. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::ustring &title, const xtd::ustring &initial_directory)
 Displays a select file dialog box. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::ustring &title, const xtd::ustring &initial_directory, const open_file_box_options options)
 Displays a select file dialog box. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::ustring &title, const xtd::ustring &initial_directory, const xtd::ustring &filter)
 Displays a select file dialog box. More...
 
static xtd::forms::dialog_result show (xtd::ustring &file_name, const xtd::ustring &title, const xtd::ustring &initial_directory, const xtd::ustring &filter, const open_file_box_options options)
 Displays a select file dialog box. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::forms::iwin32_window &owner, const xtd::ustring &title)
 Displays a multiple file select dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const open_file_box_options options)
 Displays a multiple file select dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &initial_directory)
 Displays a multiple file select dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &initial_directory, const open_file_box_options options)
 Displays a multiple file select dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &initial_directory, const xtd::ustring &filter)
 Displays a multiple file select dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::forms::iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &initial_directory, const xtd::ustring &filter, const open_file_box_options options)
 Displays a multiple file select dialog box in front of a specified window. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::ustring &title)
 Displays a multiple file select dialog box. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::ustring &title, const open_file_box_options options)
 Displays a multiple file select dialog box. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::ustring &title, const xtd::ustring &initial_directory)
 Displays a multiple file select dialog box. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::ustring &title, const xtd::ustring &initial_directory, const open_file_box_options options)
 Displays a multiple file select dialog box. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::ustring &title, const xtd::ustring &initial_directory, const xtd::ustring &filter)
 Displays a multiple file select dialog box. More...
 
static xtd::forms::dialog_result show (std::vector< xtd::ustring > &file_names, const xtd::ustring &title, const xtd::ustring &initial_directory, const xtd::ustring &filter, const open_file_box_options options)
 Displays a multiple file select dialog box. More...
 

Member Function Documentation

◆ show() [1/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::forms::iwin32_window owner,
const xtd::ustring title 
)
inlinestatic

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

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring 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() [2/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const open_file_box_options  options 
)
inlinestatic

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

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
optionsA 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() [3/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const xtd::ustring initial_directory 
)
inlinestatic

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

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring 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() [4/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const xtd::ustring initial_directory,
const open_file_box_options  options 
)
inlinestatic

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

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
optionsA 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() [5/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const xtd::ustring initial_directory,
const xtd::ustring filter 
)
inlinestatic

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

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
filterAn xtd::ustring 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() [6/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const xtd::ustring initial_directory,
const xtd::ustring filter,
const open_file_box_options  options 
)
inlinestatic

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

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
filterAn xtd::ustring 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 (*.*)|*.* 
optionsA 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() [7/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::ustring title 
)
inlinestatic

Displays a select file dialog box.

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
titleAn xtd::ustring 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() [8/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::ustring title,
const open_file_box_options  options 
)
inlinestatic

Displays a select file dialog box.

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
optionsA 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() [9/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::ustring title,
const xtd::ustring initial_directory 
)
inlinestatic

Displays a select file dialog box.

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring 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() [10/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::ustring title,
const xtd::ustring initial_directory,
const open_file_box_options  options 
)
inlinestatic

Displays a select file dialog box.

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
optionsA 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() [11/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::ustring title,
const xtd::ustring initial_directory,
const xtd::ustring filter 
)
inlinestatic

Displays a select file dialog box.

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
filterAn xtd::ustring 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() [12/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( xtd::ustring file_name,
const xtd::ustring title,
const xtd::ustring initial_directory,
const xtd::ustring filter,
const open_file_box_options  options 
)
inlinestatic

Displays a select file dialog box.

Parameters
file_nameAn output xtd::ustring that will store the selected file name.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
filterAn xtd::ustring 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 (*.*)|*.* 
optionsA 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/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::forms::iwin32_window owner,
const xtd::ustring title 
)
inlinestatic

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

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
ownerAn 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() [14/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const open_file_box_options  options 
)
inlinestatic

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

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
optionsA 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() [15/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const xtd::ustring initial_directory 
)
inlinestatic

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

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring 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() [16/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const xtd::ustring initial_directory,
const open_file_box_options  options 
)
inlinestatic

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

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
optionsA 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/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const xtd::ustring initial_directory,
const xtd::ustring filter 
)
inlinestatic

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

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
ownerAn iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
filterAn xtd::ustring 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() [18/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::forms::iwin32_window owner,
const xtd::ustring title,
const xtd::ustring initial_directory,
const xtd::ustring filter,
const open_file_box_options  options 
)
inlinestatic

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

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
ownerAn xtd::forms::iwin32_window that represents the owner window of the file dialog box.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
filterAn xtd::ustring 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 (*.*)|*.* 
optionsA 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/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::ustring title 
)
inlinestatic

Displays a multiple file select dialog box.

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
titleAn xtd::ustring 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() [20/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::ustring title,
const open_file_box_options  options 
)
inlinestatic

Displays a multiple file select dialog box.

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
optionsA 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/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::ustring title,
const xtd::ustring initial_directory 
)
inlinestatic

Displays a multiple file select dialog box.

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring 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() [22/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::ustring title,
const xtd::ustring initial_directory,
const open_file_box_options  options 
)
inlinestatic

Displays a multiple file select dialog box.

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
optionsA 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() [23/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::ustring title,
const xtd::ustring initial_directory,
const xtd::ustring filter 
)
inlinestatic

Displays a multiple file select dialog box.

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
filterAn xtd::ustring 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() [24/24]

static xtd::forms::dialog_result xtd::forms::open_file_box::show ( std::vector< xtd::ustring > &  file_names,
const xtd::ustring title,
const xtd::ustring initial_directory,
const xtd::ustring filter,
const open_file_box_options  options 
)
inlinestatic

Displays a multiple file select dialog box.

Parameters
file_namesAn output std::vector <xtd::ustring> that will store the selected file names.
titleAn xtd::ustring that specifies the caption title of the file dialog box.
initial_directoryAn xtd::ustring that specifies the initial directory displayed by the file dialog box
filterAn xtd::ustring 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 (*.*)|*.* 
optionsA 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: