Only this pageAll pages
Powered by GitBook
Couldn't generate the PDF for 725 pages, generation stopped at 100.
Extend with 50 more pages.
1 of 100

v3.0

Loading...

Wisej.Web

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

General

Welcome

This book covers the full API for the Wisej.Framework assembly only. For an in-depth guide of Wisej features, please refer to the Concepts book. For the extensions API and concepts, please refer to the Extensions book.

Legend

Icon
Description

Instance method, or property, or event.

The concept documentation and the namespace reference are a never-ending work in progress. We update it almost daily. Please check back if what you are looking for is not available.

We assume that you have a good working knowledge of the following tools and technologies:

  • C# or VB.NET

  • .NET in general

  • Visual Studio

Buttons

Containers

JavaScript

Static method or property or event.

Protected method or property or event.

Deprecated method or property or event.

Concepts & Reference

Skills

Client

Wisej.Core.Client

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents a unique client using the application.

public class Client
Public Class Client

A browser instance is a single client, regardless of how many sessions are created by that client and how many browser tabs are open. Different browsers a represented as different clients.

Properties

Browsers

ClientBrowser[]: List of browser tabs (for the same browser) that are using the application at the client computer.

ID

: Unique client ID.

: IP Address of the client computer.

: Returns the number of sessions used by this client computer.

Application.PageCollection

Wisej.Web.Application PageCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Holds the collection of all top-level application pages.

public class PageCollection : ICollection,
Public Class PageCollection
    Inherits ICollection
    Implements IEnumerable

Properties

Count

Int32: Returns the total number of currently open pages.

Item(index)

Page: Returns the page at the specified index.

Item(name)

: Returns the first page with the specified name, the search is case insensitive.

Returns an enumerator that iterates through the open pages.

Returns: .

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Name
Type

LicenseErrorEventHandler

Wisej.Web.LicenseErrorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Name
Type

LayoutEventHandler

Wisej.Web.LayoutEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

Name
Type

RotateEventHandler

Wisej.Web.RotateEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Name
Type

PinchEventArgs

Wisej.Web.PinchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for event.

: Returns the calculated scale factor.

PlatformProvider

Wisej.Core.PlatformProvider

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Platforms supported by Wisej.

Name
Description

LoadConfigurationEventHandler

Wisej.Core.LoadConfigurationEventHandler

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents a method that handles the event.

Name
Type

ClientPlatform

Wisej.Core.ClientPlatform

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents the client platform used to render the widgets.

: List of javascript files associated with the platform.

: The name of this platform configuration.

ClientCollection

Wisej.Core.ClientCollection

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

List of s using the application.

: Returns the total number of items in the collection.

: Returns the at the specified

JavaScript.ClientEvent

Wisej.Web.JavaScript ClientEvent

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represent a JavaScript event and the corresponding code to execute on the client when the event is fired.

: Returns or sets the name of the event. Not all events are available to all controls, which events are fired depends on the widget that corresponds to the control.

: Returns or sets the JavaScript handler for the event.

Application.FormCollection

Wisej.Web.Application FormCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Holds the collection of all top-level application forms.

: Returns the total number of currently open forms.

: Returns the form at the specified index.

LoadConfigurationEventArgs

Wisej.Core.LoadConfigurationEventArgs

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Specifies the event arguments for the event.

: The full file path to the configuration file to load.

: When set to true, suppresses the caching of the custom object return by the custom handler for the

SwipeDirection

Wisej.Web.SwipeDirection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Indicates the direction of the swipe gesture.

Name
Description

LicenseErrorEventArgs

Wisej.Web.LicenseErrorEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Initializes a new instance of the class.

Common Dialogs

IEnumerable

Methods

GetEnumerator()

Page
IEnumerator
Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when the hash part of the URL changes on the client side.

Public Delegate Sub HashChangedEventHandler(ByVal sender As [Object], ByVal e As HashChangedEventArgs)

Parameters

HashChanged
public delegate void HashChangedEventHandler(Object sender, HashChangedEventArgs e)

Fired By

Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when a license error occurs.

Public Delegate Sub LicenseErrorEventHandler(ByVal sender As [Object], ByVal e As HashChangedEventArgs)

Parameters

LicenseError
public delegate void LicenseErrorEventHandler(Object sender, HashChangedEventArgs e)

Fired By

Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when a control should reposition its child controls.

Public Delegate Sub LayoutEventHandler(ByVal sender As [Object], ByVal e As LayoutEventArgs)

Parameters

Layout
Control
public delegate void LayoutEventHandler(Object sender, LayoutEventArgs e)

Fired By

Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when two finger moved around a single point. It contains the angle of the rotation.

Public Delegate Sub RotateEventHandler(ByVal sender As [Object], ByVal e As RotateEventArgs)

Parameters

Rotate
public delegate void RotateEventHandler(Object sender, RotateEventArgs e)

Fired By

Name
Description

Represents the method that will handle the event.

Public Class PinchEventArgs
    Inherits EventArgs

Properties

Scale

Used By

Pinch
Double
public class PinchEventArgs : EventArgs

QXDesktop

Desktop platform by qooxdoo.

Name
Description

The platform provider.

Public Enum PlatformProvider As [Enum]

Fields

public enum PlatformProvider : Enum

Used By

Description

sender

The source of the event. Always null.

args

The event data.

Name
Description

Fired when the system needs to load a Wisej configuration file.

Public Delegate Sub LoadConfigurationEventHandler(ByVal sender As [Object], ByVal args As LoadConfigurationEventArgs)

Parameters

LoadConfiguration
public delegate void LoadConfigurationEventHandler(Object sender, LoadConfigurationEventArgs args)

Fired By

PlatformProvider: The platform provider.

String[]: List of style sheets associated with the platform.

Version: Returns the file version of the

Public Class ClientPlatform

Properties

JavaScripts

Name

Provider

String[]
String
public class ClientPlatform

StyleSheets

Version

index
.
Public Class ClientCollection
    Inherits IList(Of Client)
    Implements ICollection(Of Client), IEnumerable(Of Client), IEnumerable

Constructors

ClientCollection()

Properties

Count

Item(index)

Client
Int32
Client
Client
Client
public class ClientCollection : IList<Client>, ICollection<Client>, IEnumerable<Client>, IEnumerable
Form: Returns the first form with the specified name, the search is case insensitive.

Returns an enumerator that iterates through the open forms.

Returns: IEnumerator.

Public Class FormCollection
    Inherits ICollection
    Implements IEnumerable

Properties

Count

Item(index)

Item(name)

Int32
Form
public class FormCollection : ICollection, IEnumerable

Methods

GetEnumerator()

event.
Name
Description

Represents a method that handles the event.

Public Class LoadConfigurationEventArgs
    Inherits EventArgs

Properties

FilePath

SuppressCache

LoadConfiguration
String
Boolean
Configuration
public class LoadConfigurationEventArgs : EventArgs

Used By

LoadConfiguration

Down

Direction down.

Left

Direction left.

Right

Direction right.

Up

Direction up.

Name
Description

Returns the direction of the performed swipe in reference to the axis: X = Up / Down Y = Left / Right

Public Enum SwipeDirection As [Enum]

Fields

public enum SwipeDirection : Enum

Used By

Name
Type
Description

error

License error.

String: Indicates the type of license error that has occurred.

Public Class LicenseErrorEventArgs
    Inherits EventArgs

Constructors

LicenseErrorEventArgs(error)

LicenseError
LicenseErrorEventArgs
public class LicenseErrorEventArgs : EventArgs

Properties

Error

IPAddress

SessionCount

String
String
Int32
Public Class ClientEvent

Constructors

ClientEvent()

Properties

Event

JavaScript

String
String
public class ClientEvent

HelpEventArgs

Wisej.Web.HelpEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the HelpRequested event.

public class HelpEventArgs : EventArgs
Public Class HelpEventArgs
    Inherits EventArgs

Constructors

HelpEventArgs(target)

Initializes a new instance of the HelpEventArgs class.

Name
Type
Description

: Returns or sets a value indicating whether the help event was handled.

: Returns the that had the focus when the user pressed F1.

Name
Description

PinchEventHandler

Wisej.Web.PinchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Pinch event.

public delegate void PinchEventHandler(Object 
Public Delegate Sub PinchEventHandler(ByVal sender As [Object], ByVal e As PinchEventArgs)

Parameters

Name
Type
Description
Name
Description

PaintEventHandler

Wisej.Web.PaintEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Paint event of a Control.

public delegate void PaintEventHandler(Object 
Public Delegate Sub PaintEventHandler(ByVal sender As [Object], ByVal e As PaintEventArgs)

Parameters

Name
Type
Description
Name
Description

ControlEventHandler

Wisej.Web.ControlEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the ControlAdded and ControlRemoved events of the Control class.

public delegate void ControlEventHandler(Object 
Public Delegate Sub ControlEventHandler(ByVal sender As [Object], ByVal e As ControlEventArgs)

Parameters

Name
Type
Description
Name
Description

ControlEventArgs

Wisej.Web.ControlEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the ControlAdded and ControlRemoved events.

public class ControlEventArgs : EventArgs
Public Class ControlEventArgs
    Inherits EventArgs

Constructors

ControlEventArgs(control)

Initializes a new instance of the ControlEventArgs class for the specified control.

Name
Type
Description

: Returns the control object used by this event.

Name
Description

TrackEventHandler

Wisej.Web.TrackEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Track event.

public delegate void TrackEventHandler(Object 
Public Delegate Sub TrackEventHandler(ByVal sender As [Object], ByVal e As TrackEventArgs)

Parameters

Name
Type
Description
Name
Description

QueryContinueDragEventHandler

Wisej.Web.QueryContinueDragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the QueryContinueDrag event of a Control.

public delegate void QueryContinueDragEventHandler(Object 
Public Delegate Sub QueryContinueDragEventHandler(ByVal sender As [Object], ByVal e As QueryContinueDragEventArgs)

Parameters

Name
Type
Description
Name
Description

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the ResponsiveProfileChanged event.

public class ResponsiveProfileChangedEventArgs : EventArgs
Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs

Constructors

ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the ResponsiveProfileChangedEventArgs class.

Name
Type
Description

: The new active profile.

: The previously active profile.

Name
Description

TouchEventHandler

Wisej.Web.TouchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the TouchStart, TouchEnd, TouchMove, TouchCancel events.

public delegate void TouchEventHandler(Object 
Public Delegate Sub TouchEventHandler(ByVal sender As [Object], ByVal e As TouchEventArgs)

Parameters

Name
Type
Description
Name
Description

TouchEventArgs

Wisej.Web.TouchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for Swipe event.

public class TouchEventArgs : EventArgs
Public Class TouchEventArgs
    Inherits EventArgs

Properties

Identifiers

Int64[]: Returns the unique identifiers for the touch items.

IsMultiTouch

Boolean: Returns whether more than one touch is associated with the event target element.

Locations

: Returns the location of the touch items in screen coordinates.

: Returns the delta of the rotation since the start of the event, in degrees.

: Returns the distance between two fingers since the start of the event.

Name
Description

TrackEventArgs

Wisej.Web.TrackEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for Track event.

public class TrackEventArgs : EventArgs
Public Class TrackEventArgs
    Inherits EventArgs

Properties

Axis

SwipeAxis: Returns the Axis of the track event.

Location

Point: Returns the X, Y delta for the track event.

X

: Returns the X delta of the track event.

: Returns Y delta of the track event.

Name
Description

KeyPressEventArgs

Wisej.Web.KeyPressEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the KeyPress event.

public class KeyPressEventArgs : EventArgs
Public Class KeyPressEventArgs
    Inherits EventArgs

Constructors

KeyPressEventArgs(keyChar)

Initializes a new instance of the KeyPressEventArgs class.

Name
Type
Description

: Returns or sets whether the event was handled.

: Returns or sets the character corresponding to the key pressed.

Name
Description

Screen

Wisej.Web.Screen

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the display on the client device.

public class Screen
Public Class Screen

Properties

Bounds

Rectangle: Returns the size of the display of the client device, regardless of the orientation.

DeviceName

String: Returns the device name associated with a display.

WorkingArea

: Returns the working area of the browser. The working area is the desktop area of the browser, excluding taskbars, docked windows, and docked tool bars.

SwipeAxis

Wisej.Web.SwipeAxis

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Indicates the axis of the swipe gesture.

public enum SwipeAxis : Enum
Public Enum SwipeAxis As [Enum]

Fields

Name
Description
Name
Description

ServiceScope

Wisej.Web.ServiceScope

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

EXPERIMENTAL: Specifies the scope of services added using AddService.

public enum ServiceScope : Enum
Public Enum ServiceScope As [Enum]

Fields

Name
Description
Name
Description

RotateEventArgs

Wisej.Web.RotateEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for Rotate event.

public class RotateEventArgs : EventArgs
Public Class RotateEventArgs
    Inherits EventArgs

Properties

Angle

Double: Returns a number with the current calculated angle between the primary and secondary active pointers.

Used By

Name
Description

FileDialogRootCollection

Wisej.Web.FileDialogRootCollection

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.

Parameter
Type
Description

Returns: . The physical path for the implementation.

ClientProfile

Wisej.Core.ClientProfile

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Definition of the client device.

Name
Type

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Application.ResponsiveProfileChanged event.

Name
Type

SwipeEventHandler

Wisej.Web.SwipeEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Name
Type

WidgetEventHandler

Wisej.Web.WidgetEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that handles the event.

Name
Type

MenuButtonItemClickedEventHandler

Wisej.Web.MenuButtonItemClickedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a control.

Name

DragEventHandler

Wisej.Web.DragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the , , or event of a .

Name

AccordionAction

Wisej.Web.AccordionAction

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Defines values representing events.

Name
Description

PreviewKeyDownEventHandler

Wisej.Web.PreviewKeyDownEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Name
Type

QueryContinueDragEventArgs

Wisej.Web.QueryContinueDragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Initializes a new instance of the class.

KeyEventHandler

Wisej.Web.KeyEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the or event of a .

Name

SwipeEventArgs

Wisej.Web.SwipeEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for event.

: Returns whether the performed swipe was on the x or y axis.

: Returns the direction of the performed swipe in reference to the axis: X = Up / Down Y = Left / Right

MenuButtonItemClickedEventArgs

Wisej.Web.MenuButtonItemClickedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Initializes a new instance of the class.

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Initializes a new instance of the class.

HelpEventHandler

Wisej.Web.HelpEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

Name
Type

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Initializes a new instance of the class.

ColorDialog

Wisej.Web.ColorDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

FileDialogLoadPathEventHandler

Wisej.Web.FileDialogLoadPathEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the and events.

Name
Type

AccordionCancelEventHandler

Wisej.Web.AccordionCancelEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the or event of a control.

Name
sender
,
PinchEventArgs
e
)

sender

Object

The source of the event.

e

PinchEventArgs

A PinchEventArgs that contains the event data.

Control.Pinch

Fired when two finger moved towards or away from each other. It contains the scaling factor of the pinch.

Fired By

sender
,
PaintEventArgs
e
)

sender

Object

The source of the event.

e

PaintEventArgs

A PaintEventArgs that contains the event data.

Control.Paint

Fired when a UserPaint control needs to redraw itself.

Fired By

sender
,
TrackEventArgs
e
)

sender

Object

The source of the event.

e

TrackEventArgs

A TrackEventArgs that contains the event data.

Control.Track

Fired when a pointer grabs an item and moves the pointer on it.

Fired By

sender
,
QueryContinueDragEventArgs
e
)

sender

Object

The source of an event.

e

QueryContinueDragEventArgs

A QueryContinueDragEventArgs that contains the event data.

Control.QueryContinueDrag

Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.

Fired By

X

X-axis.

Y

Y-axis

SwipeEventArgs.Axis

Returns whether the performed swipe was on the x or y axis.

TrackEventArgs.Axis

Returns the Axis of the track event.

Used By

Global

A single static instance of the service is available to all sessions.

Session

The registered instance is available only to the current sessions. A new session should create and register a new instance.

Transient

A new instance of the service is created every time it's needed and automatically disposed at the end of the request.

Application.AddService

EXPERIMENTAL: Adds a scoped service to the service container.

Used By

Object
HashChangedEventArgs
HashChangedEventArgs
Application.HashChanged
Object
HashChangedEventArgs
LicenseErrorEventArgs
Application.LicenseError
Object
LayoutEventArgs
LayoutEventArgs
Control.Layout
Object
RotateEventArgs
RotateEventArgs
Control.Rotate
ClientPlatform.Provider
Object
LoadConfigurationEventArgs
Configuration.LoadConfiguration
SwipeEventArgs.Direction
Rectangle

RotateEventHandler

Represents the method that will handle the Rotate event.

filePath

String

Virtual path to map to the corresponding physical path.

String
IFileSystemProvider
PinchEventHandler
Pinch
LoadConfigurationEventHandler
LoadConfiguration
String

Fired when a multiple-document interface (MDI) child form is removed from the mdi parent.

sender
,
ControlEventArgs
e
)

sender

Object

The source of the event.

e

ControlEventArgs

A ControlEventArgs that contains the event data.

Control.ControlAdded

Fired when a new control is added to the ControlCollection.

Control.ControlRemoved

Fired when a control is removed from the ControlCollection.

Form.MdiChildAdded

Fired By

Fired when a multiple-document interface (MDI) child form is added to the mdi parent.

Fired when a touch point is moved along the touch surface.

sender
,
TouchEventArgs
e
)

sender

Object

The source of the event.

e

TouchEventArgs

A TouchEventArgs that contains the event data.

Control.TouchStart

Fired when a touch point is placed on the touch surface.

Control.TouchEnd

Fired when a touch point is removed from the touch surface.

Control.TouchCancel

Fired By

Fired when a touch point has been disrupted in an implementation-specific manner (for example, too many touch points are created).

Description

Default

Returns the default singleton.

String: Device type.

Nullable<Boolean>: Device landscape mode.

Int32: Maximum screen width.

Int32: Maximum browser width.

Int32: Minimum screen width.

Int32: Minimum browser width.

String: Name of the profile.

String: User agent string.

Public Class ClientProfile

Fields

public class ClientProfile

Properties

Device

Landscape

MaxScreenWidth

MaxWidth

MinScreenWidth

MinWidth

Name

UserAgent

Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when the active responsive profile is changed.

Fired when the active responsive profile is changed.

Public Delegate Sub ResponsiveProfileChangedEventHandler(ByVal sender As [Object], ByVal e As ResponsiveProfileChangedEventArgs)

Parameters

public delegate void ResponsiveProfileChangedEventHandler(Object sender, ResponsiveProfileChangedEventArgs e)

Fired By

Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when a pointer swipes over the screen.

Public Delegate Sub SwipeEventHandler(ByVal sender As [Object], ByVal e As SwipeEventArgs)

Parameters

Swipe
public delegate void SwipeEventHandler(Object sender, SwipeEventArgs e)

Fired By

Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when the control receives a custom event from the client.

Public Delegate Sub WidgetEventHandler(ByVal sender As [Object], ByVal e As WidgetEventArgs)

Parameters

WidgetEvent
public delegate void WidgetEventHandler(Object sender, WidgetEventArgs e)

Fired By

Type
Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when the user clicks one of the drop down menu items.

Public Delegate Sub MenuButtonItemClickedEventHandler(ByVal sender As [Object], ByVal e As MenuButtonItemClickedEventArgs)

Parameters

ItemClicked
Button
public delegate void MenuButtonItemClickedEventHandler(Object sender, MenuButtonItemClickedEventArgs e)

Fired By

Type
Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when a drag-and-drop operation is completed.

Fired when an object is dragged into the control's bounds.

Public Delegate Sub DragEventHandler(ByVal sender As [Object], ByVal e As DragEventArgs)

Parameters

DragDrop
DragEnter
DragOver
Control
public delegate void DragEventHandler(Object sender, DragEventArgs e)

Fired By

Deselected

Represents the event.

Deselecting

Represents the event.

Selected

Represents the event.

Selecting

Represents the event.

Name
Description

Returns a value indicating which event is occurring.

Returns a value indicating which event is occurring.

Public Enum AccordionAction As [Enum]

Fields

Accordion
public enum AccordionAction : Enum

Used By

Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired before the event when a key is pressed while focus is on this control.

Public Delegate Sub PreviewKeyDownEventHandler(ByVal sender As [Object], ByVal e As PreviewKeyDownEventArgs)

Parameters

PreviewKeyDown
public delegate void PreviewKeyDownEventHandler(Object sender, PreviewKeyDownEventArgs e)

Fired By

Name
Type
Description

args

The arguments received from the client.

DragAction: Returns or sets the status of a drag-and-drop operation.

Boolean: Returns if the user pressed the ESC key.

Int32: Returns the current state of the SHIFT, CTRL, and ALT keys.

Name
Description

Represents the method that will handle the event of a .

Public Class QueryContinueDragEventArgs
    Inherits EventArgs

Constructors

QueryContinueDragEventArgs(args)

QueryContinueDrag
QueryContinueDragEventArgs
public class QueryContinueDragEventArgs : EventArgs

Properties

Action

EscapePressed

KeyState

Used By

Type
Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when a key is pressed while the control has focus.

Fired when a key is released while the control has focus.

Public Delegate Sub KeyEventHandler(ByVal sender As [Object], ByVal e As KeyEventArgs)

Parameters

KeyUp
KeyDown
Control
public delegate void KeyEventHandler(Object sender, KeyEventArgs e)

Fired By

Int32: Returns the distance of the performed swipe.

Int32: Returns the duration the performed swipe took.

Int64: Returns the start time of the performed swipe.

Double: Returns the velocity of the performed swipe.

Name
Description

Represents the method that will handle the event.

Public Class SwipeEventArgs
    Inherits EventArgs

Properties

Axis

Direction

Distance

Swipe
SwipeAxis
SwipeDirection
public class SwipeEventArgs : EventArgs

Duration

StartTime

Velocity

Used By

Name
Type
Description

item

The that was clicked.

MenuItem: Returns the clicked menu item.

Name
Description

Represents the method that will handle the event of a control.

Public Class MenuButtonItemClickedEventArgs
    Inherits EventArgs

Constructors

MenuButtonItemClickedEventArgs(item)

ItemClicked
MenuButtonItemClickedEventArgs
public class MenuButtonItemClickedEventArgs : EventArgs

Properties

Item

Used By

Name
Type
Description

value

Initial hash value.

String: The hash string from the client.

Name
Description

Represents the method that will handle the event.

Represents the method that will handle the event.

Public Class HashChangedEventArgs
    Inherits EventArgs

Constructors

HashChangedEventArgs(value)

HashChanged
HashChangedEventArgs
public class HashChangedEventArgs : EventArgs

Properties

Hash

Used By

Description

sender

The source of the event.

hlpevent

A object that contains the event data.

Name
Description

Fired when the user requests help for a control by pressing F1.

Public Delegate Sub HelpEventHandler(ByVal sender As [Object], ByVal hlpevent As HelpEventArgs)

Parameters

HelpRequested
Control
public delegate void HelpEventHandler(Object sender, HelpEventArgs hlpevent)

Fired By

Name
Type
Description

oldValue

Previous .

newValue

New active .

ClientProfile: The new active profile.

ClientProfile: The previously active profile.

Name
Description

Represents the method that will handle the Application.ResponsiveProfileChanged event.

Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs

Constructors

ResponsiveProfileChangedEventArgs(oldValue, newValue)

ResponsiveProfileChanged
ResponsiveProfileChangedEventArgs
public class ResponsiveProfileChangedEventArgs : EventArgs

Properties

CurrentProfile

PreviousProfile

Used By

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

Initializes a new instance of ColorDialog.

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

Name
Type
Description

container

An that represents the container of the component.

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

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

Resets all properties to their default values.

CommonDialog
ColorDialog

Constructors

ColorDialog()

ColorDialog(container)

Properties

Color

CustomColors

Methods

Reset()

Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

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

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

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

Parameters

LoadPath
LoadPath
public delegate void FileDialogLoadPathEventHandler(Object sender, FileDialogLoadPathEventArgs e)

Fired By

Type
Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Occurs before a panel is selected, enabling a handler to cancel the panel change.

Occurs before a panel is deselected, enabling a handler to cancel the panel change.

Public Delegate Sub AccordionCancelEventHandler(ByVal sender As [Object], ByVal e As AccordionCancelEventArgs)

Parameters

Selecting
Deselecting
Accordion
public delegate void AccordionCancelEventHandler(Object sender, AccordionCancelEventArgs e)

Fired By

target

Control

The Control that had the focus when the user pressed F1.

HelpEventHandler

Represents the method that will handle the HelpRequested event of a Control.

Properties

Handled

Target

Used By

Boolean
Control
Control

control

Control

The Control to store in this event.

ControlEventHandler

Represents the method that will handle the ControlAdded and ControlRemoved events of the Control class.

Properties

Control

Used By

Control

oldValue

ClientProfile

Previous ClientProfile.

newValue

ClientProfile

New active ClientProfile.

ResponsiveProfileChangedEventHandler

Represents the method that will handle the Application.ResponsiveProfileChanged event.

Properties

CurrentProfile

PreviousProfile

Used By

ClientProfile
ClientProfile

TouchEventHandler

Represents the method that will handle the TouchStart, TouchEnd, TouchMove, TouchCancel events.

Rotation

Scale

Used By

Point[]
Double
Double

TrackEventHandler

Represents the method that will handle the Track event.

Y

Used By

Int32
Int32

keyChar

Char

The ASCII character corresponding to the key the user pressed.

KeyPressEventHandler

Represents the method that will handle the KeyPress event of a Control.

Properties

Handled

KeyChar

Used By

Boolean
KeyPress
Char

LayoutEventArgs

Wisej.Web.LayoutEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the Layout event.

public class LayoutEventArgs : EventArgs
Public Class LayoutEventArgs
    Inherits EventArgs

Constructors

LayoutEventArgs(affectedComponent, affectedProperty)

Initializes a new instance of the LayoutEventArgs class with the specified component and property affected.

Name
Type
Description

Initializes a new instance of the class with the specified control and property affected.

Name
Type
Description

: Returns the affected by the layout change.

: Returns the child control affected by the change.

: Returns the property affected by the change.

Name
Description

MouseEventHandler

Wisej.Web.MouseEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the MouseDown, MouseUp, or MouseMove event of a form, control, or other component.

public delegate void MouseEventHandler(Object 
Public Delegate Sub MouseEventHandler(ByVal sender As [Object], ByVal e As MouseEventArgs)

Parameters

Name
Type
Description
Name
Description

SplitButton

Wisej.Web.SplitButton

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

  • Control

    • ButtonBase

Represents a split button control.

: Returns or sets a value indicating the layout of the . When the value is set to the down arrow is places below the text, otherwise it's to the right of the text.

Name
Description

AccordionEventHandler

Wisej.Web.AccordionEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Selected or Deselected event of a Accordion control.

public delegate void AccordionEventHandler(Object 
Public Delegate Sub AccordionEventHandler(ByVal sender As [Object], ByVal e As AccordionEventArgs)

Parameters

Name
Type
Description
Name
Description

KeyEventArgs

Wisej.Web.KeyEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the or event.

Initializes a new instance of the class.

PreviewKeyDownEventArgs

Wisej.Web.PreviewKeyDownEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Initializes a new instance of the class with the specified key.

AccordionCancelEventArgs

Wisej.Web.AccordionCancelEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the and events of a control.

Initializes a new instance of the class.

FileDialogUI

Wisej.Web.FileDialogUI

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

FolderBrowserDialogUI

Wisej.Web.FolderBrowserDialogUI

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

FileDialogLoadPathEventArgs

Wisej.Web.FileDialogLoadPathEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the LoadPath event.

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.

PaintEventArgs

Wisej.Web.PaintEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Initializes a new instance of the class with the specified graphics and clipping rectangle.

AccordionEventArgs

Wisej.Web.AccordionEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the and events of a control.

Initializes a new instance of the class.

KeyPressEventHandler

Wisej.Web.KeyPressEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

Name
Type

WidgetEventArgs

Wisej.Web.WidgetEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Initializes a new instance of the class.

sender
,
AccordionEventArgs
e
)

sender

Object

The source of the event.

e

AccordionEventArgs

A AccordionEventArgs that contains the event data.

Accordion.Selected

Fired when a panel is selected.

Accordion.Deselected

Fired when a panel is deselected.

Fired By

Form.MdiChildRemoved
Control.TouchMove
Object
ResponsiveProfileChangedEventArgs
ResponsiveProfileChangedEventArgs
Control.ResponsiveProfileChanged
Application.ResponsiveProfileChanged
Object
SwipeEventArgs
SwipeEventArgs
Control.Swipe
Object
WidgetEventArgs
WidgetEventArgs
Control.WidgetEvent
Object
MenuButtonItemClickedEventArgs
MenuButtonItemClickedEventArgs
Button.ItemClicked

Fired when an object is dragged over the control's bounds.

Object
DragEventArgs
DragEventArgs
Control.DragDrop
Control.DragEnter
Control.DragOver
Deselected
Deselecting
Selected
Selecting
AccordionCancelEventArgs.Action
AccordionEventArgs.Action
Object
PreviewKeyDownEventArgs
PreviewKeyDownEventArgs
Control.PreviewKeyDown
KeyDown
Object
KeyEventArgs
KeyEventArgs
Control.KeyDown
Control.KeyUp
Object
HelpEventArgs
HelpEventArgs
Control.HelpRequested
Object
FileDialogLoadPathEventArgs
FileDialogLoadPathEventArgs
FileDialog.LoadPath
FolderBrowserDialog.LoadPath
Object
AccordionCancelEventArgs
AccordionCancelEventArgs
Accordion.Selecting
Accordion.Deselecting
ClientProfile
ClientProfile
IContainer
IContainer
ColorDialog
WisejEventArgs
QueryContinueDragEventHandler
QueryContinueDrag
Control
SwipeEventHandler
Swipe
MenuItem
MenuItem
MenuButtonItemClickedEventHandler
ItemClicked
Button
String
HashChangedEventHandler
HashChanged
LicenseErrorEventHandler
LicenseError
ClientProfile
ClientProfile
ClientProfile
ClientProfile
ResponsiveProfileChangedEventHandler

affectedComponent

IComponent

The IComponent affected by the layout change.

affectedProperty

String

The property affected by the layout change.

affectedControl

Control

The Control affected by the layout change.

affectedProperty

String

LayoutEventHandler

Represents the method that will handle the Layout event of a Control.

LayoutEventArgs(affectedControl, affectedProperty)

Properties

AffectedComponent

AffectedControl

AffectedProperty

Used By

LayoutEventArgs
IComponent
IComponent
Control
String

The property affected by the layout change.

Fired when the mouse pointer is over the control and a mouse button is pressed.

Fired when the mouse pointer is moved over the control.

Fired when the mouse pointer is over the control and a mouse button is released.

Fired when the mouse wheel moves while the control has focus.

sender
,
MouseEventArgs
e
)

sender

Object

The source of the event.

e

MouseEventArgs

A MouseEventArgs that contains the event data.

CheckedListBox.MouseClick

Fired when the user clicks the CheckedListBox control with the mouse.

Control.MouseClick

Fired when the control is clicked by the mouse.

Control.MouseDoubleClick

Fired By

Fired when the control is double clicked by the mouse.

Provides access to common image properties across the controls that implement this interface.

All wisej components implement this interface.

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

Allows an object to serialize itself.

IBindableComponent

Bindable components implement this interface.

IButtonControl

Allows a control to act like a button on a Form.

ICommandSource

Public Class SplitButton
    Inherits Button

Constructors

SplitButton()

Properties

Orientation

Implements

Button
SplitButton
Orientation
SplitButton
Vertical
public class SplitButton : Button

Defines an object that can invoke a .

Name
Type
Description

keyData

A representing the key that was pressed, combined with any modifier flags that indicate which CTRL, SHIFT, and ALT keys were pressed at the same time. Possible values are obtained be applying the bitwise OR (|) operator to constants from the enumeration.

Boolean: Returns whether the ALT key was pressed.

Boolean: Returns whether the CTRL key was pressed.

Boolean: Returns or sets whether the event was handled.

Keys: Returns the keyboard code..

Keys: Returns the key data.

Int32: Returns the keyboard value.

Keys: Returns the modifier flags indicating which combination of CTRL, SHIFT, and ALT keys was pressed.

Boolean: Returns a value indicating whether the SHIFT key was pressed.

Returns whether the Alt key is pressed.

Returns: Boolean.

Returns whether the Control key is pressed.

Returns: Boolean.

Returns whether the Shift key is pressed.

Returns: Boolean.

Name
Description

Represents the method that will handle the or event of a .

Public Class KeyEventArgs
    Inherits EventArgs

Constructors

KeyEventArgs(keyData)

KeyDown
KeyUp
KeyEventArgs
public class KeyEventArgs : EventArgs

Properties

Alt

Control

Handled

KeyCode

KeyData

KeyValue

Modifiers

Shift

Methods

IsAltPressed()

IsCtrlPressed()

IsShiftPressed()

Used By

Name
Type
Description

keyData

One of the values.

Boolean: Returns whether the ALT key was pressed.

Boolean: Returns whether the CTRL key was pressed.

Boolean: Returns whether a key is a regular input key.

Keys: Returns the keyboard code.

Keys: Returns the key data.

Int32: Returns the keyboard value.

Keys: Returns the modifier flags indicating which combination of CTRL, SHIFT, and ALT keys was pressed.

Boolean: Returns whether the SHIFT key was pressed.

Name
Description

Represents the method that will handle the event.

Public Class PreviewKeyDownEventArgs
    Inherits EventArgs

Constructors

PreviewKeyDownEventArgs(keyData)

PreviewKeyDown
PreviewKeyDownEventArgs
public class PreviewKeyDownEventArgs : EventArgs

Properties

Alt

Control

IsInputKey

KeyCode

KeyData

KeyValue

Modifiers

Shift

Used By

Name
Type
Description

panel

The the event is occurring for.

panelIndex

The zero-based index of panel in the collection.

AccordionAction: Returns a value indicating which event is occurring.

AccordionPanel: Returns the AccordionPanel the event is occurring for.

Int32: Returns the zero-based index of the Panel in the Panels collection.

Name
Description

Represents the method that will handle the or event of a control.

Public Class AccordionCancelEventArgs
    Inherits CancelEventArgs

Constructors

AccordionCancelEventArgs(panel, panelIndex, cancel, action)

Selecting
Deselecting
Accordion
AccordionCancelEventArgs
public class AccordionCancelEventArgs : CancelEventArgs

Properties

Action

Panel

PanelIndex

Used By

  • ContainerControl

    • Form

      • FileDialogUI

UI implementation for the FileDialog class.

public class FileDialogUI : Form
Public Class FileDialogUI
    Inherits Form
Name
Type
Description

fileDialog

Name
Description

Bindable components implement this interface.

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

Control
ScrollableControl

Constructors

FileDialogUI()

FileDialogUI(fileDialog)

Implements

  • ContainerControl

    • Form

      • FolderBrowserDialogUI

UI implementation for the FolderDialog class.

public class FolderBrowserDialogUI : Form
Public Class FolderBrowserDialogUI
    Inherits Form
Name
Type
Description

folderDialog

Name
Description

Bindable components implement this interface.

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

Control
ScrollableControl

Constructors

FolderBrowserDialogUI()

FolderBrowserDialogUI(folderDialog)

Implements

Constructs a new instance of FileDialogLoadPathEventArgs.
Name
Type
Description

path

Path of the file or directory.

isDirectory

DateTime: Sets the creation DateTime of the file.

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.

Name
Description

Represents the method that will handle the and events.

Public Class FileDialogLoadPathEventArgs
    Inherits CancelEventArgs

Constructors

FileDialogLoadPathEventArgs(path, isDirectory)

FileDialog
FolderBrowserDialog
ImageSource
CreationTime
LastWriteTime
public class FileDialogLoadPathEventArgs : CancelEventArgs

Properties

CreationTime

FileSize

ImageSource

IsDirectory

LastWriteTime

Path

Used By

Name
Type
Description

graphics

The used to paint the item.

clipRect

The that represents the rectangle in which to paint.

Rectangle: Returns the rectangle in which to paint.

Graphics: Returns the graphics used to paint.

Name
Description

Represents the method that will handle the event of a .

Public Class PaintEventArgs
    Inherits EventArgs

Constructors

PaintEventArgs(graphics, clipRect)

Paint
PaintEventArgs
public class PaintEventArgs : EventArgs

Properties

ClipRectangle

Graphics

Used By

Name
Type
Description

panel

The the event is occurring for.

panelIndex

The zero-based index of panel in the collection.

AccordionAction: Returns a value indicating which event is occurring.

AccordionPanel: Returns the AccordionPanel the event is occurring for.

Int32: Returns the zero-based index of the Panel in the Panels collection.

Name
Description

Represents the method that will handle the or event of a control.

Public Class AccordionEventArgs
    Inherits EventArgs

Constructors

AccordionEventArgs(panel, panelIndex, action)

Selected
Deselected
Accordion
AccordionEventArgs
public class AccordionEventArgs : EventArgs

Properties

Action

Panel

PanelIndex

Used By

Description

sender

The source of the event.

e

A that contains the event data.

Name
Description

Fired when a key is pressed while the control has focus.

Public Delegate Sub KeyPressEventHandler(ByVal sender As [Object], ByVal e As KeyPressEventArgs)

Parameters

KeyPress
Control
public delegate void KeyPressEventHandler(Object sender, KeyPressEventArgs e)

Fired By

Name
Type
Description

type

The type (name) of event.

data

The data object received with the event.

Object: Returns the data object that was sent by the widget with the event.

String: Returns the type (name) of the event fired by the widget.

Name
Description

Represents the method that handles the event.

Public Class WidgetEventArgs
    Inherits EventArgs

Constructors

WidgetEventArgs(type, data)

WidgetEvent
WidgetEventArgs
public class WidgetEventArgs : EventArgs

Properties

Data

Type

Used By

OpenFileDialog

Wisej.Web.OpenFileDialog

Namespace: Wisej.Web

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

Initializes a new instance of .

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

Name
Type
Description

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

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

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

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

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.

Resets all properties to their default values.

ClientBrowser

Wisej.Core.ClientBrowser

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Properties of the client browser currently interacting with the application.

Name
Type

DragEventArgs

Wisej.Web.DragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the , , or event.

Initializes a new instance of the class.

Cursor

Wisej.Web.Cursor

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the mouse pointer.

Creates a new cursor using the .

JavaScript.ClientEventCollection

Wisej.Web.JavaScript ClientEventCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents a collection of JavaScript events and their corresponding handler code.

: Returns the number of items in the collection.

: Returns the element at the specified index

Control.MouseDown
Control.MouseMove
Control.MouseUp
Control.MouseWheel
Object
KeyPressEventArgs
KeyPressEventArgs
Control.KeyPress

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.

IWisejSerializable

Allows an object to serialize itself.

FileDialog
IBindableComponent
IContainerControl
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.

IWisejSerializable

Allows an object to serialize itself.

FolderBrowserDialog
IBindableComponent
IContainerControl
IWisejComponent
Command
IImage
IWisejComponent
IWisejControl
Control
IWisejSerializable
Keys
Keys
Keys
KeyEventHandler
KeyUp
KeyDown
Control
Keys
Keys
PreviewKeyDownEventHandler
PreviewKeyDown

cancel

Boolean

true to cancel the panel change by default; otherwise, false.

action

AccordionAction

One of the AccordionAction values.

AccordionPanel
AccordionPanel
Int32
Panels
AccordionCancelEventHandler
Selecting
Deselecting
Accordion

Indicates that the path is for a directory.

String
Boolean
FileDialogLoadPathEventHandler
LoadPath
LoadPath
Graphics
Graphics
Rectangle
Rectangle
PaintEventHandler
Paint
Control

action

AccordionAction

One of the AccordionAction values.

AccordionPanel
AccordionPanel
Int32
Panels
AccordionEventHandler
Selected
Deselected
Accordion
String
Object
WidgetEventHandler
WidgetEvent
  • 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.

    Public Class OpenFileDialog
        Inherits FileDialog

    Constructors

    OpenFileDialog()

    OpenFileDialog(container)

    Properties

    CheckFileExists

    Multiselect

    SafeFileName

    SafeFileNames

    Methods

    OpenFile()

    Reset()

    OpenFileDialog
    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
    Description

    CookieStorage

    Returns an instance of the class that represents the "cookies" storage in the browser.

    LocalStorage

    Returns an instance of the class that represents the "localStorage" object in the browser.

    SessionStorage

    Returns an instance of the class that represents the "sessionStorage" object in the browser.

    CultureInfo: Returns the locale declared in the application configuration file or detected from the client browser.

    String: Device type. Can be one of "Mobile", "Tablet" or "Desktop".

    Object: Returns the set of features supported/not-supported by the browser. Currently we detect: geolocation, webSocket, fullScreen, speechSynthesis, speechRecognition, notification, fullScreen, browserStorage.

    String: IP Address of the client computer.

    Boolean: Returns true if the browser is using dark mode. [Since 3.0.10]

    Boolean: Returns true if the browser is in full screen mode.

    Boolean: Returns true if the connection is secure.

    String: Client language.

    String: Client OS. Can be one of "iOS", "Android", "WebOS", "BlackBerry", "MacOS", "Linux", "Windows", "Unix", "Other".

    Double: Returns the ratio of the resolution in physical pixels to the resolution in CSS pixels for the current display device.

    ClientProfile[]:

    Size: Screen size.

    String: Returns the session ID associated with this ClientBrowser.

    Size: Browser size. This is the window size, which can be different from the device (or screen) size.

    String: Identifies the browser tab associated with with this ClientBrowser instance.

    Int32: Returns the time difference between UTC time and local time, in minutes.

    String: Browser type. Can be one of "IE", "Edge", "Chrome", "Opera", "Firefox", "Safari", "Other".

    String: Returns the raw user agent string of the client browser.

    Object: Returns a value or map set by the client when loading the application's first HTML page.

    An application can use this property to retrieve a custom value on startup. For example, in Default.html add:

    On the server side, you can retrieve the user data use at any time like this:

    When used in conjunction with an aspx startup page (Default.aspx) it allows the application to retrieve data passed as a POST request and pass it to the Wisej application.

    Int32: Browser version.

    Public Class ClientBrowser

    Fields

    public class ClientBrowser
    <script>
    Wisej.userData = {
    value1: 100,
    someName: "test"
    };
    </script>
    
    int value1 = Application.Browser.UserData.value1;
    string value2 = Application.Browser.UserData.someName;
    

    Properties

    CultureInfo

    Device

    Features

    IPAddress

    IsDarkMode

    IsFullScreen

    IsSecure

    Language

    OS

    PixelRatio

    Profiles

    ScreenSize

    SessionId

    Size

    TabId

    TimezoneOffset

    Type

    UserAgent

    UserData

    Version

    Name
    Type
    Description

    allowedEffect

    One of the values.

    effect

    One of the values.

    data

    The data associated with this event.

    DragDropEffects: Returns which drag-and-drop operations are allowed by the originator (or source) of the drag event.

    String: Specify the types of files that the server accepts (that can be submitted through a file upload).

    The allowed files string follows the HTML 4.01 and HTML5 specifications. You can configure only one entry in the browser's file dialog. The syntax is "file_extension|audio/|video/|image/*|media_type". Look at IANA Media Types for a complete list of standard media types.

    IDataObject: Returns the IDataObject that contains the data associated with this event.

    Control: Returns the component that started the drag operation by calling DoDragDrop. [Since 2.5.32]

    Object: Returns the original target of the drag operation.

    DragDropEffects: Returns or sets the target drop effect in a drag-and-drop operation.

    HttpFileCollection: Returns the HttpFileCollection containing the files that have been dropped on the target, or null.

    Image: Returns or sets the custom image displayed on the client to represent the drag action.

    Size: Returns or sets the size in pixels of the custom image displayed on the client to represent the drag action.

    String: Returns or sets the custom image source displayed on the client to represent the drag action.

    Int32: Returns the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons.

    Point: Returns the location of the mouse or pointer event, in screen coordinates.

    Int32: Returns the x-coordinate of the mouse or pointer, in screen coordinates.

    Int32: Returns the y-coordinate of the mouse or pointer, in screen coordinates.

    Name
    Description

    Represents the method that will handle the , , or event of a .

    Public Class DragEventArgs
        Inherits EventArgs

    Constructors

    DragEventArgs(allowedEffect, effect, data, location)

    DragDrop
    DragEnter
    DragOver
    DragEventArgs
    public class DragEventArgs : EventArgs

    Properties

    AllowedEffect

    AllowedFileTypes

    Data

    DragSource

    DropTarget

    Effect

    Files

    Image

    ImageSize

    ImageSource

    KeyState

    Location

    X

    Y

    Used By

    Name
    Type
    Description

    image

    An to use for the cursor.

    Creates a new cursor using an image source: can use a themed image or URL.

    Name
    Type
    Description

    source

    The name of a theme image or a URL to an image resource.

    Creates a new cursor using the Image.

    Name
    Type
    Description

    stream

    A to use for the cursor.

    Creates a new cursor using the Image.

    Name
    Type
    Description

    image

    An to use for the cursor.

    x

    Creates a new cursor using the Image.

    Name
    Type
    Description

    stream

    A to use for the cursor.

    x

    Creates a new cursor using an image source: can use a themed image or URL.

    Name
    Type
    Description

    source

    The name of a theme image or a URL to an image resource.

    x

    String: Returns the name of the cursor.

    Point: Returns or sets the pointer's position.

    Public Class Cursor

    Constructors

    Cursor(image)

    Image
    public class Cursor

    Cursor(source)

    Cursor(stream)

    Cursor(image, x, y)

    Cursor(stream, x, y)

    Cursor(source, x, y)

    Properties

    Name

    Position

    .

    Adds the ClientEvent instance to the collection.

    Parameter
    Type
    Description

    item

    item to add to the collection.

    Removes all the ClientEvent items from the collection.

    Checks whether the specified item exists in the collection.

    Parameter
    Type
    Description

    item

    items to find in the collection.

    Returns: Boolean. True of the collection contains the specified item .

    Returns the position of the specified item in the collection.

    Parameter
    Type
    Description

    item

    item to locate in the collection.

    Returns: Int32. The index of the specified item or -1 if not found.

    Inserts the item into the collection at the specified index .

    Parameter
    Type
    Description

    index

    Position where to insert the item .

    item

    Removes the item from the collection.

    Parameter
    Type
    Description

    item

    instance to remove from the collection.

    Returns: Boolean. True of the specified item was found and removed from the collection.

    Removes the ClientEvent item at the location index .

    Parameter
    Type
    Description

    index

    Position of the item to remove from the collection.

    CollectionChangeEventHandler Fired when the collection has changed.

    Public Class ClientEventCollection
        Inherits IList
        Implements ICollection, IEnumerable, IList(Of ClientEvent), ICollection(Of ClientEvent), IEnumerable(Of ClientEvent)

    Constructors

    ClientEventCollection()

    Properties

    Count

    Item(index)

    Int32
    ClientEvent
    ClientEvent
    public class ClientEventCollection : IList, ICollection, IEnumerable, IList<ClientEvent>, ICollection<ClientEvent>, IEnumerable<ClientEvent>

    Methods

    Add(item)

    Clear()

    Contains(item)

    IndexOf(item)

    Insert(index, item)

    Remove(item)

    RemoveAt(index)

    Events

    CollectionChanged

    MouseEventArgs

    Wisej.Web.MouseEventArgs

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Provides data for the MouseUp, MouseDown, and MouseMove events.

    public class MouseEventArgs : EventArgs
    Public Class MouseEventArgs
        Inherits EventArgs

    Constructors

    MouseEventArgs(button, clicks, x, y, delta)

    Initializes a new instance of the MouseEventArgs class.

    Name
    Type
    Description

    Initializes a new instance of the class.

    Name
    Type
    Description

    : Returns which mouse button was pressed.

    : Returns the number of clicks or taps.

    : Returns the number of times the mouse wheel has rotated.

    : Returns the location of the mouse or pointer event.

    : Returns the original target when the pointer event has bubbled up because the original target was either not or .

    : Returns the internal role assigned to the element that generated the pointer event: checkbox, button, ...

    The value in the Role property is taken from the "role" attribute of the clicked element inside the widget. You can detect clicks on custom HTML content by adding the role attribute to the custom element.

    : Returns the x-coordinate of the mouse or touch event.

    : Returns the y-coordinate of the mouse or touch event.

    Name
    Description

    Button

    Wisej.Web.Button

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

      • ButtonBase

    Represents a button control.

    Initializes a new instance of the class.

    : Returns or sets the mode by which the automatically resizes itself.

    : Returns or sets the border style of the button control.

    : EXPERIMENTAL. Returns or sets the implementation to invoke.

    : Returns or sets a value that is returned to the parent form when the button is clicked.

    : Returns or sets the mode of the control to determine whether to display the icon, the text or both.

    : Returns or sets the distance in pixels between the image and the label inside the button.

    : Returns the collection of objects associated with the button.

    : Enables or disables the auto-repeat feature. When enabled, the button keeps firing click events at an increasing rate while the user keeps the button pressed.

    : Returns or sets a value indicating the shortcut key associated with the button.

    Generates a event for a button.

    Fired when the property value changes.

    Fired when the user clicks one of the drop down menu items.

    Name
    Description
    Name
    Description

    Cursors

    Wisej.Web.Cursors

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Defines a collection of predefined Cursor objects.

    public class Cursors
    Public Class Cursors

    Properties

    Alias

    Cursor: Returns the "shortcut" cursor.

    Arrow

    Cursor: Returns the "arrow" cursor.

    Cell

    : Returns "cell" cursor.

    : Returns the clipboard "copy" cursor.

    : Returns the "crosshair" cursor.

    : Returns the "default" cursor, which is usually an arrow cursor.

    : Returns the "grab" cursor.

    : Returns the "hand" cursor, typically used when hovering over a Web link.

    : Returns the "help" cursor, which is a combination of an arrow and a question mark.

    : Returns the "row-resize" cursor that appears when the mouse is positioned over a horizontal splitter bar.

    : Returns the "text" cursor, which is used to show where the text cursor appears when the mouse is clicked.

    : Returns the "move" cursor, typically an cross shape.

    : Returns the "not-allowed" cursor that indicates that a particular region is invalid for the current operation.

    : Returns the "none" cursor.

    : Returns the "not-allowed" cursor.

    : Returns the "move" sizing cursor, which consists of four joined arrows that point north, south, east, and west.

    : Returns the "ne-resize" diagonal (north/east) sizing cursor.

    : Returns the "nesw-resize" diagonal (northeast/southwest) sizing cursor.

    : Returns the "n-resize" vertical (north/south) sizing cursor.

    : Returns the "nw-resize" diagonal (north/west) sizing cursor.

    : Returns the "nwse-resize" diagonal (northwest/southeast) sizing cursor.

    : Returns the "se-resize" diagonal (south/east) sizing cursor.

    : Returns the "sw-resize" diagonal (south/west) sizing cursor.

    : Returns the "w-resize" horizontal (west/east) sizing cursor.

    : Returns the "text" cursor.

    : Returns the "col-resize" cursor that appears when the mouse is positioned over a vertical splitter bar.

    : Returns the "wait" cursor, typically an hourglass shape.

    : Returns the "zoom-in" cursor.

    : Returns the "zoom-out" cursor.

    SaveFileDialog

    Wisej.Web.SaveFileDialog

    Namespace: Wisej.Web

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

    Initializes a new instance of .

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

    Name
    Type
    Description

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

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

    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.

    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.

    Resets all dialog box options to their default values.

    FolderBrowserDialog

    Wisej.Web.FolderBrowserDialog

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • CommonDialog

      • FolderBrowserDialog

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

    Initializes a new instance of .

    Initializes a new instance of using the initial roots .

    Name
    Type
    Description

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

    Name
    Type
    Description

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

    : List of root file systems displayed by the FolderBrowserDialog.

    The Roots collection and the 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.

    : Returns sets the path selected by the user.

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

    : Returns or sets the file dialog box title.

    Returns the that contains the specified path .

    Parameter
    Type
    Description

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

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

    Parameter
    Type
    Description

    Returns: . The physical path for the implementation.

    Resets all properties to their default values.

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

    AccordionPanel

    Wisej.Web.AccordionPanel

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

      • ScrollableControl

    Represents a panel in a control.

    Initializes a new instance of the class.

    Initializes a new instance of the class and specifies the text to display as the title of the panel.

    Name
    Type
    Description

    : Returns the parent control.

    : Returns whether the is collapsed.

    : Returns or sets a value indicating that the panel can show the expand button on the title bar.

    : Returns or sets the text to display as the title of the .

    : Returns the instance of associated with this control.

    Retrieves the panel that contains the specified .

    Parameter
    Type
    Description

    Returns: . The that contains the specified , or null if it cannot be found.

    Overridden to update the parent Accordion when in design mode.

    Name
    Description

    ResponsiveProfileChangedEventHandler

    Wisej.Web.ResponsiveProfileChangedEventHandler

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Represents the method that will handle the Application.ResponsiveProfileChanged event.

    public delegate void ResponsiveProfileChangedEventHandler(Object 
    Public Delegate Sub ResponsiveProfileChangedEventHandler(ByVal sender As [Object], ByVal e As ResponsiveProfileChangedEventArgs)

    Parameters

    Name
    Type
    Description
    Name
    Description

    ButtonBase

    Wisej.Web.ButtonBase

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    RadioButton

    Wisej.Web.RadioButton

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    sender
    ,
    ResponsiveProfileChangedEventArgs
    e
    )

    sender

    Object

    The source of the event.

    e

    ResponsiveProfileChangedEventArgs

    A ResponsiveProfileChangedEventArgs that contains the event data.

    Control.ResponsiveProfileChanged

    Fired when the active responsive profile is changed.

    Application.ResponsiveProfileChanged

    Fired when the active responsive profile is changed.

    Fired By

    CookieStorage
    CookieStorage
    LocalStorage
    LocalStorage
    SessionStorage
    SessionStorage

    location

    Point

    The Point that indicates the location of the drag event.

    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    Object
    DragEventHandler
    DragDrop
    DragEnter
    DragOver
    Control

    x-coordinate of the hotspot location.

    y

    Int32

    y-coordinate of the hotspot location.

    x-coordinate of the hotspot location.

    y

    Int32

    y-coordinate of the hotspot location.

    x-coordinate of the hotspot location.

    y

    Int32

    y-coordinate of the hotspot location.

    Image
    Image
    String
    Stream
    Stream
    Image
    Image
    Int32
    Stream
    Stream
    Int32
    String
    Int32

    ClientEvent item to insert into the collection.

    ClientEvent
    ClientEvent
    ClientEvent
    ClientEvent
    ClientEvent
    ClientEvent
    Int32
    ClientEvent
    ClientEvent
    ClientEvent
    Int32

    y

    The y-coordinate of a pointer click, in pixels.

    delta

    A signed count of the number of dents the wheel has rotated.

    x

    The x-coordinate of a pointer click, in pixels.

    y

    The y-coordinate of a pointer click, in pixels.

    delta

    A signed count of the number of dents the wheel has rotated.

    role

    The internal role assigned to the element that generated the pointer event.

    button

    MouseButtons

    One of the MouseButtons values that indicate which mouse button was pressed.

    clicks

    Int32

    The number of times a mouse button was pressed.

    x

    Int32

    The x-coordinate of a pointer click, in pixels.

    button

    MouseButtons

    One of the MouseButtons values that indicate which mouse button was pressed.

    clicks

    Int32

    MouseEventHandler

    Represents the method that will handle the MouseDown, MouseUp, or MouseMove event of a form, control, or other component.

    MouseEventArgs(button, clicks, x, y, delta, role)

    Properties

    Button

    Clicks

    Delta

    Location

    OriginalTarget

    Role

    X

    Y

    Used By

    MouseEventArgs
    MouseButtons
    Int32
    Int32
    Point
    Control
    Control
    Enabled
    Anonymous
    String
    Int32
    Int32

    The number of times a mouse button was pressed.

    Provides access to common image properties across the controls that implement this interface.

    All wisej components implement this interface.

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

    Allows an object to serialize itself.

    SplitButton

    Represents a split button control.

    IBindableComponent

    Bindable components implement this interface.

    IButtonControl

    Allows a control to act like a button on a Form.

    ICommandSource

    Public Class Button
        Inherits ButtonBase
        Implements IButtonControl, ICommandSource

    Constructors

    Button()

    Properties

    AutoSizeMode

    BorderStyle

    Command

    DialogResult

    Display

    ImageSpacing

    MenuItems

    Repeat

    Shortcut

    Methods

    PerformClick()

    Events

    CommandChanged

    ItemClicked

    Inherited By

    Implements

    Button
    Button
    AutoSizeMode
    Button
    BorderStyle
    ICommand
    ICommand
    DialogResult
    Display
    Display
    Nullable<Int32>
    MenuItemCollection
    MenuItem
    Boolean
    Shortcut
    Click
    EventHandler
    Command
    MenuButtonItemClickedEventHandler
    public class Button : ButtonBase, IButtonControl, ICommandSource

    Defines an object that can invoke a .

    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.

    Public Class SaveFileDialog
        Inherits FileDialog

    Constructors

    SaveFileDialog()

    SaveFileDialog(container)

    Properties

    CreatePrompt

    OverwritePrompt

    Methods

    OpenFile()

    ProcessFileNames(fileNames)

    Reset()

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

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

    Allows an object to serialize itself.

    text

    String

    The text for the tab.

    control

    Control

    The Control to look for.

    IBindableComponent

    Bindable components implement this interface.

    IImage

    Provides access to common image properties across the controls that implement this interface.

    IWisejComponent

    Public Class AccordionPanel
        Inherits Panel

    Constructors

    AccordionPanel()

    AccordionPanel(text)

    Properties

    Accordion

    Collapsed

    ShowExpandButton

    Text

    Tools

    Methods

    GetAccordionPanelOfComponent(control)

    Update()

    Implements

    Panel
    AccordionPanel
    Accordion
    AccordionPanel
    AccordionPanel
    Accordion
    Accordion
    Boolean
    AccordionPanel
    Boolean
    String
    AccordionPanel
    ComponentToolCollection
    ComponentToolCollection
    Control
    AccordionPanel
    AccordionPanel
    Control
    public class AccordionPanel : Panel

    All wisej components implement this interface.

    Implements the basic functionality common to button controls.
    public class ButtonBase : Control,
    Public Class ButtonBase
        Inherits Control
        Implements IImage

    Initializes a new instance of the ButtonBase class.

    Boolean: Returns or sets a value indicating that the control can display HTML in the Text property.

    Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.

    Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the button, denoting that the text extends beyond the size of the button.

    Boolean: Returns or sets whether the application blocks the browser with a modal mask when this button is clicked and until the server is done processing the execution request.

    AutoShowLoader blocks the entire browser as soon as the button is clicked since it's implemented on the client side, while ShowLoader blocks the specific widget when returning from the request.

    Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.

    CharacterCasing: Returns or sets the case of the text to display to the user.

    Image: Returns or sets the image that is displayed in a button control.

    ContentAlignment: Returns or sets the alignment of the image in the button control.

    Int32: Returns or sets the image list index value of the image in the ImageList displayed in the button control.

    Throws:

    • ArgumentOutOfRangeException The specified index is less than -1.

    String: Returns or sets the key accessor for the image in the ImageList displayed in the button control.

    ImageList: Returns or sets the ImageList that contains the Image displayed in a button control.

    String: Returns or sets the theme name or URL for the image to display in the button control.

    String: Returns or sets the text associated with this control.

    Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.

    ContentAlignment: Returns or sets the alignment of the text in the button control.

    TextImageRelation: Returns or sets the position of text and image relative to each other.

    Boolean: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control.

    Generates a Click event for a button.

    Name
    Description

    Represents a button control.

    Represents a check box control.

    Name
    Description

    Bindable components implement this interface.

    Provides access to common image properties across the controls that implement this interface.

    Control
    ButtonBase

    Constructors

    ButtonBase()

    Properties

    AllowHtml

    AutoEllipsis

    AutoShowLoader

    AutoSize

    CharacterCasing

    Image

    ImageAlign

    ImageIndex

    ImageKey

    ImageList

    ImageSource

    Text

    TextAlign

    TextImageRelation

    UseMnemonic

    Methods

    PerformClick()

    Inherited By

    Implements

  • RadioButton

  • Enables the user to select a single option from a group of choices when paired with other RadioButton controls.

    public class RadioButton : ButtonBase,
    Public Class RadioButton
        Inherits ButtonBase
        Implements IReadOnly

    Initializes a new instance of the RadioButton class.

    Appearance: Returns or sets the value that determines the appearance of a CheckBox control.

    Boolean: Returns or set a value indicating whether the Checked or CheckState values and the CheckBox's appearance are automatically changed when the CheckBox is clicked.

    Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.

    ContentAlignment: Returns or sets the horizontal and vertical alignment of the check mark on a CheckBox control.

    Boolean: Gets or sets whether the control is checked.

    Color: Returns or sets the text color used when the RadioButton is checked.

    Boolean: Returns or sets a value that indicates that the control is invalid.

    String: Returns or sets the invalid message that is shown in the invalid tooltip.

    Boolean: Returns or sets whether the control is read-only.

    Boolean: Returns or sets whether the user can give the focus to this control using the TAB key and the Focusable property is set to true.

    ContentAlignment: Returns or sets the alignment of the text on the CheckBox control.

    Generates a Click event for a RadioButton.

    EventHandler Fired when the value of the Appearance property changes.

    EventHandler Fired when the value of the Checked property changes.

    EventHandler Fired when the value of the ReadOnly property has changed.

    Name
    Description

    Bindable components implement this interface.

    Provides access to common image properties across the controls that implement this interface.

    Control
    ButtonBase

    Constructors

    RadioButton()

    Properties

    Appearance

    AutoCheck

    AutoSize

    CheckAlign

    Checked

    CheckedForeColor

    Invalid

    InvalidMessage

    ReadOnly

    TabStop

    TextAlign

    Methods

    PerformClick()

    Events

    AppearanceChanged

    CheckedChanged

    ReadOnlyChanged

    Implements

    roots

    IFileSystemProvider[]

    Initial file systems to load in the FolderBrowserDialog.

    container

    IContainer

    An IContainer that represents the container of the FolderBrowserDialog component.

    path

    String

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

    folderPath

    String

    Virtual path to map to the corresponding physical path.

    Public Class FolderBrowserDialog
        Inherits CommonDialog

    Constructors

    FolderBrowserDialog()

    FolderBrowserDialog(roots)

    FolderBrowserDialog(container)

    Properties

    Description

    Roots

    SelectedPath

    ShowHelp

    Title

    Methods

    GetRoot(path)

    MapPath(folderPath)

    Reset()

    Events

    LoadPath

    Roots
    FolderBrowserDialog
    FolderBrowserDialog
    FolderBrowserDialog
    String
    FileDialogRootCollection
    IFileSystemProvider
    IFileSystemProvider
    String
    Boolean
    String
    IFileSystemProvider
    IFileSystemProvider
    IFileSystemProvider
    IFileSystemProvider
    String
    IFileSystemProvider
    FileDialogLoadPathEventHandler
    public class FolderBrowserDialog : CommonDialog

    Copy

    Cross

    Default

    Grab

    Hand

    Help

    HSplit

    IBeam

    Move

    No

    None

    NotAllowed

    SizeAll

    SizeNE

    SizeNESW

    SizeNS

    SizeNW

    SizeNWSE

    SizeSE

    SizeSW

    SizeWE

    Text

    VSplit

    WaitCursor

    ZoomIn

    ZoomOut

    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor
    Cursor

    CheckBox

    Wisej.Web.CheckBox

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

      • ButtonBase

    Represents a check box control.

    Initializes a new instance of the class.

    : Returns or sets the value that determines the appearance of a control.

    : Returns or set a value indicating whether the or values and the 's appearance are automatically changed when the is clicked.

    : Returns or sets a value that indicates whether the control resizes based on its contents.

    : Returns or sets the horizontal and vertical alignment of the check mark on a control.

    : Returns or set a value indicating whether the is in the checked state.

    : Returns or sets the text color used when the is checked.

    : Returns or sets the state of the .

    : Returns or sets a value that indicates that the control is invalid.

    : Returns or sets the invalid message that is shown in the invalid tooltip.

    : Returns or sets whether the control is read-only.

    : Returns or sets the alignment of the text on the control.

    : Returns or sets whether the will allow three check states rather than two.

    Generates a event for a .

    Fired when the value of the property changes.

    Fired when the value of the property changes.

    Fired when the value of the property changes.

    Fired when the value of the property has changed.

    Name
    Description

    Component

    Wisej.Web.Component

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    IImage

    Enables the user to select a single option from a group of choices when paired with other RadioButton controls.

    SplitButton

    Represents a split button control.

    All wisej components implement this interface.

    IWisejControl

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

    IWisejSerializable

    Allows an object to serialize itself.

    Button
    CheckBox
    RadioButton
    IBindableComponent
    IImage
    IWisejComponent
    IReadOnly

    Provides access to the ReadOnly property for coontrols that support the read-only mode.

    IWisejComponent

    All wisej components implement this interface.

    IWisejControl

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

    IWisejSerializable

    Allows an object to serialize itself.

    IBindableComponent
    IImage
    IReadOnly
    Int32
    Int32
    Int32
    Int32
    Int32
    String
    Command
    IImage
    IWisejComponent
    IWisejControl
    Control
    IWisejSerializable
    IWisejControl
    Control
    IWisejSerializable

    All wisej components implement this interface.

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

    Allows an object to serialize itself.

    IBindableComponent

    Bindable components implement this interface.

    IImage

    Provides access to common image properties across the controls that implement this interface.

    IReadOnly

    Public Class CheckBox
        Inherits ButtonBase
        Implements IReadOnly

    Constructors

    CheckBox()

    Properties

    Appearance

    AutoCheck

    AutoSize

    CheckAlign

    Checked

    CheckedForeColor

    CheckState

    Invalid

    InvalidMessage

    ReadOnly

    TextAlign

    ThreeState

    Methods

    PerformClick()

    Events

    AppearanceChanged

    CheckedChanged

    CheckStateChanged

    ReadOnlyChanged

    Implements

    CheckBox
    CheckBox
    Appearance
    CheckBox
    Boolean
    Checked
    CheckState
    CheckBox
    CheckBox
    Boolean
    ContentAlignment
    CheckBox
    Boolean
    CheckBox
    Color
    CheckBox
    CheckState
    CheckBox
    Boolean
    String
    Boolean
    ContentAlignment
    CheckBox
    Boolean
    CheckBox
    Click
    CheckBox
    EventHandler
    Appearance
    EventHandler
    Checked
    EventHandler
    CheckState
    EventHandler
    ReadOnly
    public class CheckBox : ButtonBase, IReadOnly

    Provides access to the property for coontrols that support the read-only mode.

    Extends Component and enabled the components to appear on the designer surface.
    public class Component : Component,
    Public Class Component
        Inherits Component
        Implements IComponent

    Default constructor

    Updates the component on the client.

    Name
    Description

    Implements a timer that raises an event at user-defined intervals.

    Represents a component in the control's taskbar.

    Name
    Description

    All wisej components implement this interface.

    Allows an object to serialize itself.

    Component
    Component

    Constructors

    Component()

    Methods

    Update()

    Inherited By

    Implements

    ContainerControl

    Wisej.Web.ContainerControl

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

      • ScrollableControl

    Provides focus-management functionality for controls that can function as a container for other controls.

    Initializes a new instance of the class.

    : Returns or sets a collection of keys that fire the Accelerator event when the user presses the accelerator key while the focus is on any child control.

    : Returns or sets the active control on the container control.

    Throws:

    • The assigned could not be activated.

    : Returns or sets the BindingContext for the control.

    : Returns or sets whether the container will receive key events before the event is passed to the control that has focus.

    : Returns the that the container control is assigned to.

    : Returns the that the container control is assigned to.

    : Enables or disables right-to-left layout when the value of is

    Validates the last unvalidated control and its ancestors up through, but not including the current control.

    Returns: .

    Validates the last unvalidated control and its ancestors up through, but not including the current control.

    Parameter
    Type
    Description

    Returns: .

    Fired when one of the key is pressed.

    Fired when the value of the property changes.

    Name
    Description
    Name
    Description

    CommonDialog

    Wisej.Web.CommonDialog

    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.

    Name
    Type
    Description

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

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

    : Returns or sets the dialog box title.

    : Returns or sets the initial of the common dialog.

    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: . if the user clicks OK in the dialog box; otherwise, .

    Runs a common dialog box with a default owner.

    Parameter
    Type
    Description

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

    Runs a common dialog box with the specified owner.

    Parameter
    Type
    Description

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

    Runs a common dialog box with the specified owner.

    Parameter
    Type
    Description

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

    Runs a common dialog box with the specified owner asynchronously.

    Parameter
    Type
    Description

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

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

    Name
    Description

    Padding

    Wisej.Web.Padding

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Represents padding or margin information associated with a user interface (UI) element.

    Initializes a new instance of the class using a separate padding size for each edge.

    IComponent

    Represents a component in the Desktop control's taskbar that can host any Control.

    DesktopTaskBarItemDateTime

    Represents a DateTime component in the Desktop control's taskbar.

    Animation

    Provides support for animating controls or windows using predefined animations definitions or custom animations in response to certain events.

    ErrorProvider

    Provides a user interface for indicating that a control on a form has an error associated with it.

    HelpTip

    Represents a small rectangular pop-up window that displays a brief help text next to a control when it gets activated (focused).

    JavaScript

    Allows controls to execute javascript code.

    Rotation

    Add rotation capabilities along the X,Y,Z axis to Control controls.

    StyleSheet

    Adds CSS styling to controls.

    ToolTip

    Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.

    ImageList

    Provides methods to manage a collection of Image objects. This class cannot be inherited.

    ColumnHeader

    Displays a standard column header in a ListView control.

    ImageColumnHeader

    Displays an image column header in a ListView control.

    CheckedMenuItem

    Represents an individual menu item that is displayed within a MainMenu or ContextMenu and always shows a checkbox next to the label.

    ContextMenu

    Represents a context menu associated to a Control.

    LinkMenuItem

    Represents an individual menu item that is displayed within a MainMenu or ContextMenu rendered using the link element to let the browser process the specified HRef URL.

    MainMenu

    Represents the main menu in a Form.

    Menu

    Represents the base functionality for all menus.

    MenuItem

    Represents an individual item that is displayed within a MainMenu or ContextMenu.

    StatusBarControl

    Represents a panel in a StatusBar control that can host any Control.

    StatusBarPanel

    Represents a panel in a StatusBar control.

    ToolBarButton

    Represents an item in the ToolBar.

    Timer
    DesktopTaskBarItem
    Desktop
    DesktopTaskBarItemControl
    IWisejComponent
    IWisejSerializable
    ReadOnly
    IWisejComponent
    IWisejControl
    Control
    IWisejSerializable

    Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.

    Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.

    Provides an empty control that can be used to create other controls.

    Displays data in a customizable list format.

    Represents a desktop container that can host floating windows.

    Provides an popup container that can be attached to other controls.

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

    Allows an object to serialize itself.

    checkAutoValidate

    Boolean

    If true, the value of the AutoValidate property is used to determine if validation should be performed; if false, validation is unconditionally performed.

    FileDialogUI

    UI implementation for the FileDialog class.

    FolderBrowserDialogUI

    UI implementation for the FolderDialog class.

    Form

    IBindableComponent

    Bindable components implement this interface.

    IContainerControl

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

    IWisejComponent

    Public Class ContainerControl
        Inherits ScrollableControl
        Implements IContainerControl, IContainerControl

    Constructors

    ContainerControl()

    Properties

    Accelerators

    ActiveControl

    BindingContext

    KeyPreview

    ParentForm

    ParentPage

    RightToLeftLayout

    Methods

    Validate()

    Validate(checkAutoValidate)

    Events

    Accelerator

    RightToLeftLayoutChanged

    Inherited By

    Implements

    ContainerControl
    ContainerControl
    Keys[]
    Control
    ArgumentException
    Control
    BindingContext
    Boolean
    Form
    Form
    Page
    Page
    Boolean
    RightToLeft
    Yes
    Boolean
    Boolean
    AcceleratorEventHandler
    Accelerators
    EventHandler
    RightToLeftLayout
    public class ContainerControl : ScrollableControl, IContainerControl, IContainerControl

    Represents a window or dialog box that makes up an application's user interface.

    All wisej components implement this interface.

    Prompts the user to open a file from the server.

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

    container

    IContainer

    An IContainer that represents the container of the CommonDialog component.

    onclose

    Action<DialogResult>

    Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event. When the onclose event handler is specified, the modal dialog doesn't suspend the execution on the server but it's still shown as a modal dialog on the client.

    owner

    Form

    A Form that represents the top-level window that owns the modal dialog box. It can be null.

    owner

    Form

    A Form that represents the top-level window that owns the modal dialog box. It can be null.

    onclose

    Action<DialogResult>

    owner

    Form

    A Form that represents the top-level window that owns the modal dialog box. It can be null.

    ColorDialog

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

    FileDialog

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

    FolderBrowserDialog

    Properties

    DialogTemplate

    Tag

    Title

    WindowState

    Methods

    Reset()

    ShowDialog()

    ShowDialog(onclose)

    ShowDialog(owner)

    ShowDialog(owner, onclose)

    ShowDialogAsync(owner)

    Events

    HelpRequested

    Inherited By

    Type
    ShowDialog
    Object
    String
    FormWindowState
    WindowState
    DialogResult
    OK
    Cancel
    DialogResult
    OK
    Cancel
    DialogResult
    OK
    Cancel
    DialogResult
    OK
    Cancel
    Task<DialogResult>
    OK
    Cancel
    EventHandler

    Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the When the onclose event handler is specified, the modal dialog doesn't suspend the execution on the server but it's still shown as a modal dialog on the client.

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

    Name
    Type
    Description

    left

    The padding size, in pixels, for the left edge.

    top

    The padding size, in pixels, for the top edge.

    right

    The padding size, in pixels, for the right edge.

    Initializes a new instance of the Padding class using the supplied padding size for all edges.

    Name
    Type
    Description

    all

    The number of pixels to be used for padding for all edges.

    Int32: Returns or sets the padding value for all the edges.

    Int32: Returns or sets the padding value for the bottom edge.

    Int32: Returns the combined padding for the right and left edges.

    Boolean: Returns if the padding is empty.

    Int32: Returns or sets the padding value for the left edge.

    Int32: Returns or sets the padding value for the right edge.

    Size: Returns the padding information in the form of a Size.

    Int32: Returns or sets the padding value for the top edge.

    Int32: Returns the combined padding for the top and bottom edges.

    Computes the sum of the two specified Padding values.

    Parameter
    Type
    Description

    p1

    A .

    p2

    Returns: Padding. A Padding that contains the sum of the two specified Padding values.

    Subtracts one specified Padding value from another.

    Parameter
    Type
    Description

    p1

    A .

    p2

    Returns: Padding. A Padding that contains the result of the subtraction of one specified Padding value from another.

    Name
    Description

    Returns or sets padding within the control.

    Returns or sets the space between controls.

    Public Structure Padding
        Implements ValueType, IWisejSerializable

    Constructors

    Padding(left, top, right, bottom)

    Padding
    public struct Padding : ValueType, IWisejSerializable

    Padding(all)

    Properties

    All

    Bottom

    Horizontal

    IsEmpty

    Left

    Right

    Size

    Top

    Vertical

    Methods

    Add(p1, p2)

    Subtract(p1, p2)

    Used By

    Configuration

    Wisej.Core.Configuration

    Namespace: Wisej.Core

    Assembly: Wisej.Framework (3.0.0.0)

    Wisej configuration settings.

    Creates a new instance from the specified json string.

    Name

    FileDialog

    Wisej.Web.FileDialog

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Page
    SplitContainer
    UserControl
    DataRepeater
    Desktop
    UserPopup
    IWisejControl
    Control
    IWisejSerializable
    event.
    Roots
    OpenFileDialog
    SaveFileDialog

    bottom

    Int32

    The padding size, in pixels, for the bottom edge.

    A Padding.

    A Padding.

    Returns or sets the space between the edge of a DataGridViewCell and its content.

    LabelWrapper.Padding

    Returns or sets the additional padding around the label. This property can be defined in the theme.

    UserPopup.Offset

    Returns or sets the offset in pixels from the calculated position of the popup.

    ListView.ItemPadding

    Returns or sets the padding inside ListViewItem objects in any View mode.

    StatusBarPanel.Padding

    Returns or sets padding within the statusbar panel.

    ToolBarButton.Padding

    Returns or sets padding within the toolbar button.

    ToolBarButton.Margin

    Returns or sets the space between toolbar buttons.

    Padding.Add

    Computes the sum of the two specified Padding values.

    ClientTheme.GetInsets

    Returns the size of the inset border and padding.

    Int32
    Int32
    Int32
    Int32
    Padding
    Padding
    Padding
    Padding
    Padding
    Padding
    Control.Padding
    Control.Margin
    DataGridViewCellStyle.Padding
    Type
    Description

    json

    The json string that defines the configuration values.

    String[]: List of allowed Url routes separated by a semicolon. i.e.: "api;product;log/performance".

    Boolean: When true, the application is automatically reloaded when the session expires or Exit is called.

    The application can always override this feature by changing the Wisej.onExit method using a script.

    String: The custom function used to validate the browser. If it returns false the browser is not supported and Wisej redirects to NotSupportedUrl.

    String: Returns the culture set at the application's level. It can be any of the supported cultures or the keyword "auto", in which case we will detect the culture from the browser.

    Boolean: Enabled/disables debug mode.

    Boolean: When true, the client will not be able to access the application's controls using the object model registered with javascript under the "App" namespace.

    Boolean: When true, the client drops all "execute" events triggered while there is a pending request.

    String: Cache-Control for embedded resources. The default is "browser" to cache the embedded resources on the browser for 1 month. Other allowed vaues are: - "server" to cache the resources on the server using the ETag header - "private, max-age=..." to use set the standard Cache-Control header - any value Cache-Control string value.

    Boolean: Enables the PWA installation of the application.

    Boolean: Enabled/disables the WebSocket protocol.

    Boolean: Enabled/disables gzip compression when using the WebSocket protocol.

    String: The full path of the configuration file.

    Boolean: Enables impersonation mode.

    When set to true and windows authentication is configured in web.config, every request thread and application tasks started using Application.StartTask will impersonate the current user.

    Int32: The keep-alive interval in seconds.

    Int32: The ajax loader timeout in milliseconds.

    String: Full name of the first window created automatically at startup.

    Int32: Returns the maximum number of nested modal loops.

    Int32: Returns the maximum number of active sessions before redirecting to NotAvailableUrl.

    Int32: Network check interval in milliseconds. The default is 1000 (1 second). If this value is set, Wisej will send a /healthcheck.wx request at the specified interval when the application goes offline.

    String: The URL of the page to load when the server cannot respond to the request.

    String: The URL of the page to load when the client browser is not supported.

    String: The URL of the page to load when the connection is lost.

    Object: Native client-side platform options.

    Int32: Polling interval in milliseconds. The default is zero (disabled). If this value is set, the polling starts when the application is loaded.

    The polling interval determines the frequency of the automatic poll requests coming from the client when a WebSocket connection is not available. When the client is connected using a WebSocket channel, this value is ignored. An application that wants to enable automatic client updates in absence of a WebSocket connection can set this value, or it can call StartPolling and EndPolling to start and terminate the automatic polling from the client. Both methods are ignored when the client is using a WebSocket connection.

    Int32: The timeout for the server to respond to a wisej request in seconds.

    String: Returns the rightToLeft mode. It can be "true", "false", or "auto". When set to "auto" the RightToLeft layout is enabled automatically using the current language. The default is "auto".

    Boolean: Forces the client to switch to a secure connection (HTTPS and WSS).

    String: Where to save the session id on the client. The default is "session" to indicate the browser's sessionStorage. It can be changed to "local" to indicate the browser's localStorage.

    Int32: The session timeout in seconds. The timeout is enforced on the client side.

    Object: Application settings.

    Boolean: Shows the loader animated gif while initializing the application.

    Boolean: Returns whether this Wisej application is running in a standalone host (Wisej.Application.exe).

    String: The startup Main method.

    String: Theme name.

    Object: ThreadPool min/max configuration, null by default.

    String: Url redirection.

    Boolean: Verifies the client fingerprint when retrieving a session. It prevents session hijacking over unsecured connections.

    Loads or retrieves the configuration file.

    Parameter
    Type
    Description

    filePath

    The full path to the .json file to load.

    Returns: Configuration.

    LoadConfigurationEventHandler Fired when the system needs to load a Wisej configuration file.

    An application can install a custom configuration handler and return a custom Configuration object. This is a static event and should be attached to before the application starts. One way to do that is to register an HttpModul with IIS, or a middleware for .NET Core, and attach to the event there.

    Public Class Configuration

    Constructors

    Configuration(json)

    public class Configuration
      <script>
        Wisej.onExit = function() {
          // this is the default implementation
          // when AutoReload is set to true.
          location.reload();
        }
      </script>
    [assembly: PreApplicationStartMethod(typeof(ApplicationNameSpace.HttpModuleStartup), "Start")]
    
    namespace ApplicationNameSpace
    {
      public static class HttpModuleStartup
      {
        public static void Start()
        {
          Wisej.Core.Configuration.LoadConfiguration += (s, e) =>
          {
            // load json from a file, or build a json object.
            // you can also implement your own caching mechanism here.
            
            e.SuppressCache = true;
            
            return new Wisej.Core.Configuration(new
            {
              url = "Default.html",
              theme = "bootstrap-4",
              startup = "ApplicationNameSpace.Program.Main, Application"
              
            }.ToJSON());
          }
        }
      }
    }

    Properties

    AllowedRoutes

    AutoReload

    BrowserCheck

    Culture

    Debug

    DisableClientObjectModel

    DropDuplicateClicks

    EmbeddedResourcesCacheControl

    EnablePWA

    EnableWebSocket

    EnableWebSocketCompression

    FilePath

    Impersonate

    KeepAliveInterval

    LoaderTimeout

    MainWindow

    MaxModalStack

    MaxSessions

    NetworkCheckInterval

    NotAvailableUrl

    NotSupportedUrl

    OfflineUrl

    Options

    PollingInterval

    ResponseTimeout

    RightToLeft

    Secure

    SessionStorage

    SessionTimeout

    Settings

    ShowLoader

    Standalone

    StartUp

    ThemeName

    ThreadPool

    Url

    ValidateClient

    Methods

    GetInstance(filePath)

    Events

    LoadConfiguration

    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.

    Initializes a new instance of FileDialog.

    Initializes a new instance of FileDialog using the initial roots .

    Name
    Type
    Description

    roots

    Initial file systems to load in the .

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

    Name
    Type
    Description

    container

    An that represents the container of the component.

    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.

    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.

    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.

    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.

    Resets all properties to their default values.

    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.

    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

    Constructors

    FileDialog()

    FileDialog(roots)

    FileDialog(container)

    Properties

    AddExtension

    CheckFileExists

    DefaultExtension

    FileName

    FileNames

    FileSystem

    Filter

    FilterIndex

    InitialDirectory

    Roots

    ShowHelp

    Title

    Methods

    GetRoot(path)

    MapPath(filePath)

    ProcessFileNames(fileNames)

    Reset()

    Events

    FileOk

    LoadPath

    Inherited By

    Control.ControlCollection

    Wisej.Web.Control ControlCollection

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Represents a collection of objects.

    Initializes a new instance of the class.

    OnFileOk
    IFileSystemProvider[]
    FolderBrowserDialog
    IContainer
    IContainer
    FileDialog
    String
    Roots
    String
    String[]
    OpenFileDialog
    SaveFileDialog
    String
    String
    Name
    Type
    Description

    owner

    The that owns this collection.

    Boolean: Returns whether the owner control has already been disposed.

    Control: Returns the Control at the specified indexed location.

    Control: Returns the Control with the specified key in the collection.

    Control: Returns the control that owns this ControlCollection.

    Adds the specified control to the control collection.

    Parameter
    Type
    Description

    child

    The to add.

    Adds an array of control objects to the collection.

    Parameter
    Type
    Description

    controls

    An array of objects to add to the collection.

    Removes all controls from the collection.

    Removes and disposes all controls from the collection.

    Parameter
    Type
    Description

    dispose

    Indicates whether the controls removed from the collection should be disposed.

    Determines whether the specified control is a member of the collection.

    Parameter
    Type
    Description

    control

    The to locate in the collection.

    Returns: Boolean. true if the Control is a member of the collection; otherwise, false.

    Determines whether the ControlCollection contains an item with the specified key.

    Parameter
    Type
    Description

    key

    The key to locate in the .

    Returns: Boolean. true if the ControlCollection contains an item with the specified key; otherwise, false.

    Searches for controls by their type and builds an array of all the controls that match.

    Parameter
    Type
    Description

    type

    The type of the controls to locate in the .

    searchAllChildren

    Returns: Control[]. Array of controls that are derived from the specified type .

    Throws:

    • ArgumentNullException type is null.

    Searches for controls by their name and builds an array of all the controls that match.

    Parameter
    Type
    Description

    key

    The key to located in the .

    searchAllChildren

    Returns: Control[]. Array of controls with the specified name.

    Throws:

    • ArgumentNullException The key parameter is null or an empty string ("").

    Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection.

    Parameter
    Type
    Description

    child

    The to search for in the control collection.

    throwException

    Returns: Int32. A zero-based index value that represents the location of the specified child control within the control collection; otherwise -1 if the specified Control is not found in the ControlCollection.

    Throws:

    • ArgumentException The child Control is not in the ControlCollection, and the throwException parameter value is true.

    Retrieves a reference to an enumerator object that is used to iterate over a ControlCollection.

    Returns: IEnumerator. An IEnumerator.

    Retrieves the index of the specified control in the control collection.

    Parameter
    Type
    Description

    control

    The to locate in the collection.

    Returns: Int32. A zero-based index value that represents the position of the specified Control in the ControlCollection.

    Retrieves the index of the first occurrence of the specified item within the collection.

    Parameter
    Type
    Description

    key

    The name of the control to search for.

    Returns: Int32. The zero-based index of the first occurrence of the control with the specified name in the collection.

    Removes the specified control from the control collection.

    Parameter
    Type
    Description

    child

    The to remove.

    Removes the child control with the specified key.

    Parameter
    Type
    Description

    key

    The name of the child control to remove.

    Sets the index of the specified child control in the collection.

    Parameter
    Type
    Description

    child

    The child control to search for.

    newIndex

    Name
    Description

    Represents a collection of child controls in a table layout container.

    Public Class ControlCollection
        Inherits ControlCollection
        Implements IList(Of Control), ICollection(Of Control), IEnumerable(Of Control), IWisejSynchronized

    Constructors

    ControlCollection(owner)

    Control
    ControlCollection
    public class ControlCollection : ControlCollection, IList<Control>, ICollection<Control>, IEnumerable<Control>, IWisejSynchronized

    Properties

    IsDisposed

    Item(index)

    Item(key)

    Owner

    Methods

    Add(child)

    AddRange(controls)

    Clear()

    Clear(dispose)

    Contains(control)

    ContainsKey(key)

    Find(type, searchAllChildren)

    Find(key, searchAllChildren)

    GetChildIndex(child, throwException)

    GetEnumerator()

    IndexOf(control)

    IndexOfKey(key)

    Remove(child)

    RemoveByKey(key)

    SetChildIndex(child, newIndex)

    Inherited By

    Clipboard

    Wisej.Web.Clipboard

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Provides methods to place data on and retrieve data from the system Clipboard. This class cannot be inherited.

    public class Clipboard
    Public Class Clipboard

    Methods

    Clear()

    Removes all data from the Clipboard.

    ContainsAudio()

    Indicates whether there is data on the Clipboard in the WaveAudio format.

    Returns: . true if there is audio data on the Clipboard; otherwise, false.

    Indicates whether there is data on the Clipboard that is in the specified format or can be converted to that format.

    Parameter
    Type
    Description

    Returns: . true if there is data on the Clipboard that is in the specified format or can be converted to that format; otherwise, false.

    Indicates whether there is data on the Clipboard that is in the format or can be converted to that format.

    Returns: . true if there is a file drop list on the Clipboard; otherwise, false.

    Indicates whether there is data on the Clipboard that is in the format or can be converted to that format.

    Returns: . true if there is image data on the Clipboard; otherwise, false.

    Indicates whether there is data on the Clipboard in the or format, depending on the operating system.

    Returns: . true if there is text data on the Clipboard; otherwise, false.

    Indicates whether there is text data on the Clipboard in the format indicated by the specified value.

    Parameter
    Type
    Description

    Returns: . true if there is text data on the Clipboard in the value specified for format ; otherwise, false.

    Retrieves an audio stream from the Clipboard.

    Returns: . A containing audio data or null if the Clipboard does not contain any data in the format.

    Retrieves data from the Clipboard in the specified format.

    Parameter
    Type
    Description

    Returns: . An representing the Clipboard data or null if the Clipboard does not contain any data that is in the specified format or can be converted to that format.

    Retrieves the data that is currently on the system Clipboard.

    Returns: . An that represents the data currently on the Clipboard, or null if there is no data on the Clipboard.

    Retrieves a collection of file names from the Clipboard.

    Returns: . A containing file names or null if the Clipboard does not contain any data that is in the format or can be converted to that format.

    Retrieves an image from the Clipboard.

    Returns: . An representing the Clipboard image data or null if the Clipboard does not contain any data that is in the format or can be converted to that format.

    Retrieves text data from the Clipboard in the or format, depending on the operating system.

    Returns: . The Clipboard text data or if the Clipboard does not contain data in the or format, depending on the operating system.

    Retrieves text data from the Clipboard in the format indicated by the specified value.

    Parameter
    Type
    Description

    Returns: . The Clipboard text data or if the Clipboard does not contain data in the specified format.

    Saves the array in the format after converting it to a to the clipboard.

    Parameter
    Type
    Description

    Throws:

    • audioBytes is null.

    Saves the in the format to the clipboard.

    Parameter
    Type
    Description

    Throws:

    • audioStream is null.

    Saves the text data to the client's temporary clipboard. Client side javascript code can copy the clipboard's content to the browser's clipboard calling Wisej.Core.copy();

    Parameter
    Type
    Description

    Throws:

    • text is null.

    Saves the specified data to the clipboard in the specified format.

    Parameter
    Type
    Description

    Throws:

    • data is null.

    Saves the specified data to the clipboard.

    Parameter
    Type
    Description

    Throws:

    • The value of data is null.

    Saves the collection of file names in the format to the clipboard.

    Parameter
    Type
    Description

    Throws:

    • filePaths is null.

    • filePaths does not contain any strings, or at least one of the strings in filePaths is empty, contains only white space, contains one or more invalid characters as defined by , is null, contains a colon (:), or exceeds the system-defined maximum length. See the property of the for more information.

    Saves the in the format to the clipboard

    Parameter
    Type
    Description

    Throws:

    • image is null.

    Saves the text data in the format to the clipboard.

    Parameter
    Type
    Description

    Throws:

    • text is null or .

    Saves the text data in the format indicated by the specified value to the clipboard.

    Parameter
    Type
    Description

    Throws:

    • text is null.

    Accordion

    Wisej.Web.Accordion

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

      • Accordion

    Displays collapsible set of panels for presenting information in a limited amount of space.

    Initializes a new instance of the class.

    : Returns or sets the type of border that is drawn around the panel.

    : Returns or sets a value indicating whether the Accordion control collapses when all the children are collapsed.

    When this property is set to false (default) one panel is always expanded.

    : Returns the rectangle that represents the virtual display area of the control.

    : Returns or sets the size of the header. When the header is horizontal, the size if the height; when it's vertical, the size if the width. Set it to -1 to reset to the size set in the current theme.

    : Returns or sets the images to display on the panel's title bar.

    : Returns the number of panels in the container.

    : Returns the collection of panels in the container.

    : Returns or sets the index of the currently selected panel.

    Throws:

    • The value is less than -1.

    : Returns or sets a value indicating whether the selected panel is moved to the top of the container.

    : Returns or sets the currently selected panel.

    : Returns or sets whether a panel's ToolTip is shown when the mouse passes over the panel's title.

    Makes the following the with the specified index the current panel.

    Parameter
    Type
    Description

    Throws:

    • index is less than 0 or greater than the number of controls in the collection minus 1.

    Makes the following the specified the current panel.

    Parameter
    Type
    Description

    Throws:

    • panel is null.

    Makes the following the the specified name the current panel.

    Parameter
    Type
    Description

    Throws:

    • panelName is null; or panelName does not match the property of any in the collection.

    Returns the panel at the specified location.

    Parameter
    Type
    Description

    Returns: . The at the specified location.

    Throws:

    • index is less than 0 or greater than the number of controls in the collection minus 1.

    Makes the with the specified index the current .

    Parameter
    Type
    Description

    Throws:

    • index is less than 0 or greater than the number of controls in the collection minus 1.

    Makes the specified the current .

    Parameter
    Type
    Description

    Throws:

    • panel is null.

    Makes with the specified name the current .

    Parameter
    Type
    Description

    Throws:

    • panelName is null; or panelName does not match the property of any in the collection.

    Fired when a panel is deselected.

    Occurs before a panel is deselected, enabling a handler to cancel the panel change.

    Fired when a panel is selected.

    Fired when the property has changed.

    Occurs before a panel is selected, enabling a handler to cancel the panel change.

    Name
    Description

    true to search all child controls; otherwise, false.

    true to search all child controls; otherwise, false.

    true to throw an exception if the Control specified in the child parameter is not a control in the ControlCollection; otherwise, false.

    The new index value of the control.

    Control
    Control
    Control
    Control
    Control[]
    Control
    Boolean
    Control
    Control
    String
    ControlCollection
    Type
    ControlCollection
    Boolean
    String
    ControlCollection
    Boolean
    Control
    Control
    Boolean
    Control
    Control
    String
    Control
    Control
    String
    Control
    Int32
    TableLayoutControlCollection

    format

    String

    The format of the data to look for. See DataFormats for predefined formats.

    format

    TextDataFormat

    One of the TextDataFormat values.

    format

    String

    The format of the data to retrieve. See DataFormats for predefined formats.

    format

    TextDataFormat

    One of the TextDataFormat values.

    audioBytes

    Byte[]

    A Byte array containing the audio data.

    audioStream

    Stream

    A Stream containing the audio data.

    text

    String

    The text to save to the client's temporary clipboard.

    format

    String

    The format of the data to set. See DataFormats for predefined formats.

    data

    Object

    data

    Object

    The data to place on the Clipboard.

    filePaths

    StringCollection

    A StringCollection containing the file names.

    image

    Image

    The Image to add to the Clipboard.

    text

    String

    The text to add to the Clipboard.

    text

    String

    The text to add to the Clipboard.

    format

    TextDataFormat

    ContainsData(format)

    ContainsFileDropList()

    ContainsImage()

    ContainsText()

    ContainsText(format)

    GetAudioStream()

    GetData(format)

    GetDataObject()

    GetFileDropList()

    GetImage()

    GetText()

    GetText(format)

    SetAudio(audioBytes)

    SetAudio(audioStream)

    SetClientText(text)

    SetData(format, data)

    SetDataObject(data)

    SetFileDropList(filePaths)

    SetImage(image)

    SetText(text)

    SetText(text, format)

    Boolean
    Boolean
    FileDrop
    Boolean
    Bitmap
    Boolean
    Text
    UnicodeText
    Boolean
    TextDataFormat
    Boolean
    Stream
    Stream
    WaveAudio
    Object
    Object
    IDataObject
    IDataObject
    StringCollection
    StringCollection
    FileDrop
    Image
    Image
    Bitmap
    Text
    UnicodeText
    String
    Empty
    Text
    UnicodeText
    TextDataFormat
    String
    Empty
    Byte
    WaveAudio
    Stream
    ArgumentNullException
    Stream
    WaveAudio
    ArgumentNullException
    ArgumentNullException
    ArgumentNullException
    ArgumentNullException
    FileDrop
    ArgumentNullException
    ArgumentException
    InvalidPathChars
    InnerException
    ArgumentException
    Image
    Bitmap
    ArgumentNullException
    UnicodeText
    ArgumentNullException
    Empty
    TextDataFormat
    ArgumentNullException

    An representing the data to add.

    One of the values.

    Allows an object to serialize itself.

    index

    Int32

    The index in the Panels collection of the AccordionPanel to deselect.

    panel

    AccordionPanel

    The AccordionPanel to deselect.

    panelName

    String

    The Name of the panel to deselect.

    index

    Int32

    The index of the AccordionPanel to get.

    index

    Int32

    The index in the Panels collection of the tab to select.

    panel

    AccordionPanel

    The AccordionPanel to select.

    panelName

    String

    The Name of the tab to select.

    IBindableComponent

    Bindable components implement this interface.

    IWisejComponent

    All wisej components implement this interface.

    IWisejControl

    Public Class Accordion
        Inherits Control
        Implements ISupportInitialize

    Constructors

    Accordion()

    Properties

    BorderStyle

    Collapsible

    DisplayRectangle

    HeaderSize

    ImageList

    PanelCount

    Panels

    SelectedIndex

    SelectedOnTop

    SelectedPanel

    ShowToolTips

    Methods

    DeselectPanel(index)

    DeselectPanel(panel)

    DeselectPanel(panelName)

    GetControl(index)

    SelectPanel(index)

    SelectPanel(panel)

    SelectPanel(panelName)

    Events

    Deselected

    Deselecting

    Selected

    SelectedIndexChanged

    Selecting

    Implements

    AccordionPanel
    Accordion
    BorderStyle
    Accordion
    Boolean
    AccordionPanel
    Rectangle
    Int32
    ImageList
    Int32
    PanelCollection
    Int32
    ArgumentOutOfRangeException
    Boolean
    Accordion
    AccordionPanel
    Boolean
    AccordionPanel
    AccordionPanel
    ArgumentOutOfRangeException
    AccordionPanel
    Panels
    AccordionPanel
    AccordionPanel
    ArgumentNullException
    AccordionPanel
    AccordionPanel
    ArgumentNullException
    Name
    AccordionPanel
    Panels
    AccordionPanel
    Control
    AccordionPanel
    ArgumentOutOfRangeException
    AccordionPanel
    Panels
    AccordionPanel
    AccordionPanel
    ArgumentOutOfRangeException
    AccordionPanel
    Panels
    AccordionPanel
    AccordionPanel
    ArgumentNullException
    AccordionPanel
    AccordionPanel
    ArgumentNullException
    Name
    AccordionPanel
    Panels
    AccordionEventHandler
    AccordionCancelEventHandler
    AccordionEventHandler
    EventHandler
    SelectedIndex
    AccordionCancelEventHandler
    public class Accordion : Control, ISupportInitialize

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

    Object
    TextDataFormat
    Control
    IWisejSerializable

    ClientTheme

    Wisej.Core.ClientTheme

    Namespace: Wisej.Core

    Assembly: Wisej.Framework (3.0.0.0)

    Represents a Wisej theme.

    public class ClientTheme : IWisejSerializable
    Public Class ClientTheme
        Inherits IWisejSerializable

    You can create a new custom theme based on an existing theme, empty, or initialized from a JSON string.

    // create a new custom theme cloned from the current theme.
    var myTheme1 = new ClientTheme("MyTheme1", Application.Theme);
    
    // create a new custom theme from a JSON string.
    var myTheme2 = new ClientTheme("MyTheme2", json);

    You can alter any aspect of a theme by using the dynamic properties: Colors, Images, Fonts, Appearances, Settings, and . These properties, being dynamic, can support any field and any structure. To alter these properties in a way that doesn't break the theme, look at the theme's structure in the ThemeBuilder or a text editor. To save a custom theme you may convert it to a JSON string simply by calling the extension method added to all objects by the Wisej framework.

    Default private constructor.

    Name
    Type
    Description

    Constructs a new theme from the name and JSON definition.

    Name
    Type
    Description

    Constructs a new theme from the base theme.

    Name
    Type
    Description

    : Theme appearances.

    This is a complex dynamic object with several child objects. The structure can get quite complicated. Before messing with the Appearances object, please study the structure of the themes using the ThemeBuilder or a text editor. Being a dynamic object, you can either create a new appearance or alter an existing appearance at any level.

    : Theme colors.

    You can add or change any color in the current theme:

    : Theme fonts.

    You can add or alter any font to the theme. The structure of the font definition can get complicated. Please refer to the existing themes and the ThemeBuilder to determine the structure to use. The simplest way is to change an existing theme font:

    : Theme images.

    You can add or change any theme image. Images in the theme are just URLs but can be defined in several ways:

    • Absolute URL An URL starting with http: or https: pointing to an image resource.

    • Relative URL An URL relative to the current site or relative to value of Images.baseUrl.

    • base64 A base64 encoded embedded image.

    : The name of the theme.

    : Theme settings.

    The Settings property, added in Wisej 2, allows a theme to define certain internal properties. Currently these are the supported properties:

    • native-scrollbars Instructs Wisej to use the native scrollbars instead of the themed scrollbars. Setting this property can have negative side effects for virtual scrolling widgets like the DataGridView. The default is false.

    • overlapped-scrollbars Instructs Wisej to layout the scrollbars over the content being scrolled, similar to Windows' fluent themes or mobiles. The default is false.

    : Stylesheet rules embedded in the theme.

    The Stylesheet property is a new theme property added since Wisej 2.0. It allows a theme to define a set of CSS rules, just as if Default.html specified a css file. This property has only one string array field: "rules". When the theme is rendered, the client library joins all the rules into a css string and creates a stylesheet loaded into the browser.

    Returns the resolved color defined in the theme for the specified appearance, property or style name and optionally the state.

    Parameter
    Type
    Description

    Returns: . A representing the color in the theme.

    Returns the resolved theme color from the color list.

    Parameter
    Type
    Description

    Returns: . A representing the color in the theme.

    Returns the resolved font defined in the theme for the specified appearance, property name and optionally the state.

    Parameter
    Type
    Description

    Returns: . A representing the queried font or null if not found.

    Returns the resolved font defined from the font list.

    Parameter
    Type
    Description

    Returns: . A representing the queried font or null if not found.

    Returns the resolved image defined in the theme for the specified appearance, property or style name and optionally the state.

    Parameter
    Type
    Description

    Returns: . A representing the queried image or null if not found. SVG images at runtime always return null, they are resolved only at design time.

    Returns the resolved image defined from the image list.

    Parameter
    Type
    Description

    Returns: . A representing the queried image or null if not found. SVG images at runtime always return null, they are resolved only at design time.

    Returns the size of the inset border and padding.

    Parameter
    Type
    Description

    Returns: . Dimension of the border and optionally the padding as a value

    Returns the property value for the specified name and state within the specified appearance key.

    Parameter
    Type
    Description

    Returns: . The typed value of the requested property, or default(T) if not found.

    Returns the style value for the specified name and state within the specified appearance key.

    Parameter
    Type
    Description

    Returns: . The typed value of the requested style, or default(T) if not found.

    Returns true if the color is a theme color.

    Parameter
    Type
    Description

    Returns: . True if color is a theme color.

    Since the theme may also define , using on a system color returns false, but the rendering on the browser will use the color in the theme, if defined.

    Returns true if the font is a theme font.

    Parameter
    Type
    Description

    Returns: . True if font is a theme font.

    Theme fonts (font's with the starting with "@") are always rendered using the definition in the theme for their size and style. However, an application may use a theme font and change the size and style. In this case, the is the theme name without the "@". If the name of the font (which could be a system name like "Arial") matches a theme font, Wisej will use the theme font but it uses the size and style set by the application.

    Returns the resolved with the proper RGB values. If the color specified in color is a theme color, the value is resolved from the current theme, otherwise the original color is returned.

    Parameter
    Type
    Description

    Returns: . A instance with the resolved RGB values.

    Returns the resolved from the theme font. If the font is a theme font, the value is resolved from current theme.

    Parameter
    Type
    Description

    Returns: . A instance that can be used directly.

    Name
    Description

    state

    The name of the state to query. It's optional. The default is "default".

    state

    The name of the state to query. It's optional. The default is "default".

    state

    The name of the state to query. It's optional. The default is "default".

    includePadding

    Whether to include padding in the insets dimension.

    name

    The name of the property to retrieve.

    state

    The state that defines the property. It can omitted, the default state is "default".

    name

    The name of the property to retrieve.

    state

    The state that defines the property. It can omitted, the default state is "default".

    name

    String

    Unique name of the theme.

    name

    String

    Unique name of the theme.

    json

    String

    name

    String

    Unique name of the theme.

    baseTheme

    ClientTheme

    // alter the border of buttons.
    // note that when there is a keyword clash you can use the @ prefix.
    Application.Theme.Appearances.button.states.@default.styles.width = 3;
    Application.Theme.Appearances.button.states.@default.styles.radius = 0;
    
    // additionally, you my use a string indexer to reach any property.
    Application.Theme.Appearances.button.states["default"].styles.radius = 0;
    
    // change existing color.
    Application.Theme.Colors.buttonFace = "red";
    
    // create a new color.
    Application.Theme.Colors.myCoolColor = "rgba(5,23,55,0.9)";
    
    // since the theme objects are all dynamic and use a special DynamicObject
    // class part of the Wisej Framework, you can also use a string indexer
    // to address any field.
    Application.Theme.Colors["buttonFace"] = "red";
    
    
    // make the window title bigger and bold.
    Application.Theme.Fonts.windowTitle.size = 18;
    Application.Theme.Fonts.windowTitle.bold = true;
    
    
    // create a custom css rules in the theme.
    Application.Theme.Stylesheet.rules = new []{
    
      "body: { background-color: red };",
      ".myClass: { background-color: red };"
    };
    

    appearance

    String

    The appearance path that identifies the component in the theme. Nested appearances can be specified using a forward slash: i.e. window/captionbar.

    name

    String

    name

    String

    The name of the color to resolve from the color list.

    appearance

    String

    The appearance path that identifies the component in the theme. Nested appearances can be specified using a forward slash: i.e. window/captionbar.

    name

    String

    name

    String

    appearance

    String

    The appearance path that identifies the component in the theme. Nested appearances can be specified using a forward slash: i.e. window/captionbar.

    name

    String

    name

    String

    appearance

    String

    The name of the appearance in the theme. Child component appearances can be specified using the forward slash, i.e. "button/icon".

    state

    String

    T

    The Type of the value to retrieve.

    appearance

    String

    T

    The Type of the value to retrieve.

    appearance

    String

    color

    Color

    Color to check.

    font

    Font

    Font to check.

    color

    Color

    The Color to resolve to a usable value.

    font

    Font

    The Font to resolve to a usable instance.

    IWisejSerializable

    Allows an object to serialize itself.

    Constructors

    ClientTheme(name)

    ClientTheme(name, json)

    ClientTheme(name, baseTheme)

    Properties

    Appearances

    Colors

    Fonts

    Images

    Name

    Settings

    Stylesheet

    Methods

    GetColor(appearance, name, state)

    GetColor(name)

    GetFont(appearance, name, state)

    GetFont(name)

    GetImage(appearance, name, state)

    GetImage(name)

    GetInsets(appearance, state, includePadding)

    GetProperty<T>(appearance, name, state)

    GetStyle<T>(appearance, name, state)

    IsThemeColor(color)

    IsThemeFont(font)

    TranslateColor(color)

    TranslateFont(font)

    Implements

    Stylesheet
    ToJSON
    Object
    Object
    Object
    Object
    String
    Object
    Object
    Color
    Color
    Color
    Color
    Font
    Font
    Font
    Font
    Image
    Image
    Image
    Image
    Padding
    Padding
    T
    T
    Boolean
    SystemColors
    IsThemeColor
    Boolean
    OriginalFontName
    OriginalFontName
    Color
    Color
    Color
    Font
    Font
    Font

    JSON definition of the theme.

    Original theme to copy into the new theme.

    The name of the property or the style value to query.

    The name of the property value to query.

    The name of the property or the style value to query.

    The state that defines the property. It can omitted, the default state is "default".

    The name of the appearance in the theme. Child component appearances can be specified using the forward slash, i.e. "button/icon".

    The name of the appearance in the theme. Child component appearances can be specified using the forward slash, i.e. "button/icon".

    Accordion.PanelCollection

    Wisej.Web.Accordion PanelCollection

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Contains a collection of AccordionPanel objects.

    public class PanelCollection : IList,
    Public Class PanelCollection
        Inherits IList
        Implements ICollection, IEnumerable, IList(Of AccordionPanel), ICollection(Of AccordionPanel), IEnumerable(Of AccordionPanel)

    Properties

    Count

    Int32: Returns the number of panels in the collection.

    Item(index)

    AccordionPanel: Returns or sets a AccordionPanel in the collection at the specified index.

    Throws:

    • index is less than zero or greater than the highest available index.

    • value is null.

    : Returns the with the specified key from the collection.

    Adds a to the collection.

    Parameter
    Type
    Description

    Throws:

    • The specified panel is null.

    Creates a with the specified text, and adds it to the collection.

    Parameter
    Type
    Description

    Creates a with the specified key and text and adds it to the collection.

    Parameter
    Type
    Description

    Creates a with the specified key, text, and image, and adds it to the collection.

    Parameter
    Type
    Description

    Creates a with the specified key, text, and image, and adds it to the collection.

    Parameter
    Type
    Description

    Adds a set of panels to the collection.

    Parameter
    Type
    Description

    Throws:

    • The value of panels is null.

    Removes all the panels from the collection.

    Removes and disposes all panels from the collection.

    Parameter
    Type
    Description

    Determines whether a specified is in the collection.

    Parameter
    Type
    Description

    Returns: . true if the specified is in the collection; otherwise, false.

    Throws:

    • The value of panel is null.

    Determines whether the collection contains a with the specified key.

    Parameter
    Type
    Description

    Returns: . true to indicate a with the specified key was found in the collection; otherwise, false.

    Copies the panels in the collection to the specified array, starting at the specified index.

    Parameter
    Type
    Description

    Throws:

    • array is null.

    • array is less than zero.

    • array is multidimensional or the number of elements in the is greater than the available space from index to the end of array .

    Returns the index of the in the collection.

    Parameter
    Type
    Description

    Returns: . The zero-based index of the panel; -1 if it cannot be found.

    Throws:

    • The value of panel is null.

    Returns the index of the first occurrence of the with the specified key.

    Parameter
    Type
    Description

    Returns: . The zero-based index of the first occurrence of a with the specified key, if found; otherwise, -1.

    Inserts an existing into the collection at the specified index.

    Parameter
    Type
    Description

    Creates a new with the specified text and inserts it into the collection at the specified index.

    Parameter
    Type
    Description

    Creates a new with the specified key and text, and inserts it into the collection at the specified index.

    Parameter
    Type
    Description

    Creates a new with the specified key, text, and image, and inserts it into the collection at the specified index.

    Parameter
    Type
    Description

    Creates a with the specified key, text, and image, and inserts it into the collection at the specified index.

    Parameter
    Type
    Description

    Removes the from the collection.

    Parameter
    Type
    Description

    Throws:

    • The panel parameter is null.

    Removes the at the specified index from the collection.

    Parameter
    Type
    Description

    Removes the with the specified key from the collection.

    Parameter
    Type
    Description
    String
    String
    String
    Boolean
    String
    String
    String
    String

    imageIndex

    The index of the image to display on the title of the .

    imageKey

    The key of the image to display on the title of the .

    text

    The text to display on the .

    text

    The text to display on the .

    imageIndex

    The zero-based index of the image to display on the .

    text

    The text to display on the .

    imageKey

    The key of the image to display on the .

    ICollection
    ,
    IEnumerable
    ,
    IList
    <
    AccordionPanel
    >,
    ICollection
    <
    AccordionPanel
    >,
    IEnumerable
    <
    AccordionPanel
    >

    panel

    AccordionPanel

    The AccordionPanel to add.

    text

    String

    The text to display on the panel.

    key

    String

    The name of the AccordionPanel.

    text

    String

    key

    String

    The name of the AccordionPanel.

    text

    String

    key

    String

    The name of the AccordionPanel.

    text

    String

    panels

    AccordionPanel[]

    An array of type AccordionPanel that contains the panels to add.

    dispose

    Boolean

    Indicates whether to dispose the AccordionPanel panels removed from the collection.

    panel

    AccordionPanel

    The AccordionPanel to locate in the collection.

    key

    String

    The name of the AccordionPanel to search for.

    array

    AccordionPanel[]

    The one-dimensional array that is the destination of the AccordionPanel panels copied from the collection. The array must have zero-based indexing.

    index

    Int32

    panel

    AccordionPanel

    The AccordionPanel to locate in the collection.

    key

    String

    The name of the AccordionPanel to find in the collection.

    index

    Int32

    The zero-based index location where the AccordionPanel is inserted.

    panel

    AccordionPanel

    index

    Int32

    The zero-based index location where the AccordionPanel is inserted.

    text

    String

    index

    Int32

    The zero-based index location where the AccordionPanel is inserted.

    key

    String

    index

    Int32

    The zero-based index location where the AccordionPanel is inserted

    key

    String

    index

    Int32

    The zero-based index location where the AccordionPanel is inserted.

    key

    String

    panel

    AccordionPanel

    The AccordionPanel to remove.

    index

    Int32

    The zero-based index of the AccordionPanel to remove.

    key

    String

    The name of the AccordionPanel to remove.

    Item(name)

    Methods

    Add(panel)

    Add(text)

    Add(key, text)

    Add(key, text, imageIndex)

    Add(key, text, imageKey)

    AddRange(panels)

    Clear()

    Clear(dispose)

    Contains(panel)

    ContainsKey(key)

    CopyTo(array, index)

    IndexOf(panel)

    IndexOfKey(key)

    Insert(index, panel)

    Insert(index, text)

    Insert(index, key, text)

    Insert(index, key, text, imageIndex)

    Insert(index, key, text, imageKey)

    Remove(panel)

    RemoveAt(index)

    RemoveByKey(key)

    ArgumentOutOfRangeException
    ArgumentNullException
    AccordionPanel
    AccordionPanel
    AccordionPanel
    ArgumentNullException
    AccordionPanel
    AccordionPanel
    AccordionPanel
    AccordionPanel
    AccordionPanel
    ArgumentNullException
    AccordionPanel
    AccordionPanel
    AccordionPanel
    Boolean
    AccordionPanel
    ArgumentNullException
    AccordionPanel
    Boolean
    AccordionPanel
    AccordionPanel
    ArgumentNullException
    ArgumentOutOfRangeException
    ArgumentException
    Panels
    AccordionPanel
    Int32
    ArgumentNullException
    AccordionPanel
    Int32
    AccordionPanel
    AccordionPanel
    AccordionPanel
    AccordionPanel
    AccordionPanel
    AccordionPanel
    AccordionPanel
    ArgumentNullException
    AccordionPanel
    AccordionPanel

    The text to display on the title of .

    The text to display on the .

    The text to display on the .

    The zero-based index in the array at which copying begins.

    The to insert in the collection.

    The text to display in the .

    The name of the .

    The name of the .

    The name of the .

    AccordionPanel
    AccordionPanel
    Int32
    AccordionPanel
    AccordionPanel
    String
    AccordionPanel
    AccordionPanel
    AccordionPanel
    AccordionPanel
    String
    AccordionPanel
    AccordionPanel
    String
    AccordionPanel
    Int32
    AccordionPanel
    AccordionPanel
    String
    AccordionPanel
    String
    AccordionPanel

    DataObject

    Wisej.Web.DataObject

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Implements a basic data transfer mechanism.

    public class DataObject : IDataObject
    Public Class DataObject
        Inherits IDataObject

    Constructors

    DataObject()

    Initializes a new instance of the DataObject class.

    DataObject(data)

    Initializes a new instance of the DataObject class and adds the specified object to it.

    Name
    Type
    Description

    Initializes a new instance of the class and adds the specified object in the specified format.

    Name
    Type
    Description

    Initializes a new instance of the class and adds the specified object in the specified format.

    Name
    Type
    Description

    Indicates whether the data object contains data in the format.

    Returns: . true if the data object contains audio data; otherwise, false.

    Indicates whether the data object contains data that is in the format or can be converted to that format.

    Returns: . true if the data object contains a file drop list; otherwise, false.

    Indicates whether the data object contains data that is in the format or can be converted to that format.

    Returns: . true if the data object contains image data; otherwise, false.

    Indicates whether the data object contains data in the format.

    Returns: . true if the data object contains text data; otherwise, false.

    Indicates whether the data object contains text data in the format indicated by the specified value.

    Parameter
    Type
    Description

    Returns: . true if the data object contains text data in the specified format; otherwise, false.

    Retrieves an audio stream from the data object.

    Returns: . A containing audio data or null if the data object does not contain any data in the format.

    Returns the data associated with the specified class type format.

    Parameter
    Type
    Description

    Returns: . The data associated with the specified format, or null.

    Returns the data associated with the specified data format.

    Parameter
    Type
    Description

    Returns: . The data associated with the specified format, or null.

    Returns the data associated with the specified data format, using an automated conversion parameter to determine whether to convert the data to the format.

    Parameter
    Type
    Description

    Returns: . The data associated with the specified format, or null.

    Determines whether data stored in this is associated with, or can be converted to, the specified format.

    Parameter
    Type
    Description

    Returns: . true if data stored in this is associated with, or can be converted to, the specified format; otherwise, false.

    Returns the data associated with the specified class type format.

    Parameter
    Type
    Description

    Returns: . The data associated with the specified format, or null.

    Determines whether this contains data in the specified format or, optionally, contains data that can be converted to the specified format.

    Parameter
    Type
    Description

    Returns: . true if the data is in, or can be converted to, the specified format; otherwise, false.

    Returns the list of file types from the data object.

    Returns: . A string array containing the file types in the data object.

    Returns the of files uploaded by the client in a drag & drop operation.

    Returns: . A string array containing the file types in the data object.

    Returns a list of all formats that data stored in this is associated with or can be converted to.

    Returns: . An array of type , containing a list of all formats that are supported by the data stored in this object.

    Returns a list of all formats that data stored in this is associated with or can be converted to, using an automatic conversion parameter to determine whether to retrieve only native data formats or all formats that the data can be converted to.

    Parameter
    Type
    Description

    Returns: . An array of type , containing a list of all formats that are supported by the data stored in this object.

    Retrieves an image from the data object.

    Returns: . An representing the image data in the data object or null if the data object does not contain any data that is in the format or can be converted to that format.

    Retrieves text data from the data object in the format.

    Returns: . The text data in the data object or if the data object does not contain data in the format.

    Retrieves text data from the data object in the format indicated by the specified value.

    Parameter
    Type
    Description

    Returns: . The text data in the data object or if the data object does not contain data in the specified format.

    Adds a array to the data object in the format after converting it to a .

    Parameter
    Type
    Description

    Throws:

    • audioBytes is null.

    Adds a to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • audioStream is null.

    Adds the specified object to the using the object type as the data format.

    Parameter
    Type
    Description

    Adds the specified object to the using the specified type as the format.

    Parameter
    Type
    Description

    Adds the specified object to the using the specified format.

    Parameter
    Type
    Description

    Adds the specified object to the using the specified format and indicating whether the data can be converted to another format.

    Parameter
    Type
    Description

    Adds a url using format. The specified url is parsed to compose the DownloadURL as: "mime-type:file-name:url".

    Parameter
    Type
    Description

    Adds a collection of file names to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • filePaths is null.

    Adds a collection of file names to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • filePaths is null.

    Adds an to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • image is null.

    Adds text data to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • textData is null or .

    Adds text data to the data object in the format indicated by the specified value.

    Parameter
    Type
    Description

    Throws:

    • textData is null or .

    Name
    Description

    data

    The data to store.

    data

    Object

    The data to store.

    format

    String

    The format of the specified data. See DataFormats for predefined formats.

    data

    Object

    format

    Type

    A Type representing the format of the data.

    data

    Object

    format

    TextDataFormat

    One of the TextDataFormat values.

    format

    Type

    A Type representing the format of the data to retrieve.

    format

    String

    The format of the data to retrieve. See DataFormats for predefined formats.

    format

    String

    The format of the data to retrieve. See DataFormats for predefined formats.

    autoConvert

    Boolean

    format

    Type

    A Type representing the format to check for.

    format

    String

    A Type representing the format of the data to retrieve.

    format

    String

    The format to check for. See DataFormats for predefined formats.

    autoConvert

    Boolean

    autoConvert

    Boolean

    true to retrieve all formats that data stored in this DataObject is associated with, or can be converted to; false to retrieve only native data formats.

    format

    TextDataFormat

    One of the TextDataFormat values.

    audioBytes

    Byte[]

    A Byte array containing the audio data.

    audioStream

    Stream

    A Stream containing the audio data.

    data

    Object

    The data to store.

    format

    Type

    A Type representing the format associated with the data.

    data

    Object

    format

    String

    The format associated with the data. See DataFormats for predefined formats.

    data

    Object

    format

    String

    The format associated with the data. See DataFormats for predefined formats.

    autoConvert

    Boolean

    url

    String

    The url to the file to download.

    fileName

    String

    filePaths

    StringCollection

    A StringCollection containing the file names.

    filePaths

    String[]

    A StringCollection containing the file names.

    image

    Image

    The Image to add to the data object.

    textData

    String

    The text to add to the data object.

    textData

    String

    The text to add to the data object.

    format

    TextDataFormat

    IDataObject

    Provides a format-independent mechanism for transferring data.

    DataObject(format, data)

    DataObject(format, data)

    Methods

    ContainsAudio()

    ContainsFileDropList()

    ContainsImage()

    ContainsText()

    ContainsText(format)

    GetAudioStream()

    GetData(format)

    GetData(format)

    GetData(format, autoConvert)

    GetDataPresent(format)

    GetDataPresent(format)

    GetDataPresent(format, autoConvert)

    GetFileDropList()

    GetFiles()

    GetFormats()

    GetFormats(autoConvert)

    GetImage()

    GetText()

    GetText(format)

    SetAudio(audioBytes)

    SetAudio(audioStream)

    SetData(data)

    SetData(format, data)

    SetData(format, data)

    SetData(format, autoConvert, data)

    SetDownloadURL(url, fileName)

    SetFileDropList(filePaths)

    SetFileDropList(filePaths)

    SetImage(image)

    SetText(textData)

    SetText(textData, format)

    Implements

    DataObject
    DataObject
    WaveAudio
    Boolean
    FileDrop
    Boolean
    Bitmap
    Boolean
    UnicodeText
    Boolean
    TextDataFormat
    Boolean
    Stream
    Stream
    WaveAudio
    Object
    Object
    Object
    DataObject
    Boolean
    DataObject
    Boolean
    DataObject
    Boolean
    String[]
    HttpFileCollection
    HttpFileCollection
    DataObject
    String[]
    String
    DataObject
    String[]
    String
    Image
    Image
    Bitmap
    UnicodeText
    String
    Empty
    UnicodeText
    TextDataFormat
    String
    Empty
    Byte
    WaveAudio
    Stream
    ArgumentNullException
    Stream
    WaveAudio
    ArgumentNullException
    DataObject
    DataObject
    DataObject
    DataObject
    DownloadURL
    FileDrop
    ArgumentNullException
    FileDrop
    ArgumentNullException
    Image
    Bitmap
    ArgumentNullException
    UnicodeText
    ArgumentNullException
    Empty
    TextDataFormat
    ArgumentNullException
    Empty

    The data to store.

    The data to store.

    true to the convert data to the specified format; otherwise, false.

    true to determine whether data stored in this can be converted to the specified format; false to check whether the data is in the specified format.

    The data to store.

    The data to store.

    true to allow the data to be converted to another format; otherwise, false.

    The name of the file to download from the url.

    One of the values.

    DataObject
    Object
    TextDataFormat

    Application

    Wisej.Web.Application

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Represent a Wisej application session. Provides methods and events to manage the application in the context of the current session.

    public class Application : IWisejComponent,
    Public Class Application
        Inherits IWisejComponent
        Implements IDisposable, IWisejSynchronized, IServiceProvider

    This class provides several static methods, properties and events that allow the application to manage all sorts of features related to the current session:

    • Save and retrieve session variable. Use to store and retrieve session variable. The property is a dynamic object and a , therefore you can access its properties directly or through the indexer.

    • Manage cookies. Use to manage browser's cookies.

    • Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.

    • Read the application's URL. Use , , , and

    There is a lot more exposed by the class. You can inspect all the properties and methods in Visual Studio through IntelliSense or online at .

    : Returns or sets the current client responsive profile.

    This is the profile that best matches the current browser on the client. It is updated automatically on every request.

    : Returns or sets the client browser information.

    : Returns the current unique client id.

    : Returns a collection of all the unique client browsers using the application.

    : Returns the path for the application data that is shared among all users.

    : Returns the registry key for the application data that is shared among all users.

    : Returns the company name associated with the application stored in the .

    : Returns the current .

    : Collection of cookies.

    : Returns the application component instance that an application can store and use later to restore the context when updating client widgets during an out-of-bound call using the method.

    Threads that are not started using don't have any knowledge of the current session and don't have a way to communicate with the client The property returns the instance of the class that is bound to the current session. It can be used just like any other component with the method or to restore the session for the current thread. The advantage of using instead of the instance of a control or a page is to avoid to keep a reference to a component that may be disposed by the application.

    : Returns or sets the current for the session.

    : Returns or sets the current Desktop.

    : Returns or sets whether the browser will ask the user to confirm unloading the current page.

    This property attaches the window.onbeforeunload event. See https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onbeforeunload. It's not possible to determine whether the page is being unloaded because the user is trying to close the tab, close the browser, or is refreshing the page, or is taking any other action that may reload the page.

    : Returns the path for the application's main assembly.

    : Returns or sets the favicon to display in the browser.

    : Returns or sets the URL to the favicon to display in the browser.

    : Returns or sets the hash part of the URL on the client.

    : Returns a value indicating whether the session has been authenticated.

    : Indicates that the current application instance, which corresponds to the session, has been terminated and disposed.

    : Returns true when the current session has expired.

    : Returns true if this session is running in secure mode (https:// and wss://)

    : Returns true when the current session has been terminated.

    : Returns true if the current session is connected using WebSocket.

    : Returns or sets the runtime server license key.

    Setting the programmatically has to be done before the application is loaded. The best place is the static constructor for the Program static class, or the static constructor of the main window (if defined in Default.js).

    : Returns or sets the current full page window.

    : Returns a collection of open forms owned by the application.

    : Returns a collection of open pages owned by the application.

    : The name of the currently loaded platform.

    : Returns the product name associated with this application.

    : Returns the product version associated with this application stored either in or .

    : Returns the parameters used to launch the application.

    : Returns or sets whether all the controls in the applications should operate using the right-to-left mode.

    The value of this property is updated automatically when the current language changes if the value of "rightToLeft" in the application configuration file is set to "auto".

    : Returns true when the application is running in not in design, debug or test mode.

    : Returns the server's host name, DNS alias, or IP address as it would appear in self-referencing URLs.

    : Returns the port number to which the request was sent.

    : Returns the server variables.

    : Provides a generic storage for session-based objects.

    : Returns the total number of currently active sessions.

    : Returns the unique current session ID.

    : Shows or hides the debug console on the browser.

    Displays a simple HTMl only debug console. Works with any browser also when the developer tools are not available.

    : Returns or sets whether the browser is blocked by the Ajax loader.

    : Returns the root path of the web application.

    : Returns the URI used to start the application.

    : Returns the URL used to start the application.

    : Returns or sets the current .

    You can create and modify a new custom theme using the class. The new theme can be based on an existing theme, can be empty, or can be initialized from a JSON string.

    You may also alter a global theme shared by all sessions.

    : Returns or sets the page title in the browser.

    : Returns the current used either to launch or reload the application. It may be different from .

    : Returns the current URL used either to launch or reload the application. It may be different from .

    : Returns the security information for the current request.

    : Returns the raw user agent string of the client browser.

    : Returns the IP host address of the remote client.

    : Returns the DNS name of the remote client.

    : Returns the type for the current user.

    : Gets a sorted string array of client language preferences.

    Adds an event filter to monitor all the incoming events before they are routed to their respective component.

    Parameter
    Type
    Description

    EXPERIMENTAL: Adds a scoped service to the service container.

    Parameter
    Type
    Description

    Throws:

    • serviceType is null.

    • A service of type serviceType already exists.

    EXPERIMENTAL: Adds a scoped service to the service container.

    Parameter
    Type
    Description

    Throws:

    • serviceType is null.

    • A service of type serviceType already exists.

    Adds the text and corresponding translation to the default locale on the client.

    Parameter
    Type
    Description

    Instructs the browser to display a dialog with an optional message, and to wait until the user dismisses the dialog.

    Parameter
    Type
    Description

    Returns: . An awaitable that represents the asynchronous operation.

    Executes the JavaScript function on the client and receives the return value (or null) in the callback method.

    Parameter
    Type
    Description

    Executes the JavaScript function on the client.

    Parameter
    Type
    Description

    Asynchronously executes the JavaScript function on the client and returns an awaitable with the result of the remote call.

    Parameter
    Type
    Description

    Returns: . An awaitable that represents the asynchronous operation.

    Cancels the fullscreen mode.

    Instructs the browser to display a dialog with an optional message, and to wait until the user either confirms or cancels the dialog. until the user dismisses the dialog.

    Parameter
    Type
    Description

    Returns: . An awaitable that represents the asynchronous operation.

    Downloads the specified file on the client.

    Parameter
    Type
    Description

    Downloads the specified image to the client.

    Parameter
    Type
    Description

    Downloads the bytes in the stream to the client.

    Parameter
    Type
    Description

    Downloads the specified file on the client.

    Parameter
    Type
    Description

    Downloads the specified image to the client.

    Parameter
    Type
    Description

    Downloads the bytes in the stream to the client.

    Parameter
    Type
    Description

    Stops the polling requests from the client.

    Executes the JavaScript script on the client.

    Parameter
    Type
    Description

    Executes the JavaScript script on the client and receives the return value (or null) in the callback method.

    Parameter
    Type
    Description

    Asynchronously executes the JavaScript script on the client and returns an awaitable with the result of the remote call.

    Parameter
    Type
    Description

    Returns: . An awaitable that represents the asynchronous operation.

    Terminates the application and the corresponding session.

    Find the first component that matches the conditions defined in the predicate function.

    Parameter
    Type
    Description

    Returns: . The first qualified by the match expression.

    This method lets an application find any live component in the current session.

    Finds all the components that match the conditions in the predicate function.

    Parameter
    Type
    Description

    Returns: . The list of instances qualified by the match expression.

    This method lets an application iterate through all the live components in the current session.

    EXPERIMENTAL: Returns the requested service.

    Parameter
    Type
    Description

    Returns: . An instance of the service T or null if the service is not found.

    EXPERIMENTAL: Returns the requested service.

    Parameter
    Type
    Description

    Returns: . An instance of serviceType or null if the service is not found.

    Throws:

    • serviceType is null.

    Loads an assembly given the file name or path.

    Parameter
    Type
    Description

    Returns: . The loaded .

    This method loads the assembly and, if the assembly contains Wisej components that need embedded resources - like JavaScript classes or CSS styles - that are embedded in the assembly, notifies the client with the URL to load the additional resources dynamically.

    Creates an instance of the specified component from the assembly.

    Parameter
    Type
    Description

    Returns: . An instance of a Wisej component implementing the interface.

    Parameter
    Type
    Description
    Parameter
    Type
    Description

    Returns: .

    Changes the current theme.

    Parameter
    Type
    Description

    Returns the full file path in relation to the application's project directory.

    Parameter
    Type
    Description

    Returns: . The full path relative to the current application's root directory.

    Navigate to the specified URL.

    Parameter
    Type
    Description

    Plays one of the built-in sounds

    Parameter
    Type
    Description

    Plays a sound.

    Parameter
    Type
    Description

    Executes the callback method after all processing is completed and before updating the client.

    Parameter
    Type
    Description

    The Post() method is similar to the BeginInvoke() method used by desktop applications. It allows you to execute a block of code out of sync with the current execution flow.

    Prints the specified control.

    Parameter
    Type
    Description

    The control is printed without the caption or the borders, if present.

    Prints the entire browser window.

    Instructs the browser to display a dialog with an optional message prompting the user to input some text, and to wait until the user either submits the text or cancels the dialog.

    Parameter
    Type
    Description

    Returns: . An awaitable that represents the asynchronous operation.

    Causes the application to reload on the browser.

    Removes the filter from the list of registered event filters.

    Parameter
    Type
    Description

    EXPERIMENTAL: Removes the specified service type from the service container.

    Parameter
    Type
    Description

    Throws:

    • serviceType is null.

    Requests the browser to enable fullscreen mode if supported.

    Executes the callback in context.

    Parameter
    Type
    Description

    Sets the current session timeout in seconds.

    Parameter
    Type
    Description

    Instructs the client to start polling the server for UI changes at the specified interval when a WebSocket connection is not available.

    Parameter
    Type
    Description

    Calling this method when is true has no effect. Use client side polling when you know that your code will start a background task that needs to update the client asynchronously (push updates) and your server or clients don't support WebSocket connections. Once the background tasks are completed call to reduce the incoming requests from the client.

    Throws:

    • The interval specified is less than 1.

    Starts a new task within the current application context and returns immediately. See also .

    Parameter
    Type
    Description

    Returns: . An awaitable .

    The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the method to push the UI updates to the client browser. If you want to support background updates for clients or servers that can't use the WebSocket connection, you can either add a component to the parent container to force period requests to the server, or you can use the and methods.

    Starts a new task with a return value within the current application context and returns immediately. See also .

    Parameter
    Type
    Description

    Returns: .

    The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the method to push the UI updates to the client browser. The generics overload of allows the task to return a value. You can use this with the async/await pattern and asynchronously wait for the task to complete. If you want to support background updates for clients or servers that can't use the WebSocket connection, you can either add a component to the parent container to force period requests to the server, or you can use the and methods.

    Note that you don't have to specify the type in the angular brackets, the compiler will automatically detect the type from the return value of the asynchronous function.

    Starts a bound to the current session context.

    Parameter
    Type
    Description

    Returns: . An instance of .

    You must save a reference to the returned or the Garbage Collector will stop and dispose the timer. To alter the invocation period user Timer.Changer(), or stop the timer simply use Timer.Dispose(). See .

    Executes the optional callback in context and pushes all the pending updates to the client when in WebSocket mode.

    Parameter
    Type
    Description

    Use this method when you need to update the client asynchronously from an out-of-bound thread (different thread, not originating from a client request). You can call this method at the end of the code that updates the UI:

    Or you can use the optional action function to enclose the code that updates the UI in a block and ensure that the client is updated when the code block exits:

    Fired when the active window changes.

    Fired when the application is about to shut down.

    Fired when the application is reloaded in the browser because the user hit refresh or changed the URL.

    Fired when the application is started, after the Main method is called.

    Fired when the browser fires the "beforeinstallprompt" event. Corresponds to .

    Fired at the beginning of every request.

    Fired when the user resizes the browser.

    Fired when the user activates the browser tab.

    Fired when the user deactivates the browser tab.

    Fired when the changes.

    Fired at the end of every request.

    Fired when the focused control changes.

    Fired when the hash part of the URL changes on the client side.

    Fired when the current thread has completed processing all the events and before the response is sent back to the client.

    Fired when at the beginning of every request when impersonation is enabled in the JSON configuration file.

    Set Handled to true if your application takes care of impersonation. The default implementation in Wisej is supported only in .NET Framework and the Windows platform.

    Fired at the end of every request when impersonation is enabled in the JSON configuration file.

    Set Handled to true if your application takes care of impersonation. The default implementation in Wisej is supported only in .NET Framework and the Windows platform.

    Fired when a license error occurs.

    Fired when the active responsive profile is changed.

    Fired when the value changes.

    Fired when the session is about to time out.

    The default behavior built-in Wisej is to display a dialog asking the user to prolong the session. Set Handled to true to stop the default behavior.

    Fired when the current theme is changed.

    Fired when a thread exception is thrown.

    Name
    Description
    .
  • Read the applications's system information. Use StartupPath, ProductName, ProductVersion, etc.

  • Listen to the application's global events. See SessionTimeout , BeginRequest, ApplicationStart, ApplicationExitApplicationRefresh, BrowserSizeChangedResponsiveProfileChanged, CultureChanged, and many more.

  • Retrieve browser related information. Use the Browser to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The Browser object is updated automatically when the user resizes the browser or the page is reloaded.

  • Control the client browser. Start a Download, execute JavaScript functions or scriptlets using Call or Eval. Make the browser navigate to a different URL using Navigate or simply Reload the page.

  • Manage the main page or current desktop. MainPage lets you change the Page object that fills the browser and "navigate" from page to page. Desktop lets you change the active Desktop object on the client browser.

  • Manage all live components in the session. Through the Application class you can find, iterate, inspect all live components of any type. See OpenForms for all the currently created (visible or invisible) instances of Form. OpenPages returns all the created Page objects. FindComponent and FindComponents provide an easy way to find any component in the session or to iterate the list of components that match a custom expression.

  • Start background tasks in context. StartTask provides a powerful way to start a background task on the server that can keep interacting with the client browser while running independently.

  • Manage the application's theme. Use LoadTheme to load a Wisej theme into the application. Or use the Theme object to read all sorts of information from the current ClientTheme.

  • Terminate the application without waiting for the session to timeout. Use Exit to terminate the current session and free all the related memory.

  • scope

    Scope of the serviceInstance .

    scope

    Scope of the service.

    args

    The arguments to pass to the function.

    ondownload

    Optional callback invoked when fileName is downloaded.

    ondownload

    Optional callback invoked when fileName is downloaded.

    ondownload

    Optional callback invoked when fileName is downloaded.

    fileName

    The name of the file to save on the client.

    ondownload

    Optional callback invoked when fileName is downloaded.

    fileName

    The name of the file to save on the client.

    ondownload

    Optional callback invoked when fileName is downloaded.

    fileName

    The file name the client will use to save the stream.

    ondownload

    Optional callback invoked when fileName is downloaded.

    callback

    A callback method to invoke at the specified intervals.

    IDisposable
    ,
    IWisejSynchronized
    ,
    IServiceProvider
        Application.Session.myValue = 12;
        Application.Session["myValue"] = 12;
      
    var current = Application.Current;
    var thread = new Thread(() => {
      Application.Update(current, () => {
      
        // code here is running in context.
        
      });
    });
    static class Program
    {
      static Program()
      {
        Application.LicenseKey = "...";
      }
    }
    // create a new custom theme cloned from the current theme.
    var myTheme = new ClientTheme("MyTheme", Application.Theme);
    
    // alter the buttonFace color.
    myTheme.Colors.buttonFace = "red";
    
    // update the current session using the new custom theme.
    Application.Theme = myTheme;
    
    // change the buttonFace color in the current theme.
    // if the theme is one of the global themes, i.e. it was loaded
    // using Application.LoadTheme(name), then the change is also global.
    Application.Theme.Colors.buttonFace = "red";
    
    // since the theme objects are all dynamic and use a special DynamicObject
    // class part of the Wisej Framework, you can also use a string indexer
    // to address any field.
    Application.Theme.Colors["buttonFace"] = "red";
    

    filter

    IEventFilter

    An object that implements the IEventFilter interface to add to the filter list.

    serviceType

    Type

    Type of the service to add.

    serviceInstance

    Object

    serviceType

    Type

    Type of the service to add.

    callback

    Func<Type, ServiceScope, Object>

    text

    String

    The text to translate.

    translation

    String

    message

    String

    A string you want to display in the alert dialog.

    function

    String

    The name of the function to execute.

    callback

    Action<Object>

    function

    String

    The name of the function to execute.

    args

    Object[]

    function

    String

    The name of the function to execute.

    args

    Object[]

    message

    String

    A string you want to display in the confirm dialog.

    filePath

    String

    The file to download.

    fileName

    String

    image

    Image

    The image to download.

    fileName

    String

    stream

    Stream

    The stream to send to the client.

    fileName

    String

    target

    String

    Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.

    filePath

    String

    target

    String

    Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.

    image

    Image

    target

    String

    Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.

    stream

    Stream

    script

    String

    The script to evaluate.

    script

    String

    The script to evaluate.

    callback

    Action<Object>

    script

    String

    The script to evaluate.

    match

    Predicate<IWisejComponent>

    A custom Predicate expression used to match the IWisejComponent to find.

      // Find the first component that is a Button with Text = "OK"
      var button = Application.FindComponent(c => c is Button && ((Button)c).Text == "OK");

    match

    Predicate<IWisejComponent>

    A custom Predicate expression used to match the list of IWisejComponent objects to find.

      // List all text boxes that are read only in all forms.
      var list = Application.FindComponents(c => c is TextBox && ((TextBox)c).ReadOnly);

    T

    Type of the service to retrieve.

    serviceType

    Type

    Type of the service to add.

    nameOrFile

    String

    The file name or full path for the assembly to load.

    nameOrFile

    String

    The file name or full path for the assembly to load.

    className

    String

    packages

    IEnumerable<Package>

    callback

    Action<Boolean>

    packages

    IEnumerable<Package>

    name

    String

    Name of the theme resource. Use only the name without the path and without the extension.

    mixins

    String[]

    path

    String

    url

    String

    URL to navigate to.

    target

    String

    type

    MessageBoxIcon

    One of MessageBoxIcon value that identifies the sound to play.

    soundUrl

    String

    A string representing either a sound file URL or a base64 data URL.

    callback

    Action

    Method to invoke after the request has completed but before sending the response to the server.

    
    void Test() {
    
      Application.Post(() => {
        this.listBox.Items.Add("1");
      });
      
      this.listBox.Items.Add("2");
      
      // The items will be added in this order: "2", "1".
    }
    

    control

    IWisejControl

    The control to print, can be a window, a page or a single control.

    message

    String

    A string of text to display to the user.

    defaultValue

    String

    filter

    IEventFilter

    An object that implements the IEventFilter interface to remove from the filter list.

    serviceType

    Type

    Type of the service to remove.

    context

    IWisejComponent

    The application context to update. It can be any Wisej component or the IWisejComponent returned by the property Current.

    action

    Action

    seconds

    Int32

    interval

    Int32

    Polling interval in milliseconds. The minimum is 1000ms.

    
    // this has not effect when the client and server are connected using WebSocket.
    Application.StartPolling(1000);
    
    Application.StartTask(() => {
    
      for (int i = 0; i < 100; i++) {
        this.label1.Text = "Counting..." + i;
        Thread.Sleep(1000);
      }
      
      // this has not effect when the client and server are NOT connected using WebSocket.
      Application.Update(this);
    
      // this has not effect when the client and server are connected using WebSocket.
      Application.EndPolling();
    
    });

    action

    Action

    Start method invoked by the new task when it starts up.

    Application.StartTask(() => {
    
      for (int i = 0; i < 100; i++) {
      
        this.label1.Text = "Counting..." + i;
        
        // just wait a bit or it's too fast.
        Thread.Sleep(1000);
        Application.Update(this);
      }
    });

    T

    action

    Func<T>

    string text = await Application.StartTask(() => {
    
      string value = "";
      for (int i = 0; i < 100; i++) {
      
        value += i.ToString();
        
        // just wait a bit or it's too fast.
        Thread.Sleep(100);
      }
      return value;
    });
    
    this.label.Text = text;
    Application.Update(this);
    

    dueTime

    Int32

    The amount of time, in milliseconds, to delay before invoking the callback .

    period

    Int32

    context

    IWisejComponent

    The application context to update. It can be any Wisej component or the IWisejComponent returned by the property Current.

    action

    Action

    Application.StartTask(() => {
    
        for (int i = 0; i < 100; i++) {
        
          this.label1.Text = "Counting..." + i;
          
          // just wait a bit or it's too fast.
          Thread.Sleep(1000);
        }
        
        Application.Update(this);
    
    });
    Application.StartTask(() => {
    
        Application.Update(this, () => {
        
          for (int i = 0; i < 100; i++) {
        
            this.label1.Text = "Counting..." + i;
          
            // just wait a bit or it's too fast.
            Thread.Sleep(1000);
          }
        });
    
    });

    IWisejComponent

    All wisej components implement this interface.

    Properties

    ActiveProfile

    Browser

    ClientId

    Clients

    CommonAppDataPath

    CommonAppDataRegistry

    CompanyName

    Configuration

    Cookies

    Current

    CurrentCulture

    Desktop

    EnableUnloadConfirmation

    ExecutablePath

    FavIcon

    FavIconSource

    Hash

    IsAuthenticated

    IsDisposed

    IsExpired

    IsSecure

    IsTerminated

    IsWebSocket

    LicenseKey

    MainPage

    OpenForms

    OpenPages

    Platform

    ProductName

    ProductVersion

    QueryString

    RightToLeft

    RuntimeMode

    ServerName

    ServerPort

    ServerVariables

    Session

    SessionCount

    SessionId

    ShowConsole

    ShowLoader

    StartupPath

    StartupUri

    StartupUrl

    Theme

    Title

    Uri

    Url

    User

    UserAgent

    UserHostAddress

    UserHostName

    UserIdentity

    UserLanguages

    Methods

    AddEventFilter(filter)

    AddService(serviceType, serviceInstance, scope)

    AddService(serviceType, callback, scope)

    AddTranslation(text, translation)

    AlertAsync(message)

    Call(function, callback, args)

    Call(function, args)

    CallAsync(function, args)

    CancelFullScreen()

    ConfirmAsync(message)

    Download(filePath, fileName, ondownload)

    Download(image, fileName, ondownload)

    Download(stream, fileName, ondownload)

    DownloadAndOpen(target, filePath, fileName, ondownload)

    DownloadAndOpen(target, image, fileName, ondownload)

    DownloadAndOpen(target, stream, fileName, ondownload)

    EndPolling()

    Eval(script)

    Eval(script, callback)

    EvalAsync(script)

    Exit()

    FindComponent(match)

    FindComponents(match)

    GetService<T>()

    GetService(serviceType)

    LoadAssembly(nameOrFile)

    LoadComponent(nameOrFile, className)

    LoadPackages(packages, callback)

    LoadPackagesAsync(packages)

    LoadTheme(name, mixins)

    MapPath(path)

    Navigate(url, target)

    Play(type)

    Play(soundUrl)

    Post(callback)

    Print(control)

    Print()

    PromptAsync(message, defaultValue)

    Reload()

    RemoveEventFilter(filter)

    RemoveService(serviceType)

    RequestFullScreen()

    RunInContext(context, action)

    SetSessionTimeout(seconds)

    StartPolling(interval)

    StartTask(action)

    StartTask<T>(action)

    StartTimer(dueTime, period, callback)

    Update(context, action)

    Events

    ActiveWindowChanged

    ApplicationExit

    ApplicationRefresh

    ApplicationStart

    BeforeInstallPrompt

    BeginRequest

    BrowserSizeChanged

    BrowserTabActivated

    BrowserTabDeactivated

    CultureChanged

    EndRequest

    FocusedControlChanged

    HashChanged

    Idle

    ImpersonationBegin

    ImpersonationEnd

    LicenseError

    ResponsiveProfileChanged

    RightToLeftChanged

    SessionTimeout

    ThemeChanged

    ThreadException

    Implements

    Session
    Dictionary
    Cookies
    ServerVariables
    ServerPort
    ServerName
    UserAgent
    Uri
    Url
    StartupUri
    Application
    docs.wisej
    ClientProfile
    ClientBrowser
    String
    ClientCollection
    String
    RegistryKey
    String
    AssemblyCompanyAttribute
    Configuration
    Configuration
    CookieCollection
    IWisejComponent
    Update
    StartTask
    Current
    Application
    Update
    RunInContext
    Current
    CultureInfo
    CultureInfo
    Desktop
    Boolean
    String
    Image
    String
    String
    Boolean
    Boolean
    Boolean
    Boolean
    Boolean
    Boolean
    String
    LicenseKey
    Page
    FormCollection
    PageCollection
    ClientPlatform
    String
    String
    AssemblyInformationalVersionAttribute
    AssemblyFileVersionAttribute
    NameValueCollection
    Boolean
    Boolean
    String
    Int32
    NameValueCollection
    Object
    Int32
    String
    Boolean
    Boolean
    String
    Uri
    String
    ClientTheme
    ClientTheme
    ClientTheme
    String
    Uri
    Uri
    StartupUri
    String
    StartupUrl
    IPrincipal
    String
    String
    String
    WindowsIdentity
    WindowsIdentity
    String[]
    ArgumentNullException
    ArgumentException
    ArgumentNullException
    ArgumentException
    Task
    Task
    Task
    Task<Object>
    Task
    Task<Boolean>
    Task
    Task
    Task<Object>
    Task
    IWisejComponent
    IWisejComponent
    IList<IWisejComponent>
    IWisejComponent
    T
    Object
    ArgumentNullException
    Assembly
    Assembly
    IWisejComponent
    IWisejComponent
    Task<Boolean>
    String
    Task<String>
    Task
    ArgumentNullException
    IsWebSocket
    EndPolling
    ArgumentOutOfRangeException
    background-tasks
    Task
    Task
    Update
    Timer
    StartPolling
    EndPolling
    background-tasks
    Task<T>
    Update
    StartTask
    Timer
    StartPolling
    EndPolling
    Timer
    Timer
    Timer
    Timer
    system.threading
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    BeforeInstallPromptEvent
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    CurrentCulture
    EventHandler
    EventHandler
    HashChangedEventHandler
    EventHandler
    HandledEventHandler
    HandledEventHandler
    LicenseErrorEventHandler
    ResponsiveProfileChangedEventHandler
    EventHandler
    RightToLeft
    HandledEventHandler
    EventHandler
    ThreadExceptionEventHandler

    Instance of the serviceType or null to create it on demand.

    A callback object that can create the service. This allows a service to be declared as available, but delays creation of the object until the service is requested.

    The translation override.

    Asynchronous callback method that receives the return value.

    The arguments to pass to the function.

    The arguments to pass to the function.

    The name of the file to save on the client.

    The name of the file to save on the client.

    The file name the client will use to save the stream.

    The file to download.

    The image to download.

    The stream to send to the client.

    Asynchronous callback method that receives the return value.

    Optional list of theme mixins. If null, the default theme mixins are always applied.

    The target browser window: _self, _blank, etc.

    An optoional string containing the default value displayed in the text input field.

    Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.

    Start method invoked by the new task when it starts up.

    The time interval between invocations, in milliseconds.

    Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.

    StartupUrl
    ServiceScope
    ServiceScope
    Object[]
    Action<String>
    Action<String>
    Action<String>
    String
    Action<String>
    String
    Action<String>
    String
    Action<String>
    Action

    Control

    Wisej.Web.Control

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Base class for all Wisej controls.

    public class Control : IWisejControl,
    Public Class Control
        Inherits IWisejControl
        Implements IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfiles

    Constructors

    Control()

    Initializes a new instance of the Control class.

    Properties

    AccessibleDescription

    String: Returns or sets the description that will be reported to accessibility client applications. It is assigned to the "alt" attribute of the browser element.

    AccessibleName

    : Returns or sets the name of the control for use by accessibility client applications. It is assigned to the "name" attribute of the browser element.

    : Returns or sets the accessible role of the control that will be reported to accessibility client applications. It is assigned to the "role" attribute of the browser element.

    : Returns or sets whether the control can initiate a drag-drop operation.

    : Returns or sets whether the control can accept data that the user drags onto it.

    : Returns or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.

    : Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents.

    : Sets the appearance key for the theme engine.

    : Returns or sets the background color for the control.

    : Returns or sets the background image displayed in the control.

    : Returns or sets the background image layout as defined in the enumeration.

    : Returns or sets the background image displayed in the control.

    : Returns a flag indicating that the control is becoming the active control.

    : Returns or sets the for the control.

    : Returns the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.

    : Returns or sets the size and location of the control including its non-client area, in pixels and relative to the parent control.

    : Determines whether the control can execute a command.

    : Returns whether the control can receive focus.

    : Returns whether the control can be selected.

    : Returns or sets whether the control has captured the mouse.

    : Returns or sets whether the control causes validation to be performed on controls that require to be validated when this control receives focus.

    : Returns a collection of client events and JavaScript listeners. You may attach multiple listeners to same event.

    You can use this collection at design time or in code or through the listener methods:

    : Returns the client rectangle of the control.

    : Returns or sets the height and width of the client area.

    : Indicates whether the control, or one of its child controls, has the input focus.

    : Returns or sets the shortcut menu associated with the control.

    : Returns the collection of controls contained within the control.

    : Returns a value indicating whether the control has been created.

    : Returns or sets additional CSS class names to add to the widget.

    Use this property to add or remove custom CSS classes that you may add to your application as standard css files or through the extender. You can assign multiple class names separated by a space and you can manage this property using the related methods:

    : Returns or sets the custom CSS styles to add to the widget.

    You can use any CSS style string.

    : Returns or sets the cursor that is displayed when the mouse pointer is over the control.

    : Returns the data bindings for the control.

    : Returns the default background color of the control.

    : Returns the default font of the control.

    : Returns the default background color of the control.

    : Returns the rectangle that represents the virtual display area of the control.

    : Returns whether the control is in the process of disposing itself and child controls.

    : Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent.

    : Returns or sets whether the control can respond to user interaction.

    : Enables or disables the browser's context menu.

    : Returns or sets whether the control can gain the focus.

    : Returns a value indicating whether the control has input focus.

    : Gets or sets the font of the text displayed by the control.

    : Returns or sets the text color of the control.

    : Returns the unique server-side id (handle) for this component.

    : Returns whether the control contains any child control.

    : Returns whether the control specifies data bindings.

    : Check if the control defines any responsive profile without forcing the creation of the collection.

    : Checks if the dynamic object was created and has any value.

    : Returns or sets the height of the control.

    : Returns or sets an initialization script to execute when the widget is created (or reloaded) in the browser.

    Use this property to add custom initialization JavaScript that is always executed when the client widget is created. The context (this) of the script is the instance of the widget. You can use the entire qooxdoo and wisej.js api. See and .

    You may also use the init script to attach events to the widget or to its internal children. Event handlers can also be attached using the collection and the client events methods:

    : Returns whether the control has been disposed.

    : Returns if the control has a server-side component id (handle) associated with it.

    : Returns whether the control is mirrored.

    : Returns the control's layout engine.

    : Returns or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.

    : Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.

    : Returns or sets the space between controls.

    : Returns or sets the maximum size for the control.

    : Returns or sets the minimum size for the control.

    : Returns a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.

    : Returns a value indicating which of the mouse buttons is in a pressed state.

    : Returns the position of the mouse cursor in screen coordinates.

    : Returns or sets whether the control can be moved by dragging.

    : Gets or sets the name of the control.

    : Returns or sets padding within the control.

    : Returns or sets the parent container of the control.

    : Returns the preferred size in which the control can fit.

    : Returns or sets the edges of the control that can be dragged to resize the control.

    : Returns the collection of responsive properties that have been set for this control.

    : Return the distance, in pixels, between the right edge of the control and the left edge of its container's client area.

    : Returns or sets whether the control's elements are aligned right-to-left to support RTL languages.

    When set to , the control inherits the value of this property from its parent. However, when the control is a top-level control (i.e. Window, Page, Desktop), and the value is set to , the right-to-left mode is automatically retrieved from the current language.

    : Returns or sets whether the text in the control can be selected in the browser by the user by dragging the pointer. [Since 2.5.22]

    Not to be confused with , which corresponds to the property. When is set to true, the text of the control (i.e. a label or a button) can be highlighted in the browser and copied to the clipboard. It will also make the widget "focusable" but only in the browser.

    : Returns or sets whether the control is blocked by the ajax loader.

    : Returns or sets the height and width of the control.

    : Returns or sets additional theme states to the client widget.

    Use this property to manage additional custom states that you may want to add to a widget. The state will update the visualization of the widget using the styles and properties set in the current theme and loaded theme mixins. You can also force the usage of built-in states. However, this property will not return the current states of the widget as updated by the client browser. It only returns the states set by the application.

    In addition to setting this property directly, you can also manage it using the related methods:

    : Returns or sets the tab order of the control within its container.

    : Returns or sets whether the user can give the focus to this control using the TAB key and the property is set to true.

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

    : Returns or sets the text associated with this control.

    When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with " ".

    : Returns or sets the tooltip text to show for this control.

    When using property you can only set the ToolTip text and cannot change the default ToolTip icon set in the theme. To change the ToolTip icon you can either create a custom theme, or a theme mixin, or use the extender and the property added by the extender. You can change the default , , , , or enable HTML in by using a extender also without setting the property added by the extender.

    : Returns or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.

    : Returns the parent control that is not parented by another . Typically, this is the outermost that the control is contained in.

    : Returns a dynamic object that can be used to store custom data in relation to this control.

    : Returns or sets whether to use the wait cursor for the current control and all child controls.

    : Returns a flag indicating that the validation has been canceled.

    : Returns or sets whether the control and all its child controls are displayed.

    : Returns a value indicating the wheel delta from the last wheel event.

    : Returns or sets the width of the control.

    Adds a new listener script to the event name to the client widget.

    Parameter
    Type
    Description

    Returns: . An integer id that you can use to remove the listener from the event using or to retrieve the listener script code using .

    The script will execute in the browser when the event name occurs. You can attach multiple listeners to the same event.

    Adds the CSS class name to the widget element. If the class already exists in the it's not added.

    Parameter
    Type
    Description

    Returns: . The new value of the property.

    Adds the specified theme state to the widget.

    Parameter
    Type
    Description

    Returns: . The new list of states stored in the property.

    You can also assign a new array of states to the property.

    Executes the specified delegate asynchronously.

    Parameter
    Type
    Description

    Returns: . An that represents the result of the operation.

    Executes the specified delegate asynchronously.

    Parameter
    Type
    Description

    Returns: . An that represents the result of the asynchronous call.

    Brings the control to the front of the z-order.

    Runs the JavaScript function within the component's context in the browser.

    Parameter
    Type
    Description

    Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.

    Parameter
    Type
    Description

    Asynchronously runs the JavaScript function within the component's context in the browser and returns an awaitable containing the value returned by the remote call.

    Parameter
    Type
    Description

    Returns: . An awaitable that represents the asynchronous operation.

    Centers the position of the control within the bounds of the parent.

    Centers the position of the control within the bounds of the parent either horizontally, vertically or both.

    Parameter
    Type
    Description

    Indicates whether the specified control is a child of this control.

    Parameter
    Type
    Description

    Returns: . true if the specified control is a child of the control; otherwise, false.

    Creates and register this control and all its children.

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

    Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

    Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

    Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

    Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

    Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.

    Retrieves the return value from the asynchronous operation represented by asyncResult .

    Parameter
    Type
    Description

    Returns: . The return value from the asynchronous operation.

    Runs the javaScript code within the component's context in the browser.

    Parameter
    Type
    Description

    Runs the javaScript code within the component's context in the browser and returns the value to the callback method.

    Parameter
    Type
    Description

    Asynchronously runs the javaScript code within the component's context in the browser and returns an awaitable that contains the value returned by the remote call.

    Parameter
    Type
    Description

    Returns: . An awaitable that represents the asynchronous operation.

    Retrieves the form that the control is on.

    Returns: .

    Retrieves the page that the control is on.

    Returns: .

    Sets input focus to the control.

    Returns: . true if the input focus request was successful; otherwise, false.

    Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.

    Parameter
    Type
    Description

    Returns: . The child at the specified coordinates.

    Retrieves the child control that is located at the specified coordinates.

    Parameter
    Type
    Description

    Returns: . A that represents the control that is located at the specified point.

    Returns the script associated to the listener identified by id .

    Parameter
    Type
    Description

    Returns: . JavaScript associated with the listener.

    Returns the scripts for all the listeners attached to the event name .

    Parameter
    Type
    Description

    Returns: . String array containing the scripts for the listeners attached to the event.

    Returns the next up the control's chain of parents.

    Returns: . The parent .

    Retrieves the next control forward or back in the tab order of child controls.

    Parameter
    Type
    Description

    Returns: . The next in the tab order.

    Retrieves the value of the specified control style bit for the control.

    Parameter
    Type
    Description

    Returns: . true if the specified control style bit is set to true; otherwise, false.

    Checks whether the specified event name has any listener attached.

    Parameter
    Type
    Description

    Returns: . True if the event name has any listener attached.

    Returns true if the property contains the specified class name .

    Parameter
    Type
    Description

    Returns: . True of the css class name is already included in .

    Checks whether the specified theme state is present in the property.

    Parameter
    Type
    Description

    Returns: . True if the widget already has the state .

    Conceals the control from the user.

    Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

    Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

    Parameter
    Type
    Description

    Executes the specified delegate.

    Parameter
    Type
    Description

    Returns: . The return value from the delegate being invoked, or null if the delegate has no return value.

    Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.

    Parameter
    Type
    Description

    Returns: . An that contains the return value from the delegate being invoked, or null if the delegate has no return value.

    Determines whether the specified character is the mnemonic character.

    Parameter
    Type
    Description

    Returns: . true if the charCode character is the mnemonic character; otherwise, false.

    Arranges all the child using the specified dock style, spaced by spacing pixels.

    Parameter
    Type
    Description

    Arranges all the child using the specified dock style, spaced by spacing pixels.

    Parameter
    Type
    Description

    Arranges all the child using the specified dock style, spaced by spacing pixels.

    Parameter
    Type
    Description

    Arranges all the child using the specified dock style, spaced by spacing pixels.

    Parameter
    Type
    Description

    Arranges all the child in the specified direction , spaced by spacing pixels.

    Parameter
    Type
    Description

    Arranges all the child in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .

    Parameter
    Type
    Description

    Arranges the specified child controls in the specified direction , spaced by spacing pixels.

    Parameter
    Type
    Description

    Throws:

    • One of the controls is not a child of this control.

    Arranges the specified child controls in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .

    Parameter
    Type
    Description

    Throws:

    • One of the controls is not a child of this control.

    Forces the control to apply layout logic to all its child controls.

    Forces the control to apply layout logic to all its child controls.

    Parameter
    Type
    Description

    Computes the location of the specified screen point into client coordinates.

    Parameter
    Type
    Description

    Returns: . A that represents the converted , point , in client coordinates.

    Computes the location of the specified client point into screen coordinates.

    Parameter
    Type
    Description

    Returns: . A that represents the converted , point , in screen coordinates.

    Computes the size and location of the specified screen rectangle in client coordinates.

    Parameter
    Type
    Description

    Returns: . A that represents the converted , rect , in client coordinates.

    Computes the size and location of the specified client rectangle in screen coordinates.

    Parameter
    Type
    Description

    Returns: . A that represents the converted , rect , in screen coordinates.

    Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control, including the non-client areas such as the caption of forms or panels.

    Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.

    Parameter
    Type
    Description

    Detaches and removes the listener identified by id .

    Parameter
    Type
    Description

    Returns: . True if the id specified a valid lister and it was removed; otherwise false if id is invalid.

    Removes all the listeners attached to the event name .

    Parameter
    Type
    Description

    Returns: . True if the event name has any listener that was removed.

    Removes the specified css class name from the control's property.

    Parameter
    Type
    Description

    Returns: . The new value of the property.

    Removes the specified theme state from the widget.

    Parameter
    Type
    Description

    Returns: . The new list of states stored in the property.

    You can also assign a new array of states to the property.

    Removes all the data bindings from the control.

    Resumes layout logic.

    Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.

    Parameter
    Type
    Description

    Scrolls the control into view in the container using the specified alignX and alignY preferences.

    Parameter
    Type
    Description

    Scrolls the child control into view.

    Activates a control.

    Activates the next control in the list according to the specified selection rules.

    Parameter
    Type
    Description

    Returns: . true if a control was activated; otherwise, false.

    Sends the control to the back of the z-order.

    Sets the bounds of the control to the specified location and size.

    Parameter
    Type
    Description

    Sets the specified bounds of the control to the specified location and size.

    Parameter
    Type
    Description

    Displays the control to the user.

    Suspends the layout logic for the control.

    Causes the control to update the corresponding client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

    Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .

    Parameter
    Type
    Description

    Returns: . true if all of the children validated successfully; otherwise, false. If called from the or event handlers, this method will always return false.

    Validates all selectable child controls in the container, including descendants. This is equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See for details of exactly which child controls will be validated.

    Returns: . true if all of the children validated successfully; otherwise, false. If called from the or event handlers, this method will always return false.

    Fired after the control has been fully rendered on the client.

    This is a "lazy" event. It fires only when there is an handler attached to it, otherwise the companion On{Name} protected method is not invoked. It's enough to attach to either one of or to enable both events.

    Fired when the property value changes.

    Fired when the value of the property changes.

    Fired when the value of the property changes.

    Fired when the property changes.

    Fired when the value of the property changes.

    Occurs when the value of the property changes.

    Fired when the value of the property changes.

    Fired when the control is clicked.

    Fired when the property value changes.

    Fired when the value of the property changes.

    Fired when a new control is added to the .

    Fired when a control is made visible the first time, fully created and sent to the client.

    Fired when a control is removed from the .

    Fired when the value of the property changes.

    Fired after the control is no longer visible on the client.

    This is a "lazy" event. It fires only when there is an handler attached to it, otherwise the companion On{Name} protected method is not invoked. It's enough to attach to either one of or to enable both events.

    Fired when the component is disposed.

    Fired when the value of the property changes.

    Fired when the control is double-clicked.

    Fired when a drag-and-drop operation is completed.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when a drag-drop operation is terminated either by a drop or canceled.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when an object is dragged into the control's bounds.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when an object is dragged out of the control's bounds.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when an object is dragged over the control's bounds.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when a drag-drop operation is started by the user.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the property value has changed.

    Fired when a control is and the user ends the move operation.

    This event fires only when is true and the user moves the widget on the client. It doesn't fire when the property changes.

    Fired when a control has and the user ends the resize operation.

    This event fires only when the has a value different than and the user resizes the widget on the client. It doesn't fire when the of the control changes.

    Fired when the control gains the input focus.

    Fired when the property value changes.

    Fired when the property value changes.

    Fired when the control gains the focus.

    Fired when the user requests help for a control by pressing F1.

    Fired when the ImeMode property has changed.

    Fired when a key is pressed while the control has focus.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when a key is pressed while the control has focus.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when a key is released while the control has focus.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when a control should reposition its child controls.

    Fired when the control loses the input focus.

    Fired when the property value has changed.

    Fired when a pointer holds on the screen.

    Fired when the control loses focus.

    Fired when the control's margin changes.

    Fired when the control loses mouse capture.

    Fired when the control is clicked by the mouse.

    Fired when the control is double clicked by the mouse.

    Fired when the mouse pointer is over the control and a mouse button is pressed.

    Fired when the mouse pointer enters the control.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the mouse pointer rests on the control.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the mouse pointer leaves the control.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the mouse pointer is moved over the control.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the mouse pointer is over the control and a mouse button is released.

    Fired when the mouse wheel moves while the control has focus.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the control's padding changes.

    Fired when a UserPaint control needs to redraw itself.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the property value changes.

    Fired when two finger moved towards or away from each other. It contains the scaling factor of the pinch.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired before the event when a key is pressed while focus is on this control.

    Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the control is resized.

    Fired when the active responsive profile is changed.

    Fired when the property value changes.

    Fired when two finger moved around a single point. It contains the angle of the rotation.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the property value changes.

    Fired when a control is and the user begins the move operation.

    This event fires only when is true and the user begins moving the widget on the client.

    Fired when a control has and the user begins the resize operation.

    This event fires only when the has a value different than and the user begins resizing the widget on the client.

    Fired when the control style changed.

    Fired when a pointer swipes over the screen.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the property value has changed.

    Fired when the value of the property changes.

    Fired when a pointer taps on the screen.

    Fired when the property value changes.

    Fired when a touch point has been disrupted in an implementation-specific manner (for example, too many touch points are created).

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when a touch point is removed from the touch surface.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when a touch point is moved along the touch surface.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when a touch point is placed on the touch surface.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when a pointer grabs an item and moves the pointer on it.

    This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

    Fired when the control is finished validating.

    Fired when the control is validating.

    Fired when the property value changes.

    Fired when the control receives a custom event from the client.

    JavaScript code can fire any event back to a control, including custom data, using:

    On the server side, the event name and event data are available in the WidgetEvent handler:

    Name
    Description
    Name
    Description
    RemoveClientEventListener
  • GetClientEventListener

  • RemoveClientEventListener
  • GetClientEventListener

  • args

    The arguments to pass to the function.

    imageSource

    The name or URL for an image to use as the drag cursor.

    imageSource

    The name or URL for an image to use as the drag cursor.

    imageSize

    The size of the drag image specified in imageSource.

    image

    An to use as the drag cursor.

    image

    An to use as the drag cursor.

    imageSize

    The size of the drag image specified in image.

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using dock = , or , or .

    vAlign

    Vertical alignment when using dock = , or , .

    spacing

    Spacing between the .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using dock = , or , or .

    vAlign

    Vertical alignment when using dock = , or , .

    spacing

    Spacing between the .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using dock = , or , or .

    vAlign

    Vertical alignment when using dock = , or , .

    viewArea

    Rectangle limiting the area to arrange the in. If empty, it will use .

    spacing

    Spacing between the .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using dock = , or , or .

    vAlign

    Vertical alignment when using dock = , or , .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using direction = .

    vAlign

    Vertical alignment when using direction = .

    spacing

    Spacing between the .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using direction = .

    vAlign

    Vertical alignment when using direction = .

    spacing

    Spacing between the controls .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using direction = .

    vAlign

    Vertical alignment when using direction = .

    viewArea

    Rectangle limiting the area to arrange the controls in. If empty, it will use .

    spacing

    Spacing between the controls .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using direction = .

    vAlign

    Vertical alignment when using direction = .

    tabStopOnly

    true to ignore the controls with the property set to false; otherwise, false.

    nested

    true to include nested (children of child controls) child controls; otherwise, false.

    wrap

    true to continue searching from the first control in the tab order after the last control has been reached; otherwise, false.

    width

    The new property value of the control.

    height

    The new property value of the control.

    width

    The new property value of the control.

    height

    The new property value of the control.

    specified

    A bitwise combination of the values. For any parameter not specified, the current value will be used.

    Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.

    Represents a button control.

    Implements the basic functionality common to button controls.

    Represents a check box control.

    Displays a in which a check box is displayed to the left of each item.

    Represents a combo box control.

    Provides focus-management functionality for controls that can function as a container for other controls.

    Represents a control that allows the user to select or type a date and a time.

    Represents a spinner control that displays string values.

    Represents a panel that dynamically arranges its children horizontally or vertically in automatic rows or columns.

    Represents a window or dialog box that makes up an application's user interface.

    Represents a Wisej control that displays a frame around a group of controls with an optional caption.

    Represents a label control.

    Represents an hyper-link control.

    Represents a control to display a list of items.

    Provides a common implementation of members for the and classes.

    Uses a mask to distinguish between proper and improper user input.

    Represents the container for multiple-document interface (MDI) child forms.

    Represents a control that enables the user to select a date using a visual monthly calendar display.

    Represents a spinner control that displays numeric values.

    Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.

    Represents a collapsible panel with an optional header that contains a group of controls.

    Represents an image control.

    Represents a progress control that displays a value visually as a filled bar.

    Enables the user to select a single option from a group of choices when paired with other controls.

    Defines a base class for controls that support auto-scrolling behavior.

    Represents an horizontal scroll bar.

    Represents a vertical scroll bar.

    Implements the basic functionality of a scroll bar control.

    Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.

    Creates a panel that is associated with a .

    Manages a related set of pages.

    Represents a single tab page in a .

    Represents a text box control that allows the user to enter any value.

    Implements the basic functionality required by text controls.

    Enables the user to choose between a range of values by sliding a small bar along another bar.

    Implements the basic functionality required by a spin box (also known as an up-down control).

    Provides an empty control that can be used to create other controls.

    Represents a web browser control that enables the user to navigate web pages inside a form or a page.

    Represents a control that can be hosted in a .

    Represents a control that can be hosted in a .

    Represents a control that can be hosted in a cell.

    Represents a control that can be hosted in a .

    Represents a control that can be hosted in a cell when the cell's is set to .

    Represents a data grid control.

    Displays data in a customizable list format.

    Used by the control to display data at run time.

    Represents a desktop container that can host floating windows.

    Displays collapsible set of panels for presenting information in a limited amount of space.

    Represents a panel in a control.

    Represents a control that can host ASP.NET or MVC pages within a Wisej application.

    Represents the HTML5 canvas element.

    Represents a control that can display flash applications.

    Represents a panel that dynamically arranges its child controls.

    Represents a control that displays any HTML file and a corresponding CSS style sheet as embedded HTML.

    Represents a control that displays any HTML file in an IFrame element.

    Represents a line control.

    The TreeViewComboBox control represents a control with a as the drop down panel.

    Base implementation for media controls.

    Represents a control that displays a video file.

    Represents a control that plays an audio file.

    Represents a control that can display a pdf document in the browser either using the native pdf viewer, the pdf.js viewer, Google docs, or a custom viewer.

    Represents a shape control. Displays an element a border in any of the four sides.

    Displays child controls vertically or horizontally in a scrollable container.

    Represents a spacer control. It can be used to add a space between controls in a layout panel. It is not rendered on the client.

    Represents a split button control.

    Represents a data field that displays a list of selectable and removable tags. The control recognizes tags as the user types and adds in front of the editable field.

    Represents a spinner control that displays values.

    The TreeViewComboBox control represents a control with a as the drop down panel.

    Represent an upload widget. Allows users to selected one or more files and upload them to the server.

    The UserComboBox control represents a control with a custom panel that drops down when the user clicks the down arrow.

    Provides an popup container that can be attached to other controls.

    Provides a generic widget that can use most third party javascript widgets.

    Represents a list view control, which displays a collection of items that can be displayed using one of four different views.

    Represents a menu bar component.

    Provides a user interface for browsing the properties of an object.

    Displays information to the user in a about the object being viewed, the object's components, or the object's operation.

    Represents a toolbar component.

    Displays a hierarchical collection of labeled items, each represented by a .

    Allows an object to serialize itself.

    IWisejComponent
    ,
    IBindableComponent
    ,
    IWisejSerializable
    ,
    IHasPropertyStore
    ,
    IHasResponsiveProfiles
    
      // set the border radius to 100% and make the control round.
      this.button1.CssStyle = "border-radius:100%";
    
      // change the background color of the internal label of the button widget.
      this.button1.InitScript = "this.getChildControl('label').setBackgroundColor('red')";
    
      // attach a JavaScript event handler.
      this.textBox1.InitScript = @"this.addListener('keydown', function(e) {
        if (e.getKeyIdentifier() == "PageDown") {
          alert('You pressed PageDown.');
        }
      });
    
      // force the widget to update the UI as if it was hovered and focused.
      this.button1.States = new [] { "hovered", "focused" };
    
      // apply a custom state defined in a custom theme or theme mixing.
      this.panel1.States = new [] { "alert" };

    name

    String

    Name of the client event to attach the listener to.

    script

    String

    name

    String

    Name of the css class to add.

    state

    String

    Name of the custom state to add to the widget.

    method

    Delegate

    A delegate to a method that takes no parameters.

    method

    Delegate

    A delegate to a method that takes no parameters.

    args

    Object[]

    function

    String

    The name of the JavaScript function to execute.

    args

    Object[]

    function

    String

    The name of the JavaScript function to execute.

    callback

    Action<Object>

    function

    String

    The name of the JavaScript function to execute.

    args

    Object[]

    horizontal

    Boolean

    Center horizontally.

    vertical

    Boolean

    control

    Control

    The child Control to find.

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    asyncResult

    IAsyncResult

    An IAsyncResult that represents a BeginInvoke operation started on a control.

    javaScript

    String

    The JavaScript code to run on the client.

    javaScript

    String

    The JavaScript code to evaluate on the client.

    callback

    Action<Object>

    javaScript

    String

    The JavaScript code to evaluate on the client.

    pt

    Point

    A Point that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.

    skipValue

    GetChildAtPointSkip

    pt

    Point

    A Point that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.

    id

    Int32

    Id of the listener to retrieve the script for.

    name

    String

    Name of the event.

    control

    Control

    The Control to start the search with.

    forward

    Boolean

    flag

    ControlStyles

    The ControlStyles bit to return the value from.

    name

    String

    Name of the client event to verify.

    name

    String

    Css class name to verify.

    state

    String

    Name of the state to check.

    invalidateChildren

    Boolean

    When true, invalidates all the children of the control.

    method

    Delegate

    A delegate that contains a method to be called in the control's thread context.

    method

    Delegate

    A delegate to a method that takes parameters of the same number and type that are contained in the args parameter.

    args

    Object[]

    charCode

    Char

    The character to test.

    text

    String

    dock

    DockStyle

    Indicates whether to arrange the Controls horizontally or vertically.

    spacing

    Int32

    dock

    DockStyle

    Indicates whether to arrange the Controls horizontally or vertically.

    viewArea

    Rectangle

    controls

    ICollection<Control>

    List of child controls to arrange. If null, all the children will be arranged.

    dock

    DockStyle

    controls

    ICollection<Control>

    List of child controls to arrange. If null, all the children will be arranged.

    dock

    DockStyle

    direction

    Orientation

    Indicates whether to arrange the Controls horizontally or vertically.

    spacing

    Int32

    direction

    Orientation

    Indicates whether to arrange the Controls horizontally or vertically.

    viewArea

    Rectangle

    controls

    ICollection<Control>

    List of child controls to arrange. If null, all the children will be arranged.

    direction

    Orientation

    controls

    ICollection<Control>

    List of child controls to arrange. If null, all the children will be arranged.

    direction

    Orientation

    affectedControl

    Control

    A Control that represents the recently changed control.

    affectedProperty

    String

    point

    Point

    The screen coordinate Point to convert.

    point

    Point

    The client coordinate Point to convert.

    rect

    Rectangle

    The screen coordinate Rectangle to convert.

    rect

    Rectangle

    The client coordinate Rectangle to convert.

    refreshChildren

    Boolean

    True to also refresh all the children of this control.

    id

    Int32

    Id of the listener to remove.

    name

    String

    Name of the event.

    name

    String

    The css class name to remove.

    state

    String

    Name of the state to remove.

    performLayout

    Boolean

    true to apply all pending layout requests; otherwise, false.

    alignX

    HorizontalAlignment

    Indicates the HorizontalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Center will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement.

    alignY

    VerticalAlignment

    control

    Control

    The Control at which to start the search.

    forward

    Boolean

    x

    Int32

    The new Left property value of the control.

    y

    Int32

    x

    Int32

    The new Left property value of the control.

    y

    Int32

    flags

    ValidationConstraints

      this.fireWidgetEvent("myevent", {x:1, y:2, name:'test'});
      
      private void control_WidgetEvent(object sender, WidgetEventArgs e) {
        
        switch (e.Type) {
        
          case "myevent":
            var data = e.Data;
            Alert.Show($"x={data.x}, y={data.y}, name={data.name}");
            break;
        }
      }

    TableLayoutPanel

    Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.

    FileDialogUI

    UI implementation for the FileDialog class.

    FolderBrowserDialogUI

    IBindableComponent

    Bindable components implement this interface.

    IWisejComponent

    All wisej components implement this interface.

    IWisejControl

    AccessibleRole

    AllowDrag

    AllowDrop

    Anchor

    Anonymous

    AppearanceKey

    BackColor

    BackgroundImage

    BackgroundImageLayout

    BackgroundImageSource

    BecomingActiveControl

    BindingContext

    Bottom

    Bounds

    CanExecute

    CanFocus

    CanSelect

    Capture

    CausesValidation

    ClientEvents

    ClientRectangle

    ClientSize

    ContainsFocus

    ContextMenu

    Controls

    Created

    CssClass

    CssStyle

    Cursor

    DataBindings

    DefaultBackColor

    DefaultFont

    DefaultForeColor

    DisplayRectangle

    Disposing

    Dock

    Enabled

    EnableNativeContextMenu

    Focusable

    Focused

    Font

    ForeColor

    Handle

    HasChildren

    HasDataBindings

    HasResponsiveProfiles

    HasUserData

    Height

    InitScript

    IsDisposed

    IsHandleCreated

    IsMirrored

    LayoutEngine

    Left

    Location

    Margin

    MaximumSize

    MinimumSize

    ModifierKeys

    MouseButtons

    MousePosition

    Movable

    Name

    Padding

    Parent

    PreferredSize

    ResizableEdges

    ResponsiveProfiles

    Right

    RightToLeft

    The behavior of this property is configurable in Default.json setting the "rightToLeft" property to "true", "false", or "auto". The default is "auto", causing the value to be retrieved from the current language.

    Selectable

    ShowLoader

    Size

    States

    TabIndex

    TabStop

    Tag

    Text

    ToolTipText

    Top

    TopLevelControl

    UserData

    UseWaitCursor

    ValidationCancelled

    Visible

    WheelDelta

    Width

    Methods

    AddClientEventListener(name, script)

    AddCssClass(name)

    AddState(state)

    BeginInvoke(method)

    BeginInvoke(method, args)

    BringToFront()

    Call(function, args)

    Call(function, callback, args)

    CallAsync(function, args)

    CenterToParent()

    CenterToParent(horizontal, vertical)

    Contains(control)

    CreateControl()

    DoDragDrop(data, allowedEffects)

    DoDragDrop(data, allowedEffects, imageSource)

    DoDragDrop(data, allowedEffects, imageSource, imageSize)

    DoDragDrop(data, allowedEffects, image)

    DoDragDrop(data, allowedEffects, image, imageSize)

    EndInvoke(asyncResult)

    Eval(javaScript)

    Eval(javaScript, callback)

    EvalAsync(javaScript)

    FindForm()

    FindPage()

    Focus()

    GetChildAtPoint(pt, skipValue)

    GetChildAtPoint(pt)

    GetClientEventListener(id)

    GetClientEventListener(name)

    GetContainerControl()

    GetNextControl(control, forward)

    GetStyle(flag)

    HasClientEventListener(name)

    HasCssClass(name)

    HasState(state)

    Hide()

    Invalidate()

    Invalidate(invalidateChildren)

    Invoke(method)

    Invoke(method, args)

    IsMnemonic(charCode, text)

    LayoutChildren(dock, spacing, useMargins, hAlign, vAlign)

    LayoutChildren(dock, viewArea, spacing, useMargins, hAlign, vAlign)

    LayoutChildren(controls, dock, spacing, useMargins, hAlign, vAlign)

    LayoutChildren(controls, dock, viewArea, spacing, useMargins, hAlign, vAlign)

    LayoutChildren(direction, spacing, useMargins, hAlign, vAlign)

    LayoutChildren(direction, viewArea, spacing, useMargins, hAlign, vAlign)

    LayoutChildren(controls, direction, spacing, useMargins, hAlign, vAlign)

    LayoutChildren(controls, direction, viewArea, spacing, useMargins, hAlign, vAlign)

    PerformLayout()

    PerformLayout(affectedControl, affectedProperty)

    PointToClient(point)

    PointToScreen(point)

    RectangleToClient(rect)

    RectangleToScreen(rect)

    Refresh()

    Refresh(refreshChildren)

    RemoveClientEventListener(id)

    RemoveClientEventListener(name)

    RemoveCssClass(name)

    RemoveState(state)

    ResetBindings()

    ResumeLayout()

    ResumeLayout(performLayout)

    ScrollControlIntoView(alignX, alignY)

    ScrollControlIntoView()

    Select()

    SelectNextControl(control, forward, tabStopOnly, nested, wrap)

    SendToBack()

    SetBounds(x, y, width, height)

    SetBounds(x, y, width, height, specified)

    Show()

    SuspendLayout()

    Update()

    ValidateChildren(flags)

    ValidateChildren()

    Events

    Appear

    AutoSizeChanged

    BackColorChanged

    BackgroundImageChanged

    BackgroundImageLayoutChanged

    BecomingActiveControlChanged

    BindingContextChanged

    CausesValidationChanged

    Click

    ClientSizeChanged

    ContextMenuChanged

    ControlAdded

    ControlCreated

    ControlRemoved

    CursorChanged

    Disappear

    Disposed

    DockChanged

    DoubleClick

    DragDrop

    DragEnd

    DragEnter

    DragLeave

    DragOver

    DragStart

    EnabledChanged

    EndMove

    EndResize

    Enter

    FontChanged

    ForeColorChanged

    GotFocus

    HelpRequested

    ImeModeChanged

    KeyDown

    KeyPress

    KeyUp

    Layout

    Leave

    LocationChanged

    LongTap

    LostFocus

    MarginChanged

    MouseCaptureChanged

    MouseClick

    MouseDoubleClick

    MouseDown

    MouseEnter

    MouseHover

    MouseLeave

    MouseMove

    MouseUp

    MouseWheel

    PaddingChanged

    Paint

    ParentChanged

    Pinch

    PreviewKeyDown

    QueryContinueDrag

    Resize

    ResponsiveProfileChanged

    RightToLeftChanged

    Rotate

    SizeChanged

    StartMove

    StartResize

    StyleChanged

    Swipe

    TabIndexChanged

    TabStopChanged

    Tap

    TextChanged

    TouchCancel

    TouchEnd

    TouchMove

    TouchStart

    Track

    Validated

    Validating

    VisibleChanged

    WidgetEvent

    Inherited By

    Implements

    String
    AccessibleRole
    Boolean
    Boolean
    AnchorStyles
    Boolean
    String
    Color
    Image
    ImageLayout
    ImageLayout
    String
    Boolean
    BindingContext
    BindingContext
    Int32
    Rectangle
    Boolean
    Boolean
    Boolean
    Boolean
    Boolean
    ClientEventCollection
    AddClientEventListener
    HasClientEventListener
    RemoveClientEventListener
    Rectangle
    Size
    Boolean
    ContextMenu
    ControlCollection
    Boolean
    String
    StyleSheet
    AddCssClass
    RemoveCssClass
    HasCssClass
    String
    Cursor
    ControlBindingsCollection
    Color
    Font
    Color
    Rectangle
    Boolean
    DockStyle
    Boolean
    Boolean
    Boolean
    Boolean
    Font
    Color
    IntPtr
    Boolean
    Boolean
    Boolean
    Boolean
    UserData
    Int32
    String
    #qx
    wisej-js
    ClientEvents
    AddClientEventListener
    HasClientEventListener
    RemoveClientEventListener
    Boolean
    Boolean
    Boolean
    LayoutEngine
    Int32
    Point
    Padding
    Size
    Size
    Keys
    MouseButtons
    Point
    Boolean
    String
    Padding
    Control
    Size
    AnchorStyles
    ResponsiveProfileCollection
    Int32
    RightToLeft
    Inherit
    Inherit
    Boolean
    Selectable
    Focusable
    Selectable
    Boolean
    Size
    String[]
    AddState
    RemoveState
    HasState
    Int32
    Boolean
    Focusable
    Object
    String
    String
    ToolTipText
    ToolTip
    ToolTipText
    ForeColor
    AutomaticDelay
    InitialDelay
    AutoPopDelay
    ToolTipText
    ToolTip
    ToolTipText
    Int32
    Control
    Form
    Form
    Object
    Boolean
    Boolean
    Boolean
    Int32
    Int32
    Int32
    RemoveClientEventListener
    GetClientEventListener
    CssClass
    String
    CssClass
    String[]
    States
    States
    IAsyncResult
    IAsyncResult
    BeginInvoke
    IAsyncResult
    IAsyncResult
    Task
    Task<Object>
    Task
    Boolean
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    Object
    Task
    Task<Object>
    Task
    Form
    Page
    Boolean
    Control
    Control
    Control
    Control
    String
    String[]
    IContainerControl
    IContainerControl
    IContainerControl
    Control
    Control
    Boolean
    Boolean
    CssClass
    Boolean
    CssClass
    States
    Boolean
    Object
    Object
    Object
    Boolean
    Control
    Control
    Control
    Control
    Control
    Control
    ArgumentException
    ArgumentException
    Point
    Point
    Point
    Point
    Point
    Point
    Rectangle
    Rectangle
    Rectangle
    Rectangle
    Rectangle
    Rectangle
    Boolean
    Boolean
    CssClass
    String
    CssClass
    String[]
    States
    States
    Boolean
    Boolean
    Validating
    Validated
    Selectable
    Boolean
    Validating
    Validated
    EventHandler
    Appear
    Disappear
    EventHandler
    AutoSize
    EventHandler
    BackColor
    EventHandler
    BackgroundImage
    EventHandler
    BackgroundImageLayout
    EventHandler
    BecomingActiveControl
    EventHandler
    BindingContext
    EventHandler
    CausesValidation
    EventHandler
    EventHandler
    ClientSize
    EventHandler
    ContextMenu
    ControlEventHandler
    ControlCollection
    EventHandler
    ControlEventHandler
    ControlCollection
    EventHandler
    Cursor
    EventHandler
    Appear
    Disappear
    EventHandler
    EventHandler
    Dock
    EventHandler
    DragEventHandler
    EventHandler
    DragEventHandler
    EventHandler
    DragEventHandler
    EventHandler
    EventHandler
    Enabled
    EventHandler
    Movable
    Movable
    Location
    EventHandler
    ResizableEdges
    ResizableEdges
    None
    Size
    EventHandler
    EventHandler
    Font
    EventHandler
    ForeColor
    EventHandler
    HelpEventHandler
    EventHandler
    KeyEventHandler
    KeyPressEventHandler
    KeyEventHandler
    LayoutEventHandler
    EventHandler
    EventHandler
    Location
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    MouseEventHandler
    MouseEventHandler
    MouseEventHandler
    EventHandler
    EventHandler
    EventHandler
    MouseEventHandler
    MouseEventHandler
    MouseEventHandler
    EventHandler
    PaintEventHandler
    EventHandler
    Parent
    PinchEventHandler
    PreviewKeyDownEventHandler
    KeyDown
    QueryContinueDragEventHandler
    EventHandler
    ResponsiveProfileChangedEventHandler
    EventHandler
    RightToLeft
    RotateEventHandler
    EventHandler
    Size
    EventHandler
    Movable
    Movable
    EventHandler
    ResizableEdges
    ResizableEdges
    None
    EventHandler
    SwipeEventHandler
    EventHandler
    TabIndex
    EventHandler
    TabStop
    EventHandler
    EventHandler
    Text
    TouchEventHandler
    TouchEventHandler
    TouchEventHandler
    TouchEventHandler
    TrackEventHandler
    EventHandler
    CancelEventHandler
    EventHandler
    Visible
    WidgetEventHandler

    JavaScript code to execute when the event occurs.

    An optional array of objects to pass as arguments to the specified method.

    The arguments to pass to the function.

    Asynchronous callback method that receives the return value.

    The arguments to pass to the function.

    Center vertically.

    One of the values.

    One of the values.

    One of the values.

    One of the values.

    One of the values.

    Asynchronous callback method that receives the return value.

    One of the values of , determining whether to ignore child controls of a certain type.

    true to search forward in the tab order; false to search backward.

    An array of objects to pass as arguments to the specified method. This parameter can be null if the method takes no arguments.

    The string to search.

    Spacing between the .

    Rectangle limiting the area to arrange the in. If empty, it will use .

    Indicates whether to arrange the horizontally or vertically.

    Indicates whether to arrange the horizontally or vertically.

    Spacing between the .

    Rectangle limiting the area to arrange the in. If empty, it will use .

    Indicates whether to arrange the controls horizontally or vertically.

    Indicates whether to arrange the controls horizontally or vertically.

    The name of the recently changed property on the control that caused the layout to change.

    Indicates the preference. The final location of the control depends on the scrollable range and the available space. Note that will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement.

    true to move forward in the tab order; false to move backward in the tab order.

    The new property value of the control.

    The new property value of the control.

    UI implementation for the FolderDialog class.

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

    Object[]
    DragDropEffects
    DragDropEffects
    String
    DragDropEffects
    String
    Size
    DragDropEffects
    Image
    Image
    DragDropEffects
    Image
    Image
    Size
    GetChildAtPointSkip
    Controls
    Boolean
    Margin
    HorizontalAlignment
    Fill
    Top
    Bottom
    VerticalAlignment
    Fill
    Left
    Right
    Controls
    DisplayRectangle
    Int32
    Controls
    Boolean
    Margin
    HorizontalAlignment
    Fill
    Top
    Bottom
    VerticalAlignment
    Fill
    Left
    Right
    Controls
    Int32
    Controls
    Boolean
    Margin
    HorizontalAlignment
    Fill
    Top
    Bottom
    VerticalAlignment
    Fill
    Left
    Right
    Controls
    Rectangle
    Controls
    DisplayRectangle
    Int32
    Controls
    Boolean
    Margin
    HorizontalAlignment
    Fill
    Top
    Bottom
    VerticalAlignment
    Fill
    Left
    Right
    Controls
    Boolean
    Margin
    HorizontalAlignment
    Vertical
    VerticalAlignment
    Horizontal
    Controls
    DisplayRectangle
    Int32
    Controls
    Boolean
    Margin
    HorizontalAlignment
    Vertical
    VerticalAlignment
    Horizontal
    Int32
    Boolean
    Margin
    HorizontalAlignment
    Vertical
    VerticalAlignment
    Horizontal
    Rectangle
    DisplayRectangle
    Int32
    Boolean
    Margin
    HorizontalAlignment
    Vertical
    VerticalAlignment
    Horizontal
    VerticalAlignment
    Middle
    Boolean
    TabStop
    Boolean
    Boolean
    Top
    Int32
    Width
    Int32
    Height
    Top
    Int32
    Width
    Int32
    Height
    BoundsSpecified
    BoundsSpecified
    BindingNavigator
    Button
    ButtonBase
    CheckBox
    CheckedListBox
    ListBox
    ComboBox
    ContainerControl
    DateTimePicker
    DomainUpDown
    FlowLayoutPanel
    Form
    GroupBox
    Label
    LinkLabel
    ListBox
    ListControl
    ListBox
    ComboBox
    MaskedTextBox
    MdiClient
    MonthCalendar
    NumericUpDown
    Page
    Panel
    PictureBox
    ProgressBar
    RadioButton
    RadioButton
    ScrollableControl
    HScrollBar
    VScrollBar
    ScrollBar
    SplitContainer
    SplitterPanel
    SplitContainer
    TabControl
    TabPage
    TabPage
    TabControl
    TextBox
    TextBoxBase
    TrackBar
    UpDownBase
    UserControl
    WebBrowser
    DataGridViewComboBoxEditingControl
    ComboBox
    DataGridViewComboBoxCell
    DataGridViewDateTimePickerEditingControl
    DateTimePicker
    DataGridViewDateTimePickerCell
    DataGridViewMaskedTextBoxEditingControl
    MaskedTextBox
    DataGridViewMaskedTextBoxCell
    DataGridViewNumericUpDownEditingControl
    NumericUpDown
    DataGridViewNumericUpDownCell
    DataGridViewTextBoxEditingControl
    TextBox
    DataGridViewTextBoxCell
    WrapMode
    False
    DataGridView
    DataRepeater
    DataRepeaterItem
    DataRepeater
    Desktop
    Accordion
    AccordionPanel
    AccordionPanel
    Accordion
    AspNetPanel
    Canvas
    FlashPlayer
    FlashPlayer
    FlexLayoutPanel
    HtmlPanel
    IFramePanel
    Line
    ListViewComboBox
    UserComboBox
    ListView
    Media
    Video
    Video
    Audio
    Audio
    PdfViewer
    PdfViewer
    Shape
    SlideBar
    Spacer
    SplitButton
    TagTextBox
    TimeUpDown
    TimeSpan
    TreeViewComboBox
    UserComboBox
    TreeView
    Upload
    UserComboBox
    ComboBox
    UserPopup
    Widget
    ListView
    MenuBar
    PropertyGrid
    StatusBar
    ToolBar
    TreeView
    TreeNode
    Control
    IWisejSerializable