Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the LoadPath event.

public class FileDialogLoadPathEventArgs : CancelEventArgs

Public Class FileDialogLoadPathEventArgs
    Inherits CancelEventArgs

Allows an application to filter the files and folders loaded by the FileDialog and FolderBrowserDialog components and to set the icon, creation date and modified date. To skip a file or folder, set e.Cancel = true. To set a file's icon, or date, set the ImageSource, CreationTime or LastWriteTime properties.

Constructors

FileDialogLoadPathEventArgs(path, isDirectory)

Constructs a new instance of FileDialogLoadPathEventArgs.

Properties

CreationTime

DateTime: Sets the creation DateTime of the file.

FileSize

Int64: Sets the file size in bytes.

String: Sets the name or path of the icon to display next to the file.

Boolean: Returns true when the Path refers to a directory.

DateTime: Sets the last modified DateTime of the file.

String: Returns the full path of the file or folder being loaded.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represent a collection of the IFileSystemProvider root file systems shown by the FileDialog implementation.

public class FileDialogRootCollection : List<>

Public Class FileDialogRootCollection
    Inherits List(Of )

Methods

MapPath(filePath)

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

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

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the LoadPath and LoadPath events.

public delegate void FileDialogLoadPathEventHandler(Object sender, FileDialogLoadPathEventArgs e)

Public Delegate Sub FileDialogLoadPathEventHandler(ByVal sender As [Object], ByVal e As FileDialogLoadPathEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• CommonDialog

  • ColorDialog

Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors.

public class ColorDialog : CommonDialog

Public Class ColorDialog
    Inherits CommonDialog

Constructors

ColorDialog()

Initializes a new instance of ColorDialog.

ColorDialog(container)

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

Properties

Color

Color: Returns or sets the color selected by the user.

Color[]: Returns or sets the set of custom colors shown in the dialog box.

Methods

Resets all properties to their default values.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Specifies the base class used for displaying dialog boxes on the screen.

public class CommonDialog : Component

Public Class CommonDialog
    Inherits Component

Constructors

CommonDialog()

Initializes a new instance of CommonDialog.

CommonDialog(container)

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

Properties

DialogTemplate

Type: Returns or sets the type of the common dialog UI control to show when calling the ShowDialog method.

Tag

Object: Returns or sets an object that contains data about the control.

String: Returns or sets the dialog box title.

FormWindowState: Returns or sets the initial WindowState of the common dialog.

Methods

When overridden in a derived class, resets the properties of a common dialog box to their default values.

Runs a common dialog box with a default owner.

Returns: DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.

Runs a common dialog box with a default owner.

Returns: DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.

Runs a common dialog box with the specified owner.

Returns: DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.

Runs a common dialog box with the specified owner.

Returns: DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.

Runs a common dialog box with the specified owner asynchronously.

Returns: Task<DialogResult>. OK if the user clicks OK in the dialog box; otherwise, Cancel.

Events

EventHandler Fired when the user clicks the Help button on a common dialog box.

Inherited By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• CommonDialog

  • FileDialog

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

public class FileDialog : CommonDialog

Public Class FileDialog
    Inherits CommonDialog

This class is abstract. The current implementations in Wisej are OpenFileDialog and SaveFileDialog. You can override this class or OpenFileDialog and SaveFileDialog to add your own custom behavior and localization. You can:

• Override PromptFileNotFound. 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 to provide your custom implementation of the actions to execute when the user presses the OK button.

You must add at least one FileSystemProvider to the Roots collection before showing the dialog.

Constructors

FileDialog()

Initializes a new instance of FileDialog.

FileDialog(roots)

Initializes a new instance of FileDialog using the initial roots .

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

Properties

Boolean: Returns or sets whether the dialog box automatically adds an extension to a file name if the user omits the extension.

Boolean: Returns or sets whether the dialog box displays a warning if the user specifies a file name that does not exist.

String: Returns or sets the default file name extension.

String: Returns or sets a string containing the file name selected in the file dialog box.

String[]: Returns the file names of all selected files in the dialog box.

IFileSystemProvider: Returns the IFileSystemProvider that contains the selected FileName.

String: 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.

Int32: Returns or sets the index of the filter currently selected in the file dialog box.

String: Returns or sets the initial directory displayed by the file dialog box.

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

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.

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

String: Returns or sets the file dialog box title.

Methods

Returns the IFileSystemProvider that contains the specified path .

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

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

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

Receives the file names selected by the user and validates them according to the properties set in the FileDialog instance.

Returns: Boolean. True if the files have been validated and the dialog can close; otherwise false to keep the dialog open.

Resets all properties to their default values.

Events

CancelEventHandler Fired when the user clicks on the Open or Save button on a file dialog box.

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

Inherited By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• Control

  • ScrollableControl

    • ContainerControl

      • Form

        • FileDialogUI

UI implementation for the FileDialog class.

public class FileDialogUI : Form

Public Class FileDialogUI
    Inherits Form

Constructors

FileDialogUI()

FileDialogUI(fileDialog)

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• CommonDialog

  • FileDialog

    • SaveFileDialog

Prompts the user to select a location for saving a file on the server.

public class SaveFileDialog : FileDialog

Public Class SaveFileDialog
    Inherits FileDialog

You can:

• Override PromptFileNotFound. It's called when the specified file doesn't exist and the property CheckFileExists is true.

• Override PromptFileCreate. It's called when the specified file doesn't exist and the property CreatePrompt is true.

• Override PromptFileOverwrite. It's called when the specified file doesn't exist and the property OverwritePrompt 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 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.

Constructors

Initializes a new instance of SaveFileDialog.

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

Properties

Boolean: Returns or sets a value indicating whether the dialog box prompts the user for permission to create a file, if the file specified file does not exist.

Boolean: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that already exists.

Methods

Opens the file with read/write permission selected by the user.

Returns: Stream. A Stream that specifies the read/write file selected by the user.

Throws:

• ArgumentNullException FileName is empty or null.

Receives the file names selected by the user and validates them according to the properties set in the FileDialog instance.

Returns: Boolean. True if the files have been validated and the dialog can close; otherwise false to keep the dialog open.

Resets all dialog box options to their default values.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• Control

  • ScrollableControl

    • ContainerControl

      • Form

        • FolderBrowserDialogUI

UI implementation for the FolderDialog class.

public class FolderBrowserDialogUI : Form

Public Class FolderBrowserDialogUI
    Inherits Form

Constructors

FolderBrowserDialogUI()

FolderBrowserDialogUI(folderDialog)

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• CommonDialog

  • FolderBrowserDialog

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

public class FolderBrowserDialog : CommonDialog

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 .

FolderBrowserDialog(container)

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

Properties

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

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.

String: Returns sets the path selected by the user.

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

String: Returns or sets the file dialog box title.

Methods

Returns the IFileSystemProvider that contains the specified path .

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

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

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

Resets all properties to their default values.

Events

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

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• CommonDialog

  • FileDialog

    • OpenFileDialog

Prompts the user to open a file from the server.

public class OpenFileDialog : FileDialog

Public Class OpenFileDialog
    Inherits FileDialog

You can:

• Override PromptFileNotFound. 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 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.

Constructors

OpenFileDialog()

Initializes a new instance of OpenFileDialog.

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

Properties

Boolean: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.

Boolean: Returns or sets a value indicating whether the dialog box allows multiple files to be selected.

String: Returns the file name and extension for the file selected in the dialog box. The file name does not include the path.

String[]: 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.

Methods

Opens the file selected by the user, with read-only permission. The file is specified by the FileName property.

Returns: Stream. A Stream that specifies the read-only file selected by the user.

Throws:

• ArgumentNullException FileName is empty or null.

Resets all properties to their default values.