FolderBrowserDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• CommonDialog
  • FolderBrowserDialog

Allows the user to select a folder from one of the Roots.

C#

public class FolderBrowserDialog : CommonDialog

VB.NET

Public Class FolderBrowserDialog
    Inherits CommonDialog

Constructors

FolderBrowserDialog()

Initializes a new instance of FolderBrowserDialog.

FolderBrowserDialog(roots)

Initializes a new instance of FolderBrowserDialog using the initial roots .

Name	Type	Description
roots	IFileSystemProvider[]	Initial file systems to load in the FolderBrowserDialog.

FolderBrowserDialog(container)

Initializes a new instance of the FolderBrowserDialog extender with a specified container.

Name	Type	Description
container	IContainer	An IContainer that represents the container of the FolderBrowserDialog component.

Properties

Description

String: Returns or sets the description splayed above the tree view control in the dialog box. (Default: "")

Roots

FileDialogRootCollection: List of root IFileSystemProvider file systems displayed by the FolderBrowserDialog.

The Roots collection and the IFileSystemProvider implementations allow the application to use arbitrary names mapped to a specific path.

For example, the app may add a root object named "Documents" to "c:\users[logged-user-id]\files\documents". Each user will see "Documents" as the root, but will also see only the files in the [logged-user-id] directory.

The deafult value is an empty FileDialogRootCollection

SelectedPath

String: Returns sets the path selected by the user. (Default: "")

ShowHelp

Boolean: Returns or sets whether the Help button is displayed in the file dialog box. (Default: False)

Title

String: Returns or sets the file dialog box title. (Default: "")

Methods

CreateUI()

Returns: Form.

GetRoot(path)

Returns the IFileSystemProvider that contains the specified path .

Parameter	Type	Description
path	String	Full path of the file to locate in on of the Roots.

Returns: IFileSystemProvider. The IFileSystemProvider that contains the specified path or null if not found.

MapPath(folderPath)

Maps the virtual path to the corresponding physical path on the specific IFileSystemProvider implementation.

Parameter	Type	Description
folderPath	String	Virtual path to map to the corresponding physical path.

Returns: String. The physical path for the IFileSystemProvider implementation.

OnLoadPath(e)

Fires the LoadPath event.

Parameter	Type	Description
e	FileDialogLoadPathEventArgs	A FileDialogLoadPathEventArgs object that provides the event data.

Reset()

Resets all properties to their default values.

Events

LoadPath

FileDialogLoadPathEventHandler Fired when the file dialog is loading a file or folder.