Prompts the user to select a folder.

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

Syntax

         
 C#  Visual Basic  Visual C++ 
public sealed class VistaFolderBrowserDialog : CommonDialog
Public NotInheritable Class VistaFolderBrowserDialog _
	Inherits CommonDialog
public ref class VistaFolderBrowserDialog sealed : public CommonDialog

Members

               
 All Members  Constructors   Properties   Methods   Events  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
VistaFolderBrowserDialog()()()
Creates a new instance of the VistaFolderBrowserDialog class.
CanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Container
Gets the IContainer that contains the Component.
(Inherited from Component.)
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.)
Description
Gets or sets the descriptive text displayed above the tree view control in the dialog box, or below the list view control in the Vista style dialog.
DesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Dispose()()()
Releases all resources used by the Component.
(Inherited from Component.)
Dispose(Boolean)
Releases the unmanaged resources used by the Component and optionally releases the managed resources.
(Inherited from Component.)
Disposed
Occurs when the component is disposed by a call to the Dispose()()() method.
(Inherited from Component.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Events
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Finalize()()()
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetLifetimeService()()()
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
GetService(Type)
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.)
HelpRequest
Occurs when the user clicks the Help button on the dialog box.
HookProc(IntPtr, Int32, IntPtr, IntPtr)
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.)
IsVistaFolderDialogSupported
Gets a value that indicates whether the current OS supports Vista-style common file dialogs.
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.)
OnHelpRequest(EventArgs)
Raises the HelpRequest event.
(Inherited from CommonDialog.)
OwnerWndProc(IntPtr, Int32, IntPtr, IntPtr)
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 CommonDialog..::.Reset()()().)
RootFolder
Gets or sets the root folder where the browsing starts from. This property has no effect if the Vista style dialog is used.
RunDialog(IntPtr)
When overridden in a derived class, specifies a common dialog box.
(Inherited from CommonDialog.)
SelectedPath
Gets or sets the path selected by the user.
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.)
ShowNewFolderButton
Gets or sets a value indicating whether the New Folder button appears in the folder browser dialog box. This property has no effect if the Vista style dialog is used; in that case, the New Folder button is always shown.
Site
Gets or sets the ISite of the Component.
(Inherited from Component.)
Tag
Gets or sets an object that contains data about the control.
(Inherited from CommonDialog.)
ToString()()()
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
UseDescriptionForTitle
Gets or sets a value that indicates whether to use the value of the Description property as the dialog title for Vista style dialogs. This property has no effect on old style dialogs.

Remarks

This class will use the Vista style Select Folder dialog if possible, or the regular FolderBrowserDialog if it is not. Note that the Vista style dialog is very different, so using this class without testing in both Vista and older Windows versions is not recommended.

Inheritance Hierarchy

System..::.Object
  System..::.MarshalByRefObject
    System.ComponentModel..::.Component
      System.Windows.Forms..::.CommonDialog
        Ookii.Dialogs..::.VistaFolderBrowserDialog

Thread Safety

Static members of this type are safe for multi-threaded operations. Instance members of this type are not safe for multi-threaded operations.

See Also