Namespace: Wisej.Web

Assembly: Wisej.Framework (4.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. (Default: Color [Empty])

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

Methods

Returns: Form.

Resets all properties to their default values.

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.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. (Default: null)

Tag

Object: Returns or sets an object that contains data about the control. (Default: null)

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

FormWindowState: Returns or sets the initial WindowState of the common dialog. (Default: Normal)

Methods

Creates the UI for the CommonDialog.

Returns: Form. An instance of Form.

Fires the HelpRequested event.

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 (4.0.0.0)

Represents the method that will handle the LoadPath event.

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 (4.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 and 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 , or properties.

Constructors

FileDialogLoadPathEventArgs(path, isDirectory)

Constructs a new instance of .

Properties

CreationTime

: Sets the creation DateTime of the file.

FileSize

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represent a collection of the root file systems shown by the 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 implementation.

Returns: . The physical path for the implementation.

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

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 and . You can override this class or and to add your own custom behavior and localization. You can:

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

• Override to create your custom when the method is called.

• Set the to a class that has a constructor that accepts as the single argument to change the User Interface (UI) of the file dialog.

• Override to provide your custom implementation of the actions to execute when the user presses the OK button.

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

Constructors

FileDialog()

Initializes a new instance of .

FileDialog(roots)

Properties

Methods

Informs the user that the file specified in fileName doesn't exist. You can override this method to provide your text and localization.

Resets all properties to their default values.

Events

Inherited By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

UI implementation for the FileDialog class.

public class FileDialogUI : Form

Public Class FileDialogUI
    Inherits Form

Constructors

FileDialogUI()

Initializes a new instance of .

FileDialogUI(fileDialog)

Initializes a new instance of .

Methods

Clean up any resources being used.

Returns the directories in the specified path within the root file system.

Returns the list of files in the path that match the pattern within the specified root file system.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.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. (Default: False)

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

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.

Asks the user's permission to create the specified fileName .

Returns: Boolean. True if the user confirms to create the file.

Asks the user's permission to overwrite the specified fileName .

Returns: Boolean. True if the user confirms to overwrite the file.

Resets all dialog box options to their default values.

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.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()

Initializes a new instance of FolderBrowserDialogUI.

FolderBrowserDialogUI(folderDialog)

Initializes a new instance of FolderBrowserDialogUI.

Methods

Clean up any resources being used.

Returns the directories in the specified path within the root file system.

Returns: String[]. A string array with the path of the directories.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.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. (Default: "")

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

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

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

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

Methods

Returns: Form.

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.

Fires the LoadPath event.

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 (4.0.0.0)

Prompts the user to open a file from the server.

public class OpenFileDialog : FileDialog

Public Class OpenFileDialog
    Inherits FileDialog

You can:

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

• Override to create your custom when the method is called.

• Set the to a class that has a constructor that accepts as the single argument to change the User Interface (UI) of the file dialog.

• Override to provide your custom implementation of the actions to execute when the user presses the OK button.

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

Constructors

OpenFileDialog()

Initializes a new instance of .

Properties

Default value is an empty array of strings- string[0]

Methods

Throws:

Resets all properties to their default values.