TApFolderDialog component

Inherited from : TCommonDialog

unit : ApFolderDlg

This component is simply wrapper for SHBrowseForFolder Win32 function.

Also TApCustomFolderDialog component is available. All new properties of custom component are protected.

Types

Properties

Methods

Events



Types


TApBrowseForFolderFlag

= (ffBrowseForComputer,
ffBrowseForPrinter,
ffDontGoBelowDomain,
ffReturnFSAncestors,
ffReturnOnlyFSDirs,
ffStatusText);

TApBrowseForFolderFlags

= set of TApBrowseForFolderFlag;

Is used in Options property.


TApSpecShellFolder = (ftNone,
    ftRecycleBin,
    ftCommonDesktopDir,
    ftCommonPrograms,
    ftCommonStartMenu,
    ftCommonStartup,
    ftControls,
    ftDesktop,
    ftDesktopDir,
    ftDrives,
    ftFonts,
    ftNethood,
    ftNetwork,
    ftPersonal,
    ftPrinters,
    ftPrograms,
    ftRecent,
    ftSendTo,
    ftStartMenu,
    ftStartup,
    ftTemplates);

Predefined system folders.

This type is used in SpecialIniFolder property to specify initial folder wich will be selected on dialog showing.



Properties


CustDlgParams : TApCustDlgParams; RW

Published, protected in custom version

This variable contains all information about side panels of the standard dialog. See TApCustDlgPatams type for details.

useCustDlgParams.CustomForm is not used in this component. (Later - as replacement on std shell selection control similar to TApOpen/SaveDialog).


Initial Folder : string; RW

Published; protected in custom version

You can specify initial folder wich is selected when you launch the dialog.


SpecialIniFolder : TApSpecShellFolder; RW

Published; protected in custom version

You can specify one of the predefined system folders as initial folder.


StatusText : string; RW

Published; protected in custom version

Instead of sending BFFM_SETSTATUSTEXT message via callback dialog fuction use this property to specify status text. This text will be displayed in the dialog box.


Options : TApBrowseForFolderFlags; RW

Published; protected in custom version

Simply wrapper for BROWSEINFO.ulFlags struct member. See Win32 Reference for details.


SelectedFolder : string; R

Public; protected in custom version

Read-only and "dialog-time". You can read this property to get currently selected folder.


SelectedPidl : PItemIDList; R

Public; protected in custom version

The same as SelectedFolder property. But returns PItemIDList insead of string value. See Win32 Reference for infomation about ITEMIDLIST.


OkEnabled : boolean; RW

Public; protected in custom version

"Dialog-time" property. Determines whether OK button of the dialog is enabled. Set to False to prevent the dialog box closing.


FolderName : string; R

Public; protected in custom version

After dialog box is closed, you can read this property to get folder name (with disk name and path) you selected.


FolderPidl; R

Public; protected in custom version

The same as FolderName, but returns PItemIDList. See Win32 Reference for information about ITEMIDLIST structure.


DisplayName : string; R

Published; protected in custom version

Short user-friendly name of the folder you selected (without disk and path).


Text : string; RW

Published; protected in custom version

Wrapper for Win32 BROWSEINFO.plszTitle struct member.



Methods

No items in this section.



Events

All the new properties below are "dialog-time".


OnSelectionChange: TNotifyEvent

Published; protected in custom version

Occures if user changes the folder.