VistaFileDialog Class

Displays a dialog box from which the user can select a file.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsCommonDialog
        Ookii.DialogsVistaFileDialog
          Ookii.DialogsVistaOpenFileDialog
          Ookii.DialogsVistaSaveFileDialog

Namespace: Ookii.Dialogs
Assembly: Ookii.Dialogs (in Ookii.Dialogs.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public abstract class VistaFileDialog : CommonDialog

Public MustInherit Class VistaFileDialog
	Inherits CommonDialog

public ref class VistaFileDialog abstract : public CommonDialog

[<AbstractClassAttribute>]
type VistaFileDialog =  
    class
        inherit CommonDialog
    end

The VistaFileDialog type exposes the following members.

Constructors

	Name	Description
	VistaFileDialog	Creates a new insatnce of VistaFileDialog class.

Top

Properties

	Name	Description
	AddExtension	Gets or sets a value indicating whether the dialog box automatically adds an extension to a file name if the user omits the extension.
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	CheckFileExists	Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
	CheckPathExists	Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a path that does not exist.
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	DefaultExt	Gets or sets the default file name extension.
	DereferenceLinks	Gets or sets a value indicating whether the dialog box returns the location of the file referenced by the shortcut or whether it returns the location of the shortcut (.lnk).
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	DownlevelDialog	Gets or sets the downlevel file dialog which is to be used if the Vista-style dialog is not supported.
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	FileName	Gets or sets a string containing the file name selected in the file dialog box.
	FileNames	Gets the file names of all selected files in the dialog box.
	Filter	Gets or sets the current file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box.
	FilterIndex	Gets or sets the index of the filter currently selected in the file dialog box.
	InitialDirectory	Gets or sets the initial directory displayed by the file dialog box.
	IsVistaFileDialogSupported	Gets a value that indicates whether the current OS supports Vista-style common file dialogs.
	RestoreDirectory	Gets or sets a value indicating whether the dialog box restores the current directory before closing.
	ShowHelp	Gets or sets a value indicating whether the Help button is displayed in the file dialog box.
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)
	SupportMultiDottedExtensions	Gets or sets whether the dialog box supports displaying and saving files that have multiple file name extensions.
	Tag	Gets or sets an object that contains data about the control. (Inherited from CommonDialog.)
	Title	Gets or sets the file dialog box title.
	ValidateNames	Gets or sets a value indicating whether the dialog box accepts only valid Win32 file names.

Top

Methods

	Name	Description
	CreateObjRef	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)	Releases the unmanaged resources used by the VistaFileDialog and optionally releases the managed resources. (Overrides ComponentDispose(Boolean).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
	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	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	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	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnFileOk	Raises the FileOk event.
	OnHelpRequest	Raises the HelpRequest event. (Inherited from CommonDialog.)
	OwnerWndProc	Defines the owner window procedure that is overridden to add specific functionality to a common dialog box. (Inherited from CommonDialog.)
	Reset	Resets all properties to their default values. (Overrides CommonDialogReset.)
	RunDialog	Specifies a common dialog box. (Overrides CommonDialogRunDialog(IntPtr).)
	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.)

Top

Events

	Name	Description
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
	FileOk	Occurs when the user clicks on the Open or Save button on a file dialog box.
	HelpRequest	Occurs when the user clicks the Help button on a common dialog box. (Inherited from CommonDialog.)

Top

Remarks

This class will use the Vista style file dialog if possible, and automatically fall back to the old-style dialog on versions of Windows older than Vista.

As of .Net 3.5 and .Net 2.0 SP1, the regular FileDialog class will also use the new Vista style dialogs. However, certain options, such as settings ShowReadOnly, still cause that class to revert to the old style dialogs. For this reason, this class is still provided. It is recommended that you use the FileDialog class whenever possible.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

Ookii.Dialogs Namespace