Vcl.FileCtrl.SelectDirectory

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

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 */;

Eigenschaften

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


Beschreibung

Öffnet das Dialogfeld "Verzeichnis auswählen", in dem der Benutzer entweder ein Verzeichnis eingeben oder auswählen kann.

Der im Parameter Directory übergebene Wert erscheint als das aktuell ausgewählte Verzeichnis, wenn das Dialogfeld angezeigt wird. SelectDirectory gibt die neue Auswahl in Directory zurück. Der Parameter Options legt die benutzerdefinierte Reaktion des Dialogfeldes "Verzeichnis auswählen" fest. Je nach verwendeter Syntax sind die folgenden Werte für Options möglich.

  • Verwenden Sie die erste Syntax mit Options als Menge von TSelectDirOpt. Der Parameter HelpCtx ist die ID-Nummer des Hilfekontextes.
  • Verwenden Sie die zweite Syntax mit Options als Menge von TSelectDirExtOpt. Der Parameter Caption legt einen Titel für das Dialogfeld "Verzeichnis auswählen" fest. Der Parameter Root gibt das Stammverzeichnis an, von dem aus die Suche beginnen soll. Wenn Options eine leere Menge ist, kann der Benutzer nur ein Verzeichnis auswählen, das bereits vorhanden ist. Es ist dann kein Eingabefeld vorhanden, in das der Benutzer einen neuen Verzeichnisnamen eingeben kann. Wenn Options nicht leer ist, legen die einbezogenen Werte fest, wie das Dialogfeld reagiert, wenn der Benutzer einen nicht vorhandenen Verzeichnisnamen eingibt.
  • Verwenden Sie die dritte Syntax mit Options als Menge von TSelectDirFileDlgOpt. Mit dieser Syntax zeigt SelectDirectory das Dialogfeld "Verzeichnis auswählen" an, das mit dem Microsoft-Interface IFileDialog die gleichen Optionen wie Standarddialogfelder in Microsoft Windows Vista oder späteren Windows-Betriebssystemen bereitstellt. Restliche Parameter:
    • StartDirectory: Legt das aktuell ausgewählte Verzeichnis fest, wenn das Dialogfeld "Verzeichnis auswählen" erscheint.
    • Directories: SelectDirectory gibt in diesem Parameter das neue ausgewählte Verzeichnis zurück. Falls Sie in TSelectDirFileDlgOpts eine Mehrfachauswahl aktivieren, dann erhält Directories die gesamte Menge der ausgewählten Verzeichnisse als einzelne Elemente in dem Array.
    • Title, FolderNameLabel und OkButtonLabel: Ermöglichen die Anpassung des Textes, den SelectDirectory in dem Dialogfeld anzeigt.

Bei jeder Syntax gibt SelectDirectory True zurück, wenn Sie ein Verzeichnis auswählen und auf OK klicken, und False, wenn Sie auf Abbrechen klicken oder das Dialogfeld ohne Auswahl eines Verzeichnisses schließen.

Siehe auch

Codebeispiele