Back to Devexpress

XtraOpenFileDialog Members

windowsforms-devexpress-dot-xtraeditors-dot-xtraopenfiledialog-dot-underscore-members.md

latest21.6 KB
Original Source

XtraOpenFileDialog Members

A dialog that allows a user to open a file. Supports DevExpress Skins.

Constructors

NameDescription
XtraOpenFileDialog()Initializes a new instance of the XtraOpenFileDialog class with the default settings.
XtraOpenFileDialog(IContainer)Initializes a new instance of the XtraOpenFileDialog class with the specified settings.

Properties

NameDescription
AddExtensionGets 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. Inherited from FileDialogBase.
AllowDragDropGets or sets whether users can drag and drop files/folders inside the dialog. Inherited from XtraCommonDialog.
AutoUpdateFilterDescriptionGets or sets whether a dialog with file extension filters (see FileDialogBase.Filter) shows filter patterns for each filter option. Inherited from FileDialogBase.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CheckFileExistsGets or sets whether or not this XtraOpenFileDialog should warn a user if a file with the specified name does not exist.
CheckPathExistsGets 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. Inherited from FileDialogBase.
ContainerGets the IContainer that contains the Component. Inherited from Component.
CustomPlacesA collection of quick access paths to which a user can navigate. This property is identical to the standard FileDialog.CustomPlaces property. Inherited from FileDialogBase.
DefaultExtGets or sets the default file extension (without the dot character). This property is identical to the standard FileDialog.DefaultExt property. Inherited from FileDialogBase.
DefaultViewModeGets or sets the initial dialog view (“Tiles”, “Table”, “Medium icons”, etc.). Inherited from FileDialogBase.
DereferenceLinksIf 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. Inherited from FileDialogBase.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FileNameGets 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. Inherited from FileDialogBase.
FileNamesReturns 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. Inherited from FileDialogBase.
FilterAllows you to save or open files only of specific types. This property is identical to the standard FileDialog.Filter property. Inherited from FileDialogBase.
FilterIndexGets or sets the index of the filter currently selected in the file dialog box. This property is identical to the standard FileDialog.FilterIndex property. Inherited from FileDialogBase.
InitialDirectoryGets or sets the location which the dialog shows upon the first launch. This property is identical to the standard FileDialog.InitialDirectory. Inherited from FileDialogBase.
KeepPositionGets or sets whether the dialog retains its position between starts. Inherited from XtraCommonDialog.
LocationGets or sets coordinates of the dialog upper-left corner relative to the screen. Inherited from XtraCommonDialog.
MultiselectGets or sets whether or not users are allowed to select multiple files in this XtraOpenFileDialog.
RestoreDirectoryIf 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. Inherited from FileDialogBase.
SafeFileNameReturns the selected file name and extension. The returned name does not include the file path.
SafeFileNamesReturns an array of file names and extensions for all the selected files in the dialog box. File names do not include paths.
ShowDragDropConfirmationGets or sets whether to display a confirmation message when a user drops a file/folder in a new location. Inherited from XtraCommonDialog.
ShowHelpGets or sets whether the dialog displays the Help button. This property is identical to the standard FileDialog.ShowHelp property. Inherited from FileDialogBase.
ShowNavigationPaneGets or sets whether to display the Navigation Pane. Inherited from XtraCommonDialog.
SiteGets or sets the ISite of the Component. Inherited from Component.
StartPositionGets or sets the dialog start position. Inherited from XtraCommonDialog.
SupportMultiDottedExtensionsGets or sets whether the dialog supports filters with more than one dot character. This property is identical to the standard FileDialog.SupportMultiDottedExtensions property. Inherited from FileDialogBase.
TagGets or sets an object that contains data about the control. Inherited from CommonDialog.
TitleGets or sets the dialog window’s title. Inherited from XtraCommonDialog.
UseParentFormIconGets or sets whether to inherit the dialog window icon from the parent form. Inherited from XtraCommonDialog.
ValidateNamesGets 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. Inherited from FileDialogBase.

Methods

NameDescription
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) protectedReleases the unmanaged resources used by the Component and optionally releases the managed resources. Inherited from Component.
Equals(Object, Object) staticDetermines 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() staticForces 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) protectedReturns 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) protectedDefines 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() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
OnHelpRequest(EventArgs) protectedRaises the HelpRequest event. Inherited from CommonDialog.
OpenFile()Opens the file specified by the FileName property. The file is opened with read-only permission.
OwnerWndProc(IntPtr, Int32, IntPtr, IntPtr) protectedDefines the owner window procedure that is overridden to add specific functionality to a common dialog box. Inherited from CommonDialog.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Reset()Resets all dialog properties to their default values. Inherited from FileDialogBase.
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

NameDescription
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
FileOkFires when a user presses “Save” or “Open” (depending on the current dialog type). Inherited from FileDialogBase.
HelpRequestOccurs when the user clicks the Help button on a common dialog box. Inherited from CommonDialog.

See Also

XtraOpenFileDialog Class

DevExpress.XtraEditors Namespace