Skip to main content
All docs
V24.1

DialogParameters Class

Contains parameters that allow you to set up the dialog invoked from the BrowsePathEdit editor.

Namespace: DevExpress.Xpf.Editors

Assembly: DevExpress.Xpf.Core.v24.1.dll

NuGet Package: DevExpress.Wpf.Core

Declaration

public class DialogParameters

The following members return DialogParameters objects:

Remarks

If you set the ShowHelp or ShowReadOnly property to true, Windows displays old open and save file dialogs. Some DialogParameters class properties affect only these dialogs. The following tables differ properties by a dialog type.

Open File Dialog

Property Description
CheckFileExists Gets or sets whether to display a warning if a user specifies a file that does not exist.
CheckPathExists Gets or sets whether to display a warning if a user specifies a path that does not exist.
DefaultExt Gets or sets the default file extension.
DereferenceLinks Gets or sets whether the dialog returns the location of the file referenced by a shortcut or whether it returns the shortcut’s location.
DialogType Gets the dialog’s type.
FileName Gets or sets the file name displayed in the dialog.
FilterIndex Gets or sets the selected dialog filter’s index.
InitialDirectory Gets or sets the dialog’s initial directory.
Title Gets or sets the dialog window’s title.

Save File Dialog

Property Description
CheckFileExists Gets or sets whether to display a warning if a user specifies a file that does not exist.
CreatePrompt Gets or sets whether to prompt a user for permission to create a file if a user specifies a file that does not exist.
DefaultExt Gets or sets the default file extension.
DereferenceLinks Gets or sets whether the dialog returns the location of the file referenced by a shortcut or whether it returns the shortcut’s location.
DialogType Gets the dialog’s type.
FileName Gets or sets the file name displayed in the dialog.
FilterIndex Gets or sets the selected dialog filter’s index.
InitialDirectory Gets or sets the dialog’s initial directory.
OverwritePrompt Gets or sets whether to prompt a user for permission to overwrite a file if a user specifies a file that already exists.
Title Gets or sets the dialog window’s title.

Browse Folder Dialog

This dialog is displayed if your project targets .NET/.NET Core. The table below lists properties that affect the dialog’s behavior and appearance:

Property Description
Description Gets or sets the text displayed in the browse folder dialog.
DialogType Gets the dialog’s type.
InitialDirectory Gets or sets the dialog’s initial directory.
SelectedPath Gets or sets the path selected in the browse folder dialog.
UseDescriptionForTitle Gets or sets whether to use the Description property value as the dialog’s title.

Old Open File Dialog

Property Description
AddExtension Gets or sets whether to add an extension (specified by the DialogParameters.DefaultExt or BrowsePathEdit.Filter property) to the file name.
CheckFileExists Gets or sets whether to display a warning if a user specifies a file that does not exist.
CheckPathExists Gets or sets whether to display a warning if a user specifies a path that does not exist.
DefaultExt Gets or sets the default file extension.
DereferenceLinks Gets or sets whether the dialog returns the location of the file referenced by a shortcut or whether it returns the shortcut’s location.
DialogType Gets the dialog’s type.
FileName Gets or sets the file name displayed in the dialog.
FilterIndex Gets or sets the selected dialog filter’s index.
InitialDirectory Gets or sets the dialog’s initial directory.
ReadOnlyChecked Gets or sets whether the Open as read-only check box is checked.
ShowHelp Gets or sets whether to display the Help button.
ShowReadOnly Gets or sets whether to display the Open as read-only check box.
SupportMultiDottedExtensions Gets or sets whether the dialog supports operations with files that have multiple extensions.
Title Gets or sets the dialog window’s title.
ValidateNames Gets or sets whether to display a warning when a user enters an invalid Win32 file name.

Old Save File Dialog

Property Description
AddExtension Gets or sets whether to add an extension (specified by the DialogParameters.DefaultExt or BrowsePathEdit.Filter property) to the file name.
CheckFileExists Gets or sets whether to display a warning if a user specifies a file that does not exist.
CreatePrompt Gets or sets whether to prompt a user for permission to create a file if a user specifies a file that does not exist.
DefaultExt Gets or sets the default file extension.
DereferenceLinks Gets or sets whether the dialog returns the location of the file referenced by a shortcut or whether it returns the shortcut’s location.
DialogType Gets the dialog’s type.
FileName Gets or sets the file name displayed in the dialog.
FilterIndex Gets or sets the selected dialog filter’s index.
InitialDirectory Gets or sets the dialog’s initial directory.
OverwritePrompt Gets or sets whether to prompt a user for permission to overwrite a file if a user specifies a file that already exists.
ShowHelp Gets or sets whether to display the Help button.
SupportMultiDottedExtensions Gets or sets whether the dialog supports operations with files that have multiple extensions.
Title Gets or sets the dialog window’s title.
ValidateNames Gets or sets whether to display a warning when a user enters an invalid Win32 file name.

Old Browse Folder Dialog

In the projects that target .NET Framework, Windows displays an old browse folder dialog. The following table lists properties that affect the dialog’s behavior and appearance:

Property Description
Description Gets or sets the text displayed in the browse folder dialog.
DialogType Gets the dialog’s type.
RootFolder Gets or sets the browse folder dialog’s root folder.
SelectedPath Gets or sets the path selected in the browse folder dialog.
ShowNewFolderButton Gets or sets whether to display the Make New Folder button in the browse folder dialog.

Inheritance

Object
DialogParameters
See Also