reference_guides/latest/open__file__box_8hpp_source.html

#pragma once

#include "open_file_box_options.hpp"

#include "open_file_dialog.hpp"

#include <xtd/static>


namespace xtd {

  namespace forms {


    class forms_export_ open_file_box final static_ {

    public:


      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::forms::iwin32_window& owner);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::forms::iwin32_window& owner, const xtd::string& title);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::forms::iwin32_window& owner, const xtd::string& title, const open_file_box_options options);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::forms::iwin32_window& owner, const xtd::string& title, const xtd::string& initial_directory);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::forms::iwin32_window& owner, const xtd::string& title, const xtd::string& initial_directory, const open_file_box_options options);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::forms::iwin32_window& owner, const xtd::string& title, const xtd::string& initial_directory,  const xtd::string& filter);

      static xtd::forms::dialog_result 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 open_file_box_options options);

      static xtd::forms::dialog_result show(xtd::string& file_name);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::string& title);


      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::string& title, const open_file_box_options options);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::string& title, const xtd::string& initial_directory);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::string& title, const xtd::string& initial_directory, const open_file_box_options options);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::string& title, const xtd::string& initial_directory,  const xtd::string& filter);

      static xtd::forms::dialog_result show(xtd::string& file_name, const xtd::string& title, const xtd::string& initial_directory,  const xtd::string& filter, const open_file_box_options options);

      static xtd::forms::dialog_result show(xtd::array<xtd::string>& file_names, const xtd::forms::iwin32_window& owner, const xtd::string& title);

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

      static xtd::forms::dialog_result show(xtd::array<xtd::string>& file_names, const xtd::forms::iwin32_window& owner, const xtd::string& title, const xtd::string& initial_directory);

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

      static xtd::forms::dialog_result 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);

      static xtd::forms::dialog_result 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 open_file_box_options options);

      static xtd::forms::dialog_result show(xtd::array<xtd::string>& file_names, const xtd::string& title);

      static xtd::forms::dialog_result show(xtd::array<xtd::string>& file_names, const xtd::string& title, const open_file_box_options options);

      static xtd::forms::dialog_result show(xtd::array<xtd::string>& file_names, const xtd::string& title, const xtd::string& initial_directory);

      static xtd::forms::dialog_result show(xtd::array<xtd::string>& file_names, const xtd::string& title, const xtd::string& initial_directory, const open_file_box_options options);

      static xtd::forms::dialog_result show(xtd::array<xtd::string>& file_names, const xtd::string& title, const xtd::string& initial_directory, const xtd::string& filter);

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


    private:

      template<const bool multiselect, class output_t>

      static xtd::forms::dialog_result show_open_file_box(output_t& output, const xtd::string& title, const xtd::string& initial_directory = xtd::string::empty_string, const xtd::string& filter = xtd::string::empty_string, const open_file_box_options options = open_file_box_options::none, const xtd::forms::iwin32_window* owner = nullptr) {

        auto dialog = xtd::forms::open_file_dialog {};

        dialog.multiselect(multiselect)

          .title(title)

          .initial_directory(initial_directory)

          .filter(filter)

          .check_file_exists((options & open_file_box_options::check_file_exists) == open_file_box_options::check_file_exists)

          .dereference_link((options & open_file_box_options::dereference_link) == open_file_box_options::dereference_link)

          .validate_names((options & open_file_box_options::validate_names) == open_file_box_options::validate_names)

          .restore_directory((options & open_file_box_options::restore_directory) == open_file_box_options::restore_directory)

          .auto_upgrade_enabled((options & open_file_box_options::enable_auto_upgrade) == open_file_box_options::enable_auto_upgrade)

          .show_hidden_files((options & open_file_box_options::show_hidden_files) == open_file_box_options::show_hidden_files)

          .show_help((options & open_file_box_options::show_help) == open_file_box_options::show_help)

          .show_preview((options & open_file_box_options::show_preview) == open_file_box_options::show_preview)

          .support_multi_dotted_extensions((options & open_file_box_options::support_multi_dotted_extensions) == open_file_box_options::support_multi_dotted_extensions);

        if constexpr(!multiselect) dialog.file_name(output);

        const auto res = owner ? dialog.show_sheet_dialog(*owner) : dialog.show_dialog();

        if (res != dialog_result::ok) return res;

        if constexpr(multiselect) output = dialog.file_names();

        else output = dialog.file_name();

        return res;

      }

    };

    class forms_export_ open_file_box final static_ {…};

  }

}

xtd::array
Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the ba...
Definition array.hpp:61

xtd::forms::iwin32_window
Provides an interface to expose Win32 HWND handles.
Definition iwin32_window.hpp:23

xtd::forms::open_file_box
Represents a common dialog box that displays a file selection dialog. This class cannot be inherited.
Definition open_file_box.hpp:31

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

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::array< xtd::string > &file_names, const xtd::string &title, const xtd::string &initial_directory, const open_file_box_options options)
Displays a multiple file select dialog box.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result 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 open_file_box_options options)
Displays a multiple file select dialog box in front of a specified window.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::string &file_name, const xtd::string &title, const xtd::string &initial_directory)
Displays a select file dialog box.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::array< xtd::string > &file_names, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter, const open_file_box_options options)
Displays a multiple file select dialog box.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result 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 open_file_box_options options)
Displays a select file dialog box in front of a specified window.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result 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)
Displays a multiple file select dialog box in front of a specified window.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::array< xtd::string > &file_names, const xtd::string &title, const xtd::string &initial_directory)
Displays a multiple file select dialog box.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::string &file_name, const xtd::string &title)
Displays a select file dialog box.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::string &file_name)
Displays a select file dialog box.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::array< xtd::string > &file_names, const xtd::string &title, const open_file_box_options options)
Displays a multiple file select dialog box.

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

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::array< xtd::string > &file_names, const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &initial_directory)
Displays a multiple file select dialog box in front of a specified window.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::string &file_name, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter, const open_file_box_options options)
Displays a select file dialog box.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::string &file_name, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter)
Displays a select file dialog box.

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

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::string &file_name, const xtd::string &title, const xtd::string &initial_directory, const open_file_box_options options)
Displays a select file dialog box.

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

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::array< xtd::string > &file_names, const xtd::forms::iwin32_window &owner, const xtd::string &title, const open_file_box_options options)
Displays a multiple file select dialog box in front of a specified window.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::array< xtd::string > &file_names, const xtd::forms::iwin32_window &owner, const xtd::string &title)
Displays a multiple file select dialog box in front of a specified window.

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

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::array< xtd::string > &file_names, const xtd::string &title)
Displays a multiple file select dialog box.

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

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::string &file_name, const xtd::string &title, const open_file_box_options options)
Displays a select file dialog box.

xtd::forms::open_file_box::show
static xtd::forms::dialog_result show(xtd::array< xtd::string > &file_names, const xtd::string &title, const xtd::string &initial_directory, const xtd::string &filter)
Displays a multiple file select dialog box.

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

xtd::forms::open_file_dialog
Displays a standard dialog box that prompts the user to open a file. This class cannot be inherited.
Definition open_file_dialog.hpp:30

xtd::forms::open_file_dialog::multiselect
virtual bool multiselect() const noexcept
Gets a value indicating whether the dialog box allows multiple files to be selected.

static_
#define static_
This keyword is use to represent a static object. A static object can't be instantiated (constructors...
Definition static.hpp:37

forms_export_
#define forms_export_
Define shared library export.
Definition forms_export.hpp:13

xtd::string
xtd::basic_string< char > string
Represents text as a sequence of UTF-8 code units.
Definition __string_definitions.hpp:43

xtd::forms::open_file_box_options
open_file_box_options
Specifies options on a xtd::forms::open_file_box.
Definition open_file_box_options.hpp:22

xtd::forms::dialog_result
dialog_result
Specifies identifiers to indicate the return value of a dialog box.
Definition dialog_result.hpp:43

xtd::forms::open_file_box_options::validate_names
@ validate_names
Whether the dialog box accepts only valid file names.
Definition open_file_box_options.hpp:30

xtd::forms::open_file_box_options::enable_auto_upgrade
@ enable_auto_upgrade
Whether this xtd::forms::file_dialog instance should automatically upgrade appearance and behavior wh...
Definition open_file_box_options.hpp:34

xtd::forms::open_file_box_options::none
@ none
No options.
Definition open_file_box_options.hpp:24

xtd::forms::open_file_box_options::dereference_link
@ dereference_link
Whether the dialog box returns the location of the file referenced by the shortcut (....
Definition open_file_box_options.hpp:28

xtd::forms::open_file_box_options::show_hidden_files
@ show_hidden_files
Whether hidden files are displayed in the file dialog box.
Definition open_file_box_options.hpp:36

xtd::forms::open_file_box_options::check_file_exists
@ check_file_exists
Whether the dialog box displays a warning if the user specifies a file name that does not exist.
Definition open_file_box_options.hpp:26

xtd::forms::open_file_box_options::restore_directory
@ restore_directory
Whether the dialog box restores the directory to the previously selected directory before closing.
Definition open_file_box_options.hpp:32

xtd::forms::open_file_box_options::show_preview
@ show_preview
Whether preview file is displayed in the file dialog box.
Definition open_file_box_options.hpp:40

xtd::forms::open_file_box_options::support_multi_dotted_extensions
@ support_multi_dotted_extensions
Whether the dialog box supports displaying and saving files that have multiple file name extensions.
Definition open_file_box_options.hpp:42

xtd::forms::open_file_box_options::show_help
@ show_help
Whether the Help button is displayed in the file dialog box.
Definition open_file_box_options.hpp:38

xtd::forms::dialog_result::ok
@ ok
The dialog box return value is OK (usually sent from a button labeled OK).
Definition dialog_result.hpp:47

xtd::forms
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition texts.hpp:219

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8

open_file_box_options.hpp
Contains xtd::forms::open_file_box_options control.

open_file_dialog.hpp
Contains xtd::forms::open_file_dialog dialog.