Skip to main content

FileDialogBase Members

Implements API common for the XtraOpenFileDialog and XtraSaveFileDialog dialogs.

Constructors

Name Description
FileDialogBase() Initializes a new instance of the FileDialogBase class.
FileDialogBase(IContainer) Initializes a new instance of the FileDialogBase class with specified settings.

Properties

Name Description
AddExtension Gets or sets whether a dialog should automatically add an extension to a file name if a user omits the extension. This property is identical to the standard FileDialog.AddExtension property.
AllowDragDrop Gets or sets whether users can drag and drop files/folders inside the dialog. Inherited from XtraCommonDialog.
AutoUpdateFilterDescription Gets or sets whether a dialog with file extension filters (see FileDialogBase.Filter) shows filter patterns for each filter option.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
CheckFileExists Gets or sets whether the dialog box displays a warning if a user specifies a file name that does not exist. This property is identical to the standard FileDialog.CheckFileExists property.
CheckPathExists Gets or sets whether the dialog box displays a warning if a user specifies a path that does not exist. This property is identical to the standard FileDialog.CheckPathExists property.
Container Gets the IContainer that contains the Component. Inherited from Component.
CustomPlaces A collection of quick access paths to which a user can navigate. This property is identical to the standard FileDialog.CustomPlaces property.
DefaultExt Gets or sets the default file extension (without the dot character). This property is identical to the standard FileDialog.DefaultExt property.
DefaultViewMode Gets or sets the initial dialog view (“Tiles”, “Table”, “Medium icons”, etc.).
DereferenceLinks If a user selects a shortcut, this property specifies whether the dialog returns this shortcut location, or the location of a file this shortcut references. This property is identical to the standard FileDialog.DereferenceLinks property.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
FileName Gets or sets the selected file name, or an empty string if no file was selected. This property is identical to the standard FileDialog.FileName property.
FileNames Returns an array of file names opened in the XtraOpenFileDialog. Has no effect for the XtraSaveFileDialog. This property is identical to the standard FileDialog.FileNames property.
Filter Allows you to save or open files only of specific types. This property is identical to the standard FileDialog.Filter property.
FilterIndex Gets or sets the index of the filter currently selected in the file dialog box. This property is identical to the standard FileDialog.FilterIndex property.
InitialDirectory Gets or sets the location which the dialog shows upon the first launch. This property is identical to the standard FileDialog.InitialDirectory.
KeepPosition Gets or sets whether the dialog retains its position between starts. Inherited from XtraCommonDialog.
Location Gets or sets coordinates of the dialog upper-left corner relative to the screen. Inherited from XtraCommonDialog.
RestoreDirectory If a user navigates to a different directory and closes the dialog without saving (opening) a new file, this property specifies whether this new location should be remembered. This property is identical to the standard FileDialog.RestoreDirectory property.
ShowDragDropConfirmation Gets or sets whether to display a confirmation message when a user drops a file/folder in a new location. Inherited from XtraCommonDialog.
ShowHelp Gets or sets whether the dialog displays the Help button. This property is identical to the standard FileDialog.ShowHelp property.
ShowNavigationPane Gets or sets whether to display the Navigation Pane. Inherited from XtraCommonDialog.
Site Gets or sets the ISite of the Component. Inherited from Component.
StartPosition Gets or sets the dialog start position. Inherited from XtraCommonDialog.
SupportMultiDottedExtensions Gets or sets whether the dialog supports filters with more than one dot character. This property is identical to the standard FileDialog.SupportMultiDottedExtensions property.
Tag Gets or sets an object that contains data about the control. Inherited from CommonDialog.
Title Gets or sets the dialog window’s title. Inherited from XtraCommonDialog.
UseParentFormIcon Gets or sets whether to inherit the dialog window icon from the parent form. Inherited from XtraCommonDialog.
ValidateNames Gets or sets whether the dialog supports Win32 file names only (no angle brackets, no colons, 3-character extension, etc.). This property is identical to the standard FileDialog.ValidateNames property.

Methods

Name Description
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
Dispose(Boolean) protected Releases the unmanaged resources used by the Component and optionally releases the managed resources. Inherited from Component.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
ForceInitialize() static Forces the dialog to finish its initialization. Inherited from XtraCommonDialog.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
HookProc(IntPtr, Int32, IntPtr, IntPtr) protected Defines the common dialog box hook procedure that is overridden to add specific functionality to a common dialog box. Inherited from CommonDialog.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
OnHelpRequest(EventArgs) protected Raises the HelpRequest event. Inherited from CommonDialog.
OwnerWndProc(IntPtr, Int32, IntPtr, IntPtr) protected Defines the owner window procedure that is overridden to add specific functionality to a common dialog box. Inherited from CommonDialog.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Reset() Resets all dialog properties to their default values.
ShowDialog() Runs a common dialog box with a default owner. Inherited from CommonDialog.
ShowDialog(IWin32Window) Runs a common dialog box with the specified owner. Inherited from CommonDialog.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
FileOk Fires when a user presses “Save” or “Open” (depending on the current dialog type).
HelpRequest Occurs when the user clicks the Help button on a common dialog box. Inherited from CommonDialog.
See Also