TOpenDialog class

In unit Dialogs

Implements a File / Open dialog used to select one or more files on the local file system.

Declaration

pascal

TOpenDialog = class(TFileDialog)

Inheritance

Descends from it: TLazOpenDialog TPreviewFileDialog TSaveDialog TSelectDirectoryDialog

Description

TOpenDialog is a TFileDialog descendent which implements a dialog used to select one or more files that can be opened in an application. TOpenDialog is implemented as a wrapper for the native file selection dialogs on the various platforms / widgetsets.

Use the Options property to configure the features and behaviors enabled when the dialog is executed. Please note that some of the options are platform-specific, and may not be available on all of the platforms supported by the Lazarus LCL.

Use InitialDir to specify the directory with the files displayed when the dialog is executed.

Use the event handlers to perform actions needed when the directory or file selection(s) is changed during execution of the dialog.

Use the FileName or Files properties to access the file(s) selected using the dialog.

Use the Filter and FilterIndex properties to determine the file extensions displayed in the dialog. Use the OnTypeChange event handler to perform actions needed when the active filter is changed.

Use the UserChoice property to determine the button pressed to close the dialog.

Properties

`Options`	published	Options to be used for this dialog.
`OptionsEx`	published	Widgetset-specific options enabled for the dialog.

Methods

`WSRegisterClass`	protected	Registers this component class with the current WidgetSet.
`ResolveLinks`	protected	Gets physical file names for symbolic links or file references.
`CheckFile`	protected	Ensures the specified file name meets the requirements for the dialog.
`CheckFileMustExist`	protected	Determines whether the specified file name exists.
`CheckAllFiles`	protected	Ensures that values in the FileName and Files properties are valid for the Options in the dialog.
`DoExecute`	protected	Performs actions needed to display the dialog and capture its result.
`DefaultTitle`	protected	Gets the default title used for the Open Dialog.
`Create`	public	Constructor for the class instance.
`DoCanClose`	public	Performs actions to determine if the dialog can be closed.
`DoFolderChange`	public	Signals the OnFolderChange event handler when a new directory is selected during execution of the dialog.
`DoSelectionChange`	public	Performs actions when the selected file in FileName has been changed.
`IntfSetOption`	public	Implements the callback used to update values in Options when the widgetset class processes the dialog result.

Events

`OnFolderChange`	published	Event signalled when a new directory is selected in the dialog.
`OnSelectionChange`	published	Event triggered when the user changes the folder of file selection(s) made in the OpenDialog.