Back to Devexpress

DialogParameters Class

wpf-devexpress-dot-xpf-dot-editors-f4274fb9.md

latest11.0 KB
Original Source

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.v25.2.dll

NuGet Package : DevExpress.Wpf.Core

Declaration

csharp
public class DialogParameters
vb
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

PropertyDescription
CheckFileExistsGets or sets whether to display a warning if a user specifies a file that does not exist.
CheckPathExistsGets or sets whether to display a warning if a user specifies a path that does not exist.
DefaultExtGets or sets the default file extension.
DereferenceLinksGets or sets whether the dialog returns the location of the file referenced by a shortcut or whether it returns the shortcut’s location.
DialogTypeGets the dialog’s type.
FileNameGets or sets the file name displayed in the dialog.
FilterIndexGets or sets the selected dialog filter’s index.
InitialDirectoryGets or sets the dialog’s initial directory.
TitleGets or sets the dialog window’s title.

Save File Dialog

PropertyDescription
CheckFileExistsGets or sets whether to display a warning if a user specifies a file that does not exist.
CreatePromptGets or sets whether to prompt a user for permission to create a file if a user specifies a file that does not exist.
DefaultExtGets or sets the default file extension.
DereferenceLinksGets or sets whether the dialog returns the location of the file referenced by a shortcut or whether it returns the shortcut’s location.
DialogTypeGets the dialog’s type.
FileNameGets or sets the file name displayed in the dialog.
FilterIndexGets or sets the selected dialog filter’s index.
InitialDirectoryGets or sets the dialog’s initial directory.
OverwritePromptGets or sets whether to prompt a user for permission to overwrite a file if a user specifies a file that already exists.
TitleGets 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:

PropertyDescription
DescriptionGets or sets the text displayed in the browse folder dialog.
DialogTypeGets the dialog’s type.
InitialDirectoryGets or sets the dialog’s initial directory.
SelectedPathGets or sets the path selected in the browse folder dialog.
UseDescriptionForTitleGets or sets whether to use the Description property value as the dialog’s title.

Old Open File Dialog

PropertyDescription
AddExtensionGets or sets whether to add an extension (specified by the DialogParameters.DefaultExt or BrowsePathEdit.Filter property) to the file name.
CheckFileExistsGets or sets whether to display a warning if a user specifies a file that does not exist.
CheckPathExistsGets or sets whether to display a warning if a user specifies a path that does not exist.
DefaultExtGets or sets the default file extension.
DereferenceLinksGets or sets whether the dialog returns the location of the file referenced by a shortcut or whether it returns the shortcut’s location.
DialogTypeGets the dialog’s type.
FileNameGets or sets the file name displayed in the dialog.
FilterIndexGets or sets the selected dialog filter’s index.
InitialDirectoryGets or sets the dialog’s initial directory.
ReadOnlyCheckedGets or sets whether the Open as read-only check box is checked.
ShowHelpGets or sets whether to display the Help button.
ShowReadOnlyGets or sets whether to display the Open as read-only check box.
SupportMultiDottedExtensionsGets or sets whether the dialog supports operations with files that have multiple extensions.
TitleGets or sets the dialog window’s title.
ValidateNamesGets or sets whether to display a warning when a user enters an invalid Win32 file name.

Old Save File Dialog

PropertyDescription
AddExtensionGets or sets whether to add an extension (specified by the DialogParameters.DefaultExt or BrowsePathEdit.Filter property) to the file name.
CheckFileExistsGets or sets whether to display a warning if a user specifies a file that does not exist.
CreatePromptGets or sets whether to prompt a user for permission to create a file if a user specifies a file that does not exist.
DefaultExtGets or sets the default file extension.
DereferenceLinksGets or sets whether the dialog returns the location of the file referenced by a shortcut or whether it returns the shortcut’s location.
DialogTypeGets the dialog’s type.
FileNameGets or sets the file name displayed in the dialog.
FilterIndexGets or sets the selected dialog filter’s index.
InitialDirectoryGets or sets the dialog’s initial directory.
OverwritePromptGets or sets whether to prompt a user for permission to overwrite a file if a user specifies a file that already exists.
ShowHelpGets or sets whether to display the Help button.
SupportMultiDottedExtensionsGets or sets whether the dialog supports operations with files that have multiple extensions.
TitleGets or sets the dialog window’s title.
ValidateNamesGets 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:

PropertyDescription
DescriptionGets or sets the text displayed in the browse folder dialog.
DialogTypeGets the dialog’s type.
RootFolderGets or sets the browse folder dialog’s root folder.
SelectedPathGets or sets the path selected in the browse folder dialog.
ShowNewFolderButtonGets or sets whether to display the Make New Folder button in the browse folder dialog.

Inheritance

Object DialogParameters

See Also

DialogParameters Members

DevExpress.Xpf.Editors Namespace