 | OpenFileDialog Class |
Prompts the user to open a file from the server.
Inheritance HierarchyNamespace: Wisej.Web
Assembly: Wisej.Framework (in Wisej.Framework.dll) Version: 2.0.0.0
SyntaxThe OpenFileDialog type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OpenFileDialog |
Initializes a new instance of OpenFileDialog.
|
| OpenFileDialog(IContainer) |
Initializes a new instance of the OpenFileDialog extender with a specified container.
|
Properties| Name | Description | |
|---|---|---|
 | AddExtension |
Returns or sets whether the dialog box automatically adds an extension to a file name if the user omits the extension.
(Inherited from FileDialog.) |
| CheckFileExists |
Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
(Overrides FileDialogCheckFileExists.) |
| DefaultExtension |
Returns or sets the default file name extension.
(Inherited from FileDialog.) |
| DialogTemplate |
Returns or sets the type of the common dialog UI control
to show when calling the ShowDialog method.
(Inherited from CommonDialog.) |
| FileName |
Returns or sets a string containing the file name selected in the file dialog box.
(Inherited from FileDialog.) |
| FileNames |
Returns the file names of all selected files in the dialog box.
(Inherited from FileDialog.) |
| FileSystem |
Returns the IFileSystemProvider that contains the
selected FileName.
(Inherited from FileDialog.) |
| Filter |
Returns 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.
(Inherited from FileDialog.) |
| FilterIndex |
Returns or sets the index of the filter currently selected in the file dialog box.
(Inherited from FileDialog.) |
| InitialDirectory |
Returns or sets the initial directory displayed by the file dialog box.
(Inherited from FileDialog.) |
| Multiselect |
Returns or sets a value indicating whether the dialog box allows multiple files to be selected.
|
 | Roots |
List of root IFileSystemProvider file systems displayed by the FileDialog.
(Inherited from FileDialog.) |
| SafeFileName |
Returns the file name and extension for the file selected in the dialog box. The file name does not include the path.
|
| SafeFileNames |
Returns an array of file names and extensions for all the selected files in the dialog box. The file names do not include the path.
|
| ShowHelp |
Returns or sets whether the Help button is displayed in the file dialog box.
(Inherited from FileDialog.) |
| Tag |
Returns or sets an object that contains data about the control.
(Inherited from CommonDialog.) |
| Title |
Returns or sets the file dialog box title.
(Inherited from FileDialog.) |
| WindowState |
Returns or sets the initial WindowState of the common dialog.
(Inherited from CommonDialog.) |
Methods| Name | Description | |
|---|---|---|
 | CreateUI | (Inherited from FileDialog.) |
| Dispose | (Inherited from CommonDialog.) |
| GetRoot |
Returns the IFileSystemProvider that contains the
specified path.
(Inherited from FileDialog.) |
| MapPath |
Maps the virtual path to the corresponding physical path
on the specific IFileSystemProvider implementation.
(Inherited from FileDialog.) |
| OnFileOk |
Fires the FileOk event.
(Inherited from FileDialog.) |
| OnHelpRequested |
Fires the HelpRequest event.
(Inherited from CommonDialog.) |
| OnLoadPath |
Fires the LoadPath event.
(Inherited from CommonDialog.) |
| OpenFile |
Opens the file selected by the user, with read-only permission.
The file is specified by the FileName property.
|
| ProcessFileNames |
Receives the file names selected by the user and validates them
according to the properties set in the FileDialog instance.
(Inherited from FileDialog.) |
| PromptFileNotFound |
Informs the user that the file specified in fileName
doesn't exist. You can override this method to provide your text and localization.
(Inherited from FileDialog.) |
| Reset |
Resets all properties to their default values.
(Overrides FileDialogReset.) |
| ShowDialog |
Runs a common dialog box with a default owner.
(Inherited from CommonDialog.) |
| ShowDialog(ActionDialogResult) |
Runs a common dialog box with a default owner.
(Inherited from CommonDialog.) |
| ShowDialog(Form) |
Runs a common dialog box with the specified owner.
(Inherited from CommonDialog.) |
| ShowDialog(Form, ActionDialogResult) |
Runs a common dialog box with the specified owner.
(Inherited from CommonDialog.) |
| ShowDialogAsync |
Runs a common dialog box with the specified owner asynchronously.
(Inherited from CommonDialog.) |
| ToString |
Returns a string that represents the FileDialog.
(Inherited from FileDialog.) |
Events| Name | Description | |
|---|---|---|
 | FileOk |
Fired when the user clicks on the Open or Save button on a file dialog box.
(Inherited from FileDialog.) |
| HelpRequested |
Fired when the user clicks the Help button on a common dialog box.
(Inherited from CommonDialog.) |
| LoadPath |
EXPERIMENTAL: Fired when the file dialog is loading a file or folder.
(Inherited from CommonDialog.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Beep |
Sounds a tone through the computer's speaker.
(Defined by Interaction.) |
| InputBox |
Displays a prompt in a dialog box, waits for the user to input text or click a button, and then returns a string containing the contents of the text box.
(Defined by Interaction.) |
| InputBoxAsync |
Asynchronous displays a prompt in a dialog box, waits for the user to input text or click a button, and then returns a string containing the contents of the text box.
(Defined by Interaction.) |
| MsgBox |
Displays a message in a dialog box, waits for the user to click a button, and then returns an
integer indicating which button the user clicked.
(Defined by Interaction.) |
| MsgBoxAsync |
Asynchronously displays a message in a dialog box, waits for the user to click a button, and then returns an
integer indicating which button the user clicked.
(Defined by Interaction.) |
RemarksYou can:
- Override PromptFileNotFound(String). It's called when the specified file doesn't exist and the property CheckFileExists is true.
- Override CreateUI to create your custom Form when the method ShowDialog is called.
- Set the DialogTemplate to a Form class that has a constructor that accepts FileDialog as the single argument to change the User Interface (UI) of the file dialog.
- Override OnFileOk(CancelEventArgs) to provide your custom implementation of the actions to execute when the user presses the OK button.
You must add at least one IFileSystemProvider to the Roots collection before showing the dialog.
See Also