All pages
Powered by GitBook
1 of 11

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

ColorDialog

Wisej.Web.ColorDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

  • CommonDialog

    • ColorDialog

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

Constructors

ColorDialog()

Initializes a new instance of .

ColorDialog(container)

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

Name
Type
Description

Properties

Color

: Returns or sets the color selected by the user.

CustomColors

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

Methods

Reset()

Resets all properties to their default values.

container

IContainer

An IContainer that represents the container of the ColorDialog component.

Public Class ColorDialog
    Inherits CommonDialog
ColorDialog
ColorDialog
Color
Color[]
public class ColorDialog : CommonDialog

Common Dialogs

FileDialogLoadPathEventHandler

Wisej.Web.FileDialogLoadPathEventHandler

Namespace: Wisej.Web

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

Name
Type
Description

Fired By

Name
Description

sender

Object

The source of the event.

e

FileDialogLoadPathEventArgs

A FileDialogLoadPathEventArgs that contains the event data.

FileDialog.LoadPath

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

FolderBrowserDialog.LoadPath

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

FileDialogLoadPathEventArgs

Wisej.Web.FileDialogLoadPathEventArgs

Namespace: Wisej.Web

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

Name
Type
Description

Properties

CreationTime

: Sets the creation DateTime of the file.

FileSize

: Sets the file size in bytes.

ImageSource

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

IsDirectory

: Returns true when the refers to a directory.

LastWriteTime

: Sets the last modified DateTime of the file.

Path

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

Used By

Name
Description

FileDialog

Wisej.Web.FileDialog

Namespace: Wisej.Web

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

Name
Type
Description

roots

Initial file systems to load in the .

FileDialog(container)

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

Name
Type
Description

container

An that represents the container of the component.

Properties

AddExtension

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

CheckFileExists

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

DefaultExtension

String: Returns or sets the default file name extension.

FileName

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

FileNames

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

FileSystem

IFileSystemProvider: Returns the IFileSystemProvider that contains the selected FileName.

Filter

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.

FilterIndex

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

InitialDirectory

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

Roots

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.

ShowHelp

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

Title

String: Returns or sets the file dialog box title.

Methods

GetRoot(path)

Returns the IFileSystemProvider that contains the specified path .

Parameter
Type
Description

path

Full path of the file to locate in on of the .

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

MapPath(filePath)

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

Parameter
Type
Description

filePath

Virtual path to map to the corresponding physical path.

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

ProcessFileNames(fileNames)

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

Parameter
Type
Description

fileNames

Array containing the selected file paths.

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

Reset()

Resets all properties to their default values.

Events

FileOk

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

LoadPath

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

Inherited By

Name
Description

Prompts the user to open a file from the server.

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

CommonDialog
FileDialog

path

String

Path of the file or directory.

isDirectory

Boolean

Indicates that the path is for a directory.

FileDialogLoadPathEventHandler

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

FileDialogLoadPathEventArgs
DateTime
Int64
String
Boolean
Path
DateTime
String
OnFileOk
IFileSystemProvider[]
FolderBrowserDialog
IContainer
IContainer
FileDialog
String
Roots
String
String[]
OpenFileDialog
SaveFileDialog

SaveFileDialog

Wisej.Web.SaveFileDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

  • CommonDialog

    • FileDialog

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

You can:

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

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

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

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

Constructors

SaveFileDialog()

Initializes a new instance of .

SaveFileDialog(container)

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

Name
Type
Description

Properties

CreatePrompt

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

OverwritePrompt

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

Methods

OpenFile()

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

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

Throws:

  • is empty or null.

ProcessFileNames(fileNames)

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

Parameter
Type
Description

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

Reset()

Resets all dialog box options to their default values.

FolderBrowserDialogUI

Wisej.Web.FolderBrowserDialogUI

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

  • Control

    • ScrollableControl

UI implementation for the FolderDialog class.

Constructors

FolderBrowserDialogUI()

FolderBrowserDialogUI(folderDialog)

Name
Type
Description

Implements

Name
Description

FolderBrowserDialog

Wisej.Web.FolderBrowserDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Allows the user to select a folder from one of the

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.

  • container

    IContainer

    An IContainer that represents the container of the SaveFileDialog component.

    fileNames

    String[]

    Array containing the selected file paths.

    SaveFileDialog
    Public Class SaveFileDialog
        Inherits FileDialog
    PromptFileNotFound
    CheckFileExists
    PromptFileCreate
    CreatePrompt
    PromptFileOverwrite
    OverwritePrompt
    IFileSystemProvider
    Roots
    SaveFileDialog
    SaveFileDialog
    Boolean
    Boolean
    Stream
    Stream
    ArgumentNullException
    FileName
    FileDialog
    Boolean
    public class SaveFileDialog : FileDialog

    Allows an object to serialize itself.

    folderDialog

    FolderBrowserDialog

    IBindableComponent

    Bindable components implement this interface.

    IContainerControl

    Provides the functionality for a control to act as a parent for other controls.

    IWisejComponent

    All wisej components implement this interface.

    IWisejControl

    All wisej controls derived from the Control class must implement this interface.

    IWisejWindow

    All wisej top-level windows implement this interface.

    ContainerControl
    Form
    FolderBrowserDialogUI
    Public Class FolderBrowserDialogUI
        Inherits Form
    public class FolderBrowserDialogUI : Form

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

    Name
    Type
    Description

    roots

    Initial file systems to load in the .

    FolderBrowserDialog(container)

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

    Name
    Type
    Description

    container

    An that represents the container of the component.

    Properties

    Description

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

    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.

    SelectedPath

    String: Returns sets the path selected by the user.

    ShowHelp

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

    Title

    String: Returns or sets the file dialog box title.

    Methods

    GetRoot(path)

    Returns the IFileSystemProvider that contains the specified path .

    Parameter
    Type
    Description

    path

    Full path of the file to locate in on of the .

    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

    Virtual path to map to the corresponding physical path.

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

    Reset()

    Resets all properties to their default values.

    Events

    LoadPath

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

    CommonDialog
    FolderBrowserDialog
    Roots

    OpenFileDialog

    Wisej.Web.OpenFileDialog

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (2.2.0.0)

    • CommonDialog

      • FileDialog

    Prompts the user to open a file from the server.

    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.

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

    Constructors

    OpenFileDialog()

    Initializes a new instance of .

    OpenFileDialog(container)

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

    Name
    Type
    Description

    Properties

    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.

    Multiselect

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

    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.

    Methods

    OpenFile()

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

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

    Throws:

    • is empty or null.

    Reset()

    Resets all properties to their default values.

    FileDialogUI

    Wisej.Web.FileDialogUI

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (2.2.0.0)

    • Control

      • ScrollableControl

    UI implementation for the FileDialog class.

    Constructors

    FileDialogUI()

    FileDialogUI(fileDialog)

    Name
    Type
    Description

    Implements

    Name
    Description

    FileDialogRootCollection

    Wisej.Web.FileDialogRootCollection

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (2.2.0.0)

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

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

    container

    IContainer

    An IContainer that represents the container of the OpenFileDialog component.

    OpenFileDialog
    Public Class OpenFileDialog
        Inherits FileDialog
    PromptFileNotFound
    CheckFileExists
    CreateUI
    Form
    ShowDialog
    DialogTemplate
    Form
    FileDialog
    IFileSystemProvider
    Roots
    OpenFileDialog
    OpenFileDialog
    Boolean
    Boolean
    String
    String[]
    FileName
    Stream
    Stream
    ArgumentNullException
    FileName
    public class OpenFileDialog : FileDialog

    Allows an object to serialize itself.

    fileDialog

    FileDialog

    IBindableComponent

    Bindable components implement this interface.

    IContainerControl

    Provides the functionality for a control to act as a parent for other controls.

    IWisejComponent

    All wisej components implement this interface.

    IWisejControl

    All wisej controls derived from the Control class must implement this interface.

    IWisejWindow

    All wisej top-level windows implement this interface.

    ContainerControl
    Form
    FileDialogUI
    Public Class FileDialogUI
        Inherits Form
    public class FileDialogUI : Form

    Methods

    MapPath(filePath)

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

    Parameter
    Type
    Description

    filePath

    Virtual path to map to the corresponding physical path.

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

    IFileSystemProvider
    FileDialog
    Public Class FileDialogRootCollection
        Inherits List(Of )
    public class FileDialogRootCollection : List<>
    IWisejSerializable
    IFileSystemProvider[]
    FolderBrowserDialog
    IContainer
    IContainer
    FolderBrowserDialog
    String
    Roots
    String
    IWisejSerializable
    String