Vcl.Dialogs.PromptForFileName
Delphi
function PromptForFileName(var AFileName: string; const AFilter: string = '';
const ADefaultExt: string = ''; const ATitle: string = '';
const AInitialDir: string = ''; SaveDialog: Boolean = False): Boolean;
C++
extern DELPHI_PACKAGE bool __fastcall PromptForFileName(System::UnicodeString &AFileName, const System::UnicodeString AFilter = System::UnicodeString(), const System::UnicodeString ADefaultExt = System::UnicodeString(), const System::UnicodeString ATitle = System::UnicodeString(), const System::UnicodeString AInitialDir = System::UnicodeString(), bool SaveDialog = false);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | Vcl.Dialogs.pas Vcl.Dialogs.hpp |
Vcl.Dialogs | Vcl.Dialogs |
説明
[ファイルを開く] ダイアログまたは [名前を付けて保存] ダイアログを表示して、ユーザーがファイル名を指定できるようにします。
PromptForFileName を呼び出すと [ファイルを開く] ダイアログまたは [名前を付けて保存] ダイアログを表示します。
AFileName はファイル名です。呼び出し側から渡された値は、ダイアログでファイル名を初期化するために使用されます。終了時に、AFileName には、ダイアログで指定された名前が含まれます。
AFilter ではダイアログで利用できるファイル マスク（フィルタ）を判定します。AFilter に文字列が設定されていない場合は、ダイアログで文字列 'All files (*.*)' が使用され、対象ディレクトリにあるすべてのファイルが表示されます。フィルタ文字列の詳細については、「フィルタ」を参照してください。
ADefaultExt は指定したファイル名に自動的に付加されるファイル拡張子を指定します。ただし選択ファイル名に対して既に拡張子が登録されている場合は除きます。ユーザーが登録されていない拡張子のファイル名を指定した場合は、ADefaultExt では非登録の拡張子が付加されます。
ATitle はダイアログのタイトルを指定します。ATitle に文字列が設定されていない場合は、[ファイルを開く] ダイアログまたは [名前を付けて保存] が使用されます。SaveDialog パラメータの値で変わります。
AInitialDir は、開いたときにダイアログで表示されるディレクトリを指定します。AInitialDir に文字列が指定されていない、または指定ディレクトリが存在しない場合は、初期のディレクトリは現在の作業ディレクトリです。
SaveDialog にはファイル選択が [名前を付けて保存] ダイアログ（true）または [ファイルを開く] ダイアログ（false）かどうかを指定します。
Options はファイル ダイアログのオプションを指定します。
PromptForFileName では、ユーザーがファイル名選択したときに true、[キャンセル] ボタンをクリックして終了したときに false が返ります。