Vcl.FileCtrl.SelectDirectory

De RAD Studio API Documentation
Aller à : navigation, rechercher

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

Propriétés

Type Visibilité  Source Unité  Parent
function public
Vcl.FileCtrl.pas
Vcl.FileCtrl.hpp
Vcl.FileCtrl Vcl.FileCtrl


Description

Affiche un dialogue de sélection de répertoire permettant à l'utilisateur de saisir ou de sélectionner un répertoire.

La valeur transmise dans le paramètre Directory apparaît comme le répertoire actuellement sélectionné lorsque la boîte de dialogue s'ouvre. SelectDirectory renvoie la nouvelle sélection dans Directory. Le paramètre Options spécifie la réponse personnalisée du dialogue de sélection de répertoire. Vérifiez les valeurs possibles pouvant être prises par Options en fonction de chaque syntaxe.

  • Utilisez la première syntaxe avec Options en tant qu'ensemble de TSelectDirOpt. Le paramètre HelpCtx est le numéro d'identificateur de l'aide contextuelle.
  • Utilisez la seconde syntaxe avec Options en tant qu'ensemble de TSelectDirExtOpt. Le paramètre Caption spécifie un libellé pour le dialogue de sélection de répertoire. Le paramètre Root précise le répertoire racine où commencer l'exploration. Si Options est l'ensemble vide, l'utilisateur ne peut sélectionner qu'un répertoire existant. Aucune zone d'édition ne lui permet d'entrer un nom de répertoire. Si Options n'est pas vide, les valeurs incluses déterminent la façon dont réagit le dialogue lorsque l'utilisateur entre un nom de répertoire inexistant.
  • Utilisez la troisième syntaxe avec Options en tant qu'ensemble de TSelectDirFileDlgOpt. Avec cette syntaxe, SelectDirectory affiche un dialogue de sélection de répertoire qui utilise l'interface Microsoft IFileDialog pour fournir les mêmes options que les dialogues communs dans Microsoft Windows Vista ou les systèmes d'exploitation Windows ultérieurs. Les autres paramètres sont les suivants :
    • StartDirectory : spécifie le répertoire actuellement sélectionné lorsque le dialogue de sélection de répertoire apparaît.
    • Directories : SelectDirectory renvoie le nouveau répertoire sélectionné dans ce paramètre. Si vous activez la sélection multiple dans TSelectDirFileDlgOpts, Directories reçoit l'ensemble complet de répertoires sélectionnés sous la forme de différents éléments dans le tableau.
    • Title, FolderNameLabel et OkButtonLabel : vous permettent de personnaliser le texte que SelectDirectory affiche dans la boîte de dialogue.

Quelle que soit la syntaxe, SelectDirectory renvoie True si vous sélectionnez un répertoire et cliquez sur OK, et False si vous cliquez sur Annuler ou fermez la boîte de dialogue sans sélectionner un répertoire.

Voir aussi

Exemples de code