Vcl.Dialogs.PromptForFileName

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

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);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
Vcl.Dialogs.pas
Vcl.Dialogs.hpp
Vcl.Dialogs Vcl.Dialogs

Beschreibung

Bewirkt die Anzeige eines Dialogfelds zum Öffnen oder Speichern einer Datei, deren Name der Benutzer angeben kann.

Mit PromptForFileName wird ein Dialogfeld zum Öffnen oder Speichern von Dateien angezeigt.

AFilename ist der Name der Datei. Der vom Aufrufer übergebene Wert dient zur Initialisierung des Dateinamens im Dialogfeld. Beim Schließen des Dialogfeldes enthält AFileName den im Dialogfeld angegebenen Dateinamen.

AFilter bestimmt, welche Dateimasken (Filter) im Dialogfeld verfügbar sind. Wenn AFilter auf einen leeren String gesetzt wurde, ist im Dialogfeld der String 'Alle Dateien (*.*)|*.*' zu sehen. Es werden dann alle Dateien angezeigt, die sich im aktuellen Verzeichnis befinden. Informationen zu Filter-Strings finden Sie unter dem Thema Filter.

ADefaultExt legt die Dateinamenserweiterung fest, die automatisch an den übergebenen Dateinamen angefügt wird, falls der gewählte Dateiname nicht bereits eine registrierte Erweiterung enthält. Wenn der Benutzer eine Datei mit einer nicht registrierten Erweiterung angibt, wird ADefaultExt an die Erweiterung angehängt.

ATitle ist der Titel des Dialogfelds. Wenn ATitle auf einen leeren String gesetzt ist, wird in der Titelleiste der String Öffnen bzw. Speichern unter angezeigt, je nachdem, welchen Wert der Parameter SaveDialog hat.

AInitialDir legt das Verzeichnis fest, das beim Öffnen des Dialogfelds angezeigt wird. Wenn InitialDir ein leerer String ist oder wenn das angegebene Verzeichnis nicht existiert, wird das aktuelle Arbeitsverzeichnis angezeigt.

SaveDialog bestimmt, ob das Dialogfeld der Funktion Speichern unter (true) oder zum Öffnen von Dateien dient (false).

Options legt die Optionen für das Datei-Dialogfeld fest.

PromptForFileName gibt den Wert true zurück, wenn der Benutzer einen Dateinamen ausgewählt hat. Der Wert false bedeutet, dass der Benutzer das Dialogfeld mit der Schaltfläche Abbrechen verlassen hat.

Siehe auch