Vcl.FileCtrl.SelectDirectory
Delphi
function SelectDirectory(var Directory: string; Options: TSelectDirOpts; HelpCtx: Longint): Boolean;
function SelectDirectory(const Caption: string; const Root: WideString; var Directory: string; Options: TSelectDirExtOpts; Parent: TWinControl): Boolean;
function SelectDirectory(const StartDirectory: string; out Directories: TArray<string>; Options: TSelectDirFileDlgOpts = []; const Title: string = ''; const FolderNameLabel: string = ''; const OkButtonLabel: string = ''): Boolean;
C++
extern DELPHI_PACKAGE bool __fastcall SelectDirectory(System::UnicodeString &Directory, TSelectDirOpts Options, int HelpCtx)/* overload */;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | Vcl.FileCtrl.pas Vcl.FileCtrl.hpp |
Vcl.FileCtrl | Vcl.FileCtrl |
説明
ユーザーがディレクトリを入力または選択できる［ディレクトリの選択］ダイアログ ボックスを開きます。
Directory パラメータに渡す値は、このダイアログ ボックスが表示されたときに、現在選択されているディレクトリとして表示されます。SelectDirectory メソッドでは、新しく選択されたディレクトリを Directory に入れて返します。Options パラメータは、［ディレクトリの選択］ダイアログ ボックスのカスタム応答を指定します。それぞれの構文に応じて Options の取り得る値を確認してください。
- 第 1 の構文では、
Optionsは TSelectDirOpt の集合です。HelpCtxパラメータはヘルプのコンテキスト ID 番号です。
- 第 2 の構文では、
Optionsは TSelectDirExtOpt の集合です。Captionパラメータでは、［ディレクトリの選択］ダイアログ ボックスのキャプションを指定します。Rootパラメータは、参照の起点となるルート ディレクトリを指定します。Optionsが空集合の場合、ユーザーは既存のディレクトリのみ選択できます。ユーザーが新しいディレクトリ名を入力するための編集ボックスは提供されません。Optionsが空でない場合は、そこに含まれている値により、存在しないディレクトリ名をユーザーが入力したときのダイアログの応答が決まります。
- 第 3 の構文では、
Optionsは TSelectDirFileDlgOpt の集合です。この構文を使用する場合、SelectDirectory メソッドで表示される［ディレクトリの選択］ダイアログ ボックスでは、Microsoft の IFileDialog インターフェイスを使用して、Microsoft Windows Vista 以降の Windows オペレーティング システムのコモン ダイアログ ボックスと同じオプションを提供します。残りのパラメータは次のとおりです。StartDirectory： ［ディレクトリの選択］ダイアログ ボックスが表示された時点で選択されているディレクトリを指定します。Directories： SelectDirectory メソッドでは、選択された新しいディレクトリをこのパラメータに入れて返します。TSelectDirFileDlgOpts で複数選択を有効にしている場合、Directoriesには、選択されたすべてのディレクトリを別個の要素として格納した配列が渡されます。Title、FolderNameLabel、OkButtonLabel： SelectDirectory メソッドの呼び出しで開かれるダイアログ ボックスに表示されるテキストをカスタマイズするのに使用できます。
どちらの構文でも、SelectDirectory メソッドでは、ユーザーがディレクトリを選択し［OK］をクリックした場合は True を返し、ユーザーが［キャンセル］をクリックしたり、ディレクトリを選択せずにダイアログ ボックスを閉じた場合は False を返します。