Sign in Join
FPDoc Onlineexperiment

TOpenOption enumeration

In unit System.UITypes

Represents options available in a open dialog (TOpenDialog).

Declaration

pascal
TOpenOption = (ofReadOnly,ofOverwritePrompt,ofHideReadOnly,
 ofNoChangeDir,ofShowHelp,ofNoValidate,ofAllowMultiSelect,
 ofExtensionDifferent,ofPathMustExist,ofFileMustExist,
 ofCreatePrompt,ofShareAware,ofNoReadOnlyReturn,
 ofNoTestFileCreate,ofNoNetworkButton,ofNoLongNames,
 ofOldStyleDialog,ofNoDereferenceLinks,
 ofEnableIncludeNotify,ofEnableSizing,ofDontAddToRecent,
 ofForceShowHidden)

Description

TOpenOption contains the options which can be used in an Open dialog. Values from the enumeration are stored in the TOpenOptions set type which is used to implement the Options property in TOpenDialog. When an option value is included in the set, it is enabled during execution of the dialog. The values are applied to a native dialog before it is executed.

Please note that some option values may not be available for a given platform: ofNoDereferenceLinks, ofOldStyleDialog, ofViewDetail, and ofAutoPreview.

See also

Values

ofReadOnlyIncludes read-only files.
ofOverwritePromptIf the selected file exists, a message is displayed if the file will be overwritten.
ofHideReadOnlyHides read-only files.
ofNoChangeDirPrevents changing the current directory.
ofShowHelpShow a help button on the dialog.
ofNoValidateDisables file name validation using OFN_NOVALIDATE on the Windows platform.
ofAllowMultiSelectEnables multiple file name selection using a dialog.
ofExtensionDifferentAllows a file name with an extension which does not match the filters or default extension in a file dialog.
ofPathMustExistShows an error message if the selected path does not exist.
ofFileMustExistShows an error message if the selected/entered file name does not exist.
ofCreatePromptEnables a verification prompt when a file or directory needs to be created.
ofShareAwareIncludes the OFN_SHAREAWARE flag on the Windows platform.
ofNoReadOnlyReturnPrevents returning file names that are read-only.
ofNoTestFileCreateIncludes the OFN_NOTESTFILECREATE flag on the Windows platform.
ofNoNetworkButtonDisables and hides the Network button on the Windows platform.
ofNoLongNamesDisables long file names on the Windows platform. Used in classic-style dialogs to force use of file names using the 8.3 format. Explorer-style dialogs ignore this flag and always display long file names.
ofOldStyleDialogPrevents use of OFN_EXPLORER and dependent flags in dialogs on the Windows platform.
ofNoDereferenceLinksDo not resolve links while a dialog is shown (for Windows only, see OFN_NODEREFERENCELINKS).
ofEnableIncludeNotifyNot currently in use.
ofEnableSizingDialog can be resized using the mouse.
ofDontAddToRecentPrevents adding selection(s) to the history list.
ofForceShowHiddenCauses hidden files to be displayed.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.