1 of 100

v3.0

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.

Static method or property or event.

Protected method or property or event.

Deprecated method or property or event.

Concepts & Reference

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.

Skills

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

C# or VB.NET
.NET in general
Visual Studio
JavaScript

Wisej.Web

General

Client

Wisej.Core.Client

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents a unique client using the application.

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

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

ID

: Unique client ID.

IPAddress

: IP Address of the client computer.

SessionCount

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

ClientCollection

Wisej.Core.ClientCollection

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

List of s using the application.

Constructors

ClientCollection()

Properties

Count

: Returns the total number of items in the collection.

Item(index)

: Returns the at the specified index .

ClientProfile

Wisej.Core.ClientProfile

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Definition of the client device.

Fields

Name

Type

Description

Properties

Device

: Device type.

Landscape

: Device landscape mode.

MaxScreenWidth

: Maximum screen width.

MaxWidth

: Maximum browser width.

MinScreenWidth

: Minimum screen width.

MinWidth

: Minimum browser width.

Name

: Name of the profile.

UserAgent

: User agent string.

LoadConfigurationEventArgs

Wisej.Core.LoadConfigurationEventArgs

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Specifies the event arguments for the event.

Properties

FilePath

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

SuppressCache

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

Used By

Name

Description

LoadConfigurationEventHandler

Wisej.Core.LoadConfigurationEventHandler

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents a method that handles the event.

Parameters

Name

Type

Description

Fired By

Name

Description

PlatformProvider

Wisej.Core.PlatformProvider

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Platforms supported by Wisej.

Fields

Name

Description

Used By

Name

Description

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.

Public Class FormCollection
    Inherits ICollection
    Implements IEnumerable

Properties

Count

Int32: Returns the total number of currently open forms.

Item(index)

Form: Returns the form at the specified index.

Item(name)

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

Methods

GetEnumerator()

Returns an enumerator that iterates through the open forms.

Returns: IEnumerator.

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.

Properties

Count

: Returns the total number of currently open pages.

Item(index)

: Returns the page at the specified index.

Item(name)

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

Methods

GetEnumerator()

Returns an enumerator that iterates through the open pages.

Returns: .

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the HashChanged event.

Public Class HashChangedEventArgs
    Inherits EventArgs

Constructors

HashChangedEventArgs(value)

Initializes a new instance of the HashChangedEventArgs class.

Name

Type

Description

value

Initial hash value.

Properties

Hash

String: The hash string from the client.

Used By

Name

Description

Represents the method that will handle the event.

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

LicenseErrorEventArgs

Wisej.Web.LicenseErrorEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the LicenseError event.

Public Class LicenseErrorEventArgs
    Inherits EventArgs

Constructors

LicenseErrorEventArgs(error)

Initializes a new instance of the LicenseErrorEventArgs class.

Name

Type

Description

error

License error.

Properties

Error

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

LicenseErrorEventHandler

Wisej.Web.LicenseErrorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

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
    Inherits EventArgs

Constructors

ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the ResponsiveProfileChangedEventArgs class.

Name

Type

Description

oldValue

Previous .

newValue

New active .

Properties

CurrentProfile

ClientProfile: The new active profile.

PreviousProfile

ClientProfile: The previously active profile.

Used By

Name

Description

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

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 Sub ResponsiveProfileChangedEventHandler(ByVal sender As [Object], ByVal e As ResponsiveProfileChangedEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Fired when the active responsive profile is changed.

ControlEventHandler

Wisej.Web.ControlEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the and events of the class.

Parameters

Name

Type

Description

Fired By

Name

Description

DragEventHandler

Wisej.Web.DragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the DragDrop, DragEnter, or DragOver event of a Control.

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

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

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

HelpEventArgs

Wisej.Web.HelpEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the HelpRequested event.

Public Class HelpEventArgs
    Inherits EventArgs

Constructors

HelpEventArgs(target)

Initializes a new instance of the HelpEventArgs class.

Name

Type

Description

target

The that had the focus when the user pressed F1.

Properties

Handled

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

Target

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

Used By

Name

Description

Represents the method that will handle the event of a .

HelpEventHandler

Wisej.Web.HelpEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

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

Parameters

Name

Type

Description

sender

The source of the event.

hlpevent

A object that contains the event data.

Fired By

Name

Description

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

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.

Public Class ClientEvent

Constructors

ClientEvent()

Properties

Event

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

JavaScript

String: Returns or sets the JavaScript handler for the event.

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 .

Parameters

Name

Type

Description

Fired By

Name

Description

KeyPressEventArgs

Wisej.Web.KeyPressEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Constructors

KeyPressEventArgs(keyChar)

Initializes a new instance of the class.

Name

Type

Description

Properties

Handled

: Returns or sets whether the event was handled.

KeyChar

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

Used By

Name

Description

KeyPressEventHandler

Wisej.Web.KeyPressEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

Parameters

Name

Type

Description

Fired By

Name

Description

LayoutEventHandler

Wisej.Web.LayoutEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

Parameters

Name

Type

Description

Fired By

Name

Description

PaintEventArgs

Wisej.Web.PaintEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Constructors

PaintEventArgs(graphics, clipRect)

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

Name

Type

Description

Properties

ClipRectangle

: Returns the rectangle in which to paint.

Graphics

: Returns the graphics used to paint.

Used By

Name

Description

PaintEventHandler

Wisej.Web.PaintEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

Parameters

Name

Type

Description

Fired By

Name

Description

PinchEventArgs

Wisej.Web.PinchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for event.

Properties

Scale

: Returns the calculated scale factor.

Used By

Name

Description

PinchEventHandler

Wisej.Web.PinchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

PreviewKeyDownEventHandler

Wisej.Web.PreviewKeyDownEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the PreviewKeyDown event.

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

QueryContinueDragEventArgs

Wisej.Web.QueryContinueDragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Constructors

QueryContinueDragEventArgs(args)

Initializes a new instance of the class.

Name

Type

Description

Properties

Action

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

EscapePressed

: Returns if the user pressed the ESC key.

KeyState

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

Used By

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 Sub QueryContinueDragEventHandler(ByVal sender As [Object], ByVal e As QueryContinueDragEventArgs)

Parameters

Name

Type

Description

sender

The source of an event.

A that contains the event data.

Fired By

Name

Description

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

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

Parameters

Name

Type

Description

Fired By

Name

Description

RotateEventArgs

Wisej.Web.RotateEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for Rotate event.

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

Represents the method that will handle the event.

RotateEventHandler

Wisej.Web.RotateEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Rotate event.

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

SwipeAxis

Wisej.Web.SwipeAxis

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Indicates the axis of the swipe gesture.

Fields

Name

Description

Used By

Name

Description

SwipeDirection

Wisej.Web.SwipeDirection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Indicates the direction of the swipe gesture.

Fields

Name

Description

Used By

Name

Description

SwipeEventHandler

Wisej.Web.SwipeEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

TouchEventArgs

Wisej.Web.TouchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for event.

Properties

Identifiers

: Returns the unique identifiers for the touch items.

IsMultiTouch

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

Locations

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

Rotation

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

Scale

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

Used By

Name

Description

TouchEventHandler

Wisej.Web.TouchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the , , , events.

Parameters

Name

Type

Description

Fired By

Name

Description

TrackEventArgs

Wisej.Web.TrackEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for event.

Properties

Axis

: Returns the Axis of the track event.

Location

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

X

: Returns the X delta of the track event.

Y

: Returns Y delta of the track event.

Used By

Name

Description

TrackEventHandler

Wisej.Web.TrackEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

WidgetEventArgs

Wisej.Web.WidgetEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Constructors

WidgetEventArgs(type, data)

Initializes a new instance of the class.

Name

Type

Description

Properties

Data

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

Type

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

Used By

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

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

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

ServiceScope

Wisej.Web.ServiceScope

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

EXPERIMENTAL: Specifies the scope of services added using .

Fields

Name

Description

Used By

Name

Description

Buttons

MenuButtonItemClickedEventArgs

Wisej.Web.MenuButtonItemClickedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Constructors

MenuButtonItemClickedEventArgs(item)

Initializes a new instance of the class.

Name

Type

Description

Properties

Item

: Returns the clicked menu item.

Used By

Name

Description

Common Dialogs

FileDialogRootCollection

Wisej.Web.FileDialogRootCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

Methods

MapPath(filePath)

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

Parameter

Type

Description

Returns: . The physical path for the implementation.

Containers

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.

Parameters

Name

Type

Description

Fired By

Name

Description

AccordionEventHandler

Wisej.Web.AccordionEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

Parameters

Name

Type

Description

Fired By

Name

Description

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 Stylesheet. 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 ToJSON extension method added to all objects by the Wisej framework.

Constructors

ClientTheme(name)

Default private constructor.

Name

Type

Description

name

Unique name of the theme.

ClientTheme(name, json)

Constructs a new theme from the name and JSON definition.

Name

Type

Description

name

Unique name of the theme.

json

JSON definition of the theme.

ClientTheme(name, baseTheme)

Constructs a new theme from the base theme.

Name

Type

Description

name

Unique name of the theme.

baseTheme

Original theme to copy into the new theme.

Properties

Appearances

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

// 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;

Colors

Object: Theme colors.

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


// 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";

Fonts

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


// make the window title bigger and bold.
Application.Theme.Fonts.windowTitle.size = 18;
Application.Theme.Fonts.windowTitle.bold = true;

Images

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

Name

String: The name of the theme.

Settings

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

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


// create a custom css rules in the theme.
Application.Theme.Stylesheet.rules = new []{

  "body: { background-color: red };",
  ".myClass: { background-color: red };"
};

Methods

GetColor(appearance, name, state)

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

Parameter

Type

Description

appearance

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

name

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

state

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

Returns: Color. A Color representing the color in the theme.

GetColor(name)

Returns the resolved theme color from the color list.

Parameter

Type

Description

name

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

Returns: Color. A Color representing the color in the theme.

GetFont(appearance, name, state)

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

Parameter

Type

Description

appearance

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

name

The name of the property value to query.

state

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

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

GetFont(name)

Returns the resolved font defined from the font list.

Parameter

Type

Description

name

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

GetImage(appearance, name, state)

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

Parameter

Type

Description

appearance

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

name

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

state

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

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

GetImage(name)

Returns the resolved image defined from the image list.

Parameter

Type

Description

name

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

GetInsets(appearance, state, includePadding)

Returns the size of the inset border and padding.

Parameter

Type

Description

appearance

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

state

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

includePadding

Whether to include padding in the insets dimension.

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

GetProperty<T>(appearance, name, state)

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

Parameter

Type

Description

The of the value to retrieve.

appearance

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

name

The name of the property to retrieve.

state

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

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

GetStyle<T>(appearance, name, state)

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

Parameter

Type

Description

The of the value to retrieve.

appearance

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

name

The name of the property to retrieve.

state

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

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

IsThemeColor(color)

Returns true if the color is a theme color.

Parameter

Type

Description

color

Color to check.

Returns: Boolean. True if color is a theme color.

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

IsThemeFont(font)

Returns true if the font is a theme font.

Parameter

Type

Description

font

Font to check.

Returns: Boolean. True if font is a theme font.

Theme fonts (font's with the OriginalFontName 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 OriginalFontName 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.

TranslateColor(color)

Returns the resolved Color 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

color

The to resolve to a usable value.

Returns: Color. A Color instance with the resolved RGB values.

TranslateFont(font)

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

Parameter

Type

Description

font

The to resolve to a usable instance.

Returns: Font. A Font instance that can be used directly.

Implements

Name

Description

Allows an object to serialize itself.

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, IDisposable, IWisejSynchronized, IServiceProvider

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 Session to store and retrieve session variable. The property is a dynamic object and a Dictionary, therefore you can access its properties directly or through the indexer.

    Application.Session.myValue = 12;
    Application.Session["myValue"] = 12;

Manage cookies. Use Cookies to manage browser's cookies.
Read server variables. Use ServerVariables to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: ServerPort, ServerName, UserAgent, etc.
Read the application's URL. Use Uri, Url, StartupUri, and StartupUrl.
Read the applications's system information. Use StartupPath, ProductName, ProductVersion, etc.
Listen to the application's global events. See SessionTimeout , BeginRequest, ApplicationStart, ApplicationExit ApplicationRefresh, BrowserSizeChanged ResponsiveProfileChanged, 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.

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

Properties

ActiveProfile

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

Browser

ClientBrowser: Returns or sets the client browser information.

ClientId

String: Returns the current unique client id.

Clients

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

CommonAppDataPath

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

CommonAppDataRegistry

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

CompanyName

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

Configuration

Configuration: Returns the current Configuration.

Cookies

CookieCollection: Collection of cookies.

Current

IWisejComponent: 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 Update method.

Threads that are not started using StartTask don't have any knowledge of the current session and don't have a way to communicate with the client The Current property returns the instance of the Application class that is bound to the current session. It can be used just like any other component with the method Update or RunInContext to restore the session for the current thread. The advantage of using Current 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.

var current = Application.Current;
var thread = new Thread(() => {
  Application.Update(current, () => {
  
    // code here is running in context.
    
  });
});

CurrentCulture

CultureInfo: Returns or sets the current CultureInfo for the session.

Desktop

Desktop: Returns or sets the current Desktop.

EnableUnloadConfirmation

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

ExecutablePath

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

FavIcon

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

FavIconSource

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

Hash

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

IsAuthenticated

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

IsDisposed

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

IsExpired

Boolean: Returns true when the current session has expired.

IsSecure

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

IsTerminated

Boolean: Returns true when the current session has been terminated.

IsWebSocket

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

LicenseKey

String: Returns or sets the runtime server license key.

Setting the LicenseKey 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).

static class Program
{
  static Program()
  {
    Application.LicenseKey = "...";
  }
}

MainPage

Page: Returns or sets the current full page window.

OpenForms

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

OpenPages

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

Platform

ClientPlatform: The name of the currently loaded platform.

ProductName

String: Returns the product name associated with this application.

ProductVersion

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

QueryString

NameValueCollection: Returns the parameters used to launch the application.

RightToLeft

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

RuntimeMode

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

ServerName

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

ServerPort

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

ServerVariables

NameValueCollection: Returns the server variables.

Session

Object: Provides a generic storage for session-based objects.

SessionCount

Int32: Returns the total number of currently active sessions.

SessionId

String: Returns the unique current session ID.

ShowConsole

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

ShowLoader

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

StartupPath

String: Returns the root path of the web application.

StartupUri

Uri: Returns the URI used to start the application.

StartupUrl

String: Returns the URL used to start the application.

Theme

ClientTheme: Returns or sets the current ClientTheme.

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

// 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;

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


// 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";

Title

String: Returns or sets the page title in the browser.

Uri

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

Url

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

User

IPrincipal: Returns the security information for the current request.

UserAgent

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

UserHostAddress

String: Returns the IP host address of the remote client.

UserHostName

String: Returns the DNS name of the remote client.

UserIdentity

WindowsIdentity: Returns the WindowsIdentity type for the current user.

UserLanguages

String[]: Gets a sorted string array of client language preferences.

Methods

AddEventFilter(filter)

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

Parameter

Type

Description

filter

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

AddService(serviceType, serviceInstance, scope)

EXPERIMENTAL: Adds a scoped service to the service container.

Parameter

Type

Description

serviceType

Type of the service to add.

serviceInstance

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

scope

Scope of the serviceInstance .

Throws:

ArgumentNullException serviceType is null.
ArgumentException A service of type serviceType already exists.

AddService(serviceType, callback, scope)

EXPERIMENTAL: Adds a scoped service to the service container.

Parameter

Type

Description

serviceType

Type of the service to add.

callback

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.

scope

Scope of the service.

Throws:

ArgumentNullException serviceType is null.
ArgumentException A service of type serviceType already exists.

AddTranslation(text, translation)

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

Parameter

Type

Description

text

The text to translate.

translation

The translation override.

AlertAsync(message)

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

Parameter

Type

Description

message

A string you want to display in the alert dialog.

Returns: Task. An awaitable Task that represents the asynchronous operation.

Call(function, callback, args)

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

Parameter

Type

Description

function

The name of the function to execute.

callback

Asynchronous callback method that receives the return value.

args

The arguments to pass to the function.

Call(function, args)

Executes the JavaScript function on the client.

Parameter

Type

Description

function

The name of the function to execute.

args

The arguments to pass to the function.

CallAsync(function, args)

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

Parameter

Type

Description

function

The name of the function to execute.

args

The arguments to pass to the function.

Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.

CancelFullScreen()

Cancels the fullscreen mode.

ConfirmAsync(message)

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

message

A string you want to display in the confirm dialog.

Returns: Task<Boolean>. An awaitable Task that represents the asynchronous operation.

Download(filePath, fileName, ondownload)

Downloads the specified file on the client.

Parameter

Type

Description

filePath

The file to download.

fileName

The name of the file to save on the client.

ondownload

Optional callback invoked when fileName is downloaded.

Download(image, fileName, ondownload)

Downloads the specified image to the client.

Parameter

Type

Description

image

The image to download.

fileName

The name of the file to save on the client.

ondownload

Optional callback invoked when fileName is downloaded.

Download(stream, fileName, ondownload)

Downloads the bytes in the stream to the client.

Parameter

Type

Description

stream

The stream to send to the client.

fileName

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

ondownload

Optional callback invoked when fileName is downloaded.

DownloadAndOpen(target, filePath, fileName, ondownload)

Downloads the specified file on the client.

Parameter

Type

Description

target

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

The file to download.

fileName

The name of the file to save on the client.

ondownload

Optional callback invoked when fileName is downloaded.

DownloadAndOpen(target, image, fileName, ondownload)

Downloads the specified image to the client.

Parameter

Type

Description

target

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

The image to download.

fileName

The name of the file to save on the client.

ondownload

Optional callback invoked when fileName is downloaded.

DownloadAndOpen(target, stream, fileName, ondownload)

Downloads the bytes in the stream to the client.

Parameter

Type

Description

target

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

The stream to send to the client.

fileName

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

ondownload

Optional callback invoked when fileName is downloaded.

EndPolling()

Stops the polling requests from the client.

Eval(script)

Executes the JavaScript script on the client.

Parameter

Type

Description

script

The script to evaluate.

Eval(script, callback)

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

Parameter

Type

Description

script

The script to evaluate.

callback

Asynchronous callback method that receives the return value.

EvalAsync(script)

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

Parameter

Type

Description

script

The script to evaluate.

Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.

Exit()

Terminates the application and the corresponding session.

FindComponent(match)

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

Parameter

Type

Description

match

A custom expression used to match the to find.

Returns: IWisejComponent. The first IWisejComponent qualified by the match expression.

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

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

FindComponents(match)

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

Parameter

Type

Description

match

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

Returns: IList<IWisejComponent>. The list of IWisejComponent instances qualified by the match expression.

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

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

GetService<T>()

EXPERIMENTAL: Returns the requested service.

Parameter

Type

Description

Type of the service to retrieve.

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

GetService(serviceType)

EXPERIMENTAL: Returns the requested service.

Parameter

Type

Description

serviceType

Type of the service to add.

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

Throws:

ArgumentNullException serviceType is null.

LoadAssembly(nameOrFile)

Loads an assembly given the file name or path.

Parameter

Type

Description

nameOrFile

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

Returns: Assembly. The loaded Assembly.

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.

LoadComponent(nameOrFile, className)

Creates an instance of the specified component from the assembly.

Parameter

Type

Description

nameOrFile

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

className

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

LoadPackages(packages, callback)

Parameter

Type

Description

packages

callback

LoadPackagesAsync(packages)

Parameter

Type

Description

packages

Returns: Task<Boolean>.

LoadTheme(name, mixins)

Changes the current theme.

Parameter

Type

Description

name

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

mixins

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

MapPath(path)

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

Parameter

Type

Description

path

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

Navigate(url, target)

Navigate to the specified URL.

Parameter

Type

Description

url

URL to navigate to.

target

The target browser window: _self, _blank, etc.

Play(type)

Plays one of the built-in sounds

Parameter

Type

Description

type

One of value that identifies the sound to play.

Play(soundUrl)

Plays a sound.

Parameter

Type

Description

soundUrl

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

Post(callback)

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

Parameter

Type

Description

callback

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

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.


void Test() {

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

Print(control)

Prints the specified control.

Parameter

Type

Description

control

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

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

Print()

Prints the entire browser window.

PromptAsync(message, defaultValue)

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

message

A string of text to display to the user.

defaultValue

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

Returns: Task<String>. An awaitable Task that represents the asynchronous operation.

Reload()

Causes the application to reload on the browser.

RemoveEventFilter(filter)

Removes the filter from the list of registered event filters.

Parameter

Type

Description

filter

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

RemoveService(serviceType)

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

Parameter

Type

Description

serviceType

Type of the service to remove.

Throws:

ArgumentNullException serviceType is null.

RequestFullScreen()

Requests the browser to enable fullscreen mode if supported.

RunInContext(context, action)

Executes the callback in context.

Parameter

Type

Description

context

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

action

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.

SetSessionTimeout(seconds)

Sets the current session timeout in seconds.

Parameter

Type

Description

seconds

StartPolling(interval)

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

interval

Polling interval in milliseconds. The minimum is 1000ms.

Calling this method when IsWebSocket 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 EndPolling to reduce the incoming requests from the client.


// 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();

});

Throws:

ArgumentOutOfRangeException The interval specified is less than 1.

StartTask(action)

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

Parameter

Type

Description

action

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

Returns: Task. An awaitable Task.

The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the Update 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 Timer component to the parent container to force period requests to the server, or you can use the StartPolling and EndPolling methods.

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);
  }
});

StartTask<T>(action)

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

Parameter

Type

Description

action

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

Returns: Task<T>.

The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the Update method to push the UI updates to the client browser. The generics overload of StartTask 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 Timer component to the parent container to force period requests to the server, or you can use the StartPolling and EndPolling methods.

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);

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.

StartTimer(dueTime, period, callback)

Starts a Timer bound to the current session context.

Parameter

Type

Description

dueTime

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

period

The time interval between invocations, in milliseconds.

callback

A callback method to invoke at the specified intervals.

Returns: Timer. An instance of Timer.

You must save a reference to the returned Timer 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 system.threading.

Update(context, action)

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

Parameter

Type

Description

context

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

action

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.

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:

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);

});

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:

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);
      }
    });

});

Events

ActiveWindowChanged

EventHandler Fired when the active window changes.

ApplicationExit

EventHandler Fired when the application is about to shut down.

ApplicationRefresh

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

ApplicationStart

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

BeforeInstallPrompt

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

BeginRequest

EventHandler Fired at the beginning of every request.

BrowserSizeChanged

EventHandler Fired when the user resizes the browser.

BrowserTabActivated

EventHandler Fired when the user activates the browser tab.

BrowserTabDeactivated

EventHandler Fired when the user deactivates the browser tab.

CultureChanged

EventHandler Fired when the CurrentCulture changes.

EndRequest

EventHandler Fired at the end of every request.

FocusedControlChanged

EventHandler Fired when the focused control changes.

HashChanged

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

Idle

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

ImpersonationBegin

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

ImpersonationEnd

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

LicenseError

LicenseErrorEventHandler Fired when a license error occurs.

ResponsiveProfileChanged

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

RightToLeftChanged

EventHandler Fired when the RightToLeft value changes.

SessionTimeout

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

ThemeChanged

EventHandler Fired when the current theme is changed.

ThreadException

ThreadExceptionEventHandler Fired when a thread exception is thrown.

Implements

Name

Description

All wisej components implement this interface.

Control

Wisej.Web.Control

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Base class for all Wisej controls.

public class Control : IWisejControl, IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfiles

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

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

AccessibleRole

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

AllowDrag

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

AllowDrop

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

Anchor

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

Anonymous

Boolean: Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents.

AppearanceKey

String: Sets the appearance key for the theme engine.

BackColor

Color: Returns or sets the background color for the control.

BackgroundImage

Image: Returns or sets the background image displayed in the control.

BackgroundImageLayout

ImageLayout: Returns or sets the background image layout as defined in the ImageLayout enumeration.

BackgroundImageSource

String: Returns or sets the background image displayed in the control.

BecomingActiveControl

Boolean: Returns a flag indicating that the control is becoming the active control.

BindingContext

BindingContext: Returns or sets the BindingContext for the control.

Bottom

Int32: Returns the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.

Bounds

Rectangle: Returns or sets the size and location of the control including its non-client area, in pixels and relative to the parent control.

CanExecute

Boolean: Determines whether the control can execute a command.

CanFocus

Boolean: Returns whether the control can receive focus.

CanSelect

Boolean: Returns whether the control can be selected.

Capture

Boolean: Returns or sets whether the control has captured the mouse.

CausesValidation

Boolean: Returns or sets whether the control causes validation to be performed on controls that require to be validated when this control receives focus.

ClientEvents

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

AddClientEventListener
HasClientEventListener
RemoveClientEventListener
RemoveClientEventListener
GetClientEventListener

ClientRectangle

Rectangle: Returns the client rectangle of the control.

ClientSize

Size: Returns or sets the height and width of the client area.

ContainsFocus

Boolean: Indicates whether the control, or one of its child controls, has the input focus.

ContextMenu

ContextMenu: Returns or sets the shortcut menu associated with the control.

Controls

ControlCollection: Returns the collection of controls contained within the control.

Created

Boolean: Returns a value indicating whether the control has been created.

CssClass

String: 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 StyleSheet extender. You can assign multiple class names separated by a space and you can manage this property using the related methods:

AddCssClass
RemoveCssClass
HasCssClass

CssStyle

String: Returns or sets the custom CSS styles to add to the widget.

You can use any CSS style string.


  // set the border radius to 100% and make the control round.
  this.button1.CssStyle = "border-radius:100%";

Cursor

Cursor: Returns or sets the cursor that is displayed when the mouse pointer is over the control.

DataBindings

ControlBindingsCollection: Returns the data bindings for the control.

DefaultBackColor

Color: Returns the default background color of the control.

DefaultFont

Font: Returns the default font of the control.

DefaultForeColor

Color: Returns the default background color of the control.

DisplayRectangle

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

Disposing

Boolean: Returns whether the control is in the process of disposing itself and child controls.

Dock

DockStyle: Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent.

Enabled

Boolean: Returns or sets whether the control can respond to user interaction.

EnableNativeContextMenu

Boolean: Enables or disables the browser's context menu.

Focusable

Boolean: Returns or sets whether the control can gain the focus.

Focused

Boolean: Returns a value indicating whether the control has input focus.

Font

Font: Gets or sets the font of the text displayed by the control.

ForeColor

Color: Returns or sets the text color of the control.

Handle

IntPtr: Returns the unique server-side id (handle) for this component.

HasChildren

Boolean: Returns whether the control contains any child control.

HasDataBindings

Boolean: Returns whether the control specifies data bindings.

HasResponsiveProfiles

Boolean: Check if the control defines any responsive profile without forcing the creation of the collection.

HasUserData

Boolean: Checks if the UserData dynamic object was created and has any value.

Height

Int32: Returns or sets the height of the control.

InitScript

String: 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 #qx and wisej-js.

  // 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.');
    }
  });

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 ClientEvents collection and the client events methods:

AddClientEventListener
HasClientEventListener
RemoveClientEventListener
RemoveClientEventListener
GetClientEventListener

IsDisposed

Boolean: Returns whether the control has been disposed.

IsHandleCreated

Boolean: Returns if the control has a server-side component id (handle) associated with it.

IsMirrored

Boolean: Returns whether the control is mirrored.

LayoutEngine

LayoutEngine: Returns the control's layout engine.

Left

Int32: Returns or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.

Location

Point: Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.

Margin

Padding: Returns or sets the space between controls.

MaximumSize

Size: Returns or sets the maximum size for the control.

MinimumSize

Size: Returns or sets the minimum size for the control.

ModifierKeys

Keys: Returns a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.

MouseButtons

MouseButtons: Returns a value indicating which of the mouse buttons is in a pressed state.

MousePosition

Point: Returns the position of the mouse cursor in screen coordinates.

Movable

Boolean: Returns or sets whether the control can be moved by dragging.

Name

String: Gets or sets the name of the control.

Padding

Padding: Returns or sets padding within the control.

Parent

Control: Returns or sets the parent container of the control.

PreferredSize

Size: Returns the preferred size in which the control can fit.

ResizableEdges

AnchorStyles: Returns or sets the edges of the control that can be dragged to resize the control.

ResponsiveProfiles

ResponsiveProfileCollection: Returns the collection of responsive properties that have been set for this control.

Right

Int32: Return the distance, in pixels, between the right edge of the control and the left edge of its container's client area.

RightToLeft

RightToLeft: Returns or sets whether the control's elements are aligned right-to-left to support RTL languages.

When set to Inherit, 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 Inherit, the right-to-left mode is automatically retrieved from the current language.

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

Boolean: 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 Selectable, which corresponds to the Focusable property. When Selectable 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.

ShowLoader

Boolean: Returns or sets whether the control is blocked by the ajax loader.

Size

Size: Returns or sets the height and width of the control.

States

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

  // 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" };

In addition to setting this property directly, you can also manage it using the related methods:

AddState
RemoveState
HasState

TabIndex

Int32: Returns or sets the tab order of the control within its container.

TabStop

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.

Tag

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

Text

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

ToolTipText

String: Returns or sets the tooltip text to show for this control.

When using ToolTipText 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 ToolTip extender and the ToolTipText property added by the extender. You can change the default ForeColor, AutomaticDelay, InitialDelay, AutoPopDelay, or enable HTML in ToolTipText by using a ToolTip extender also without setting the ToolTipText property added by the extender.

Top

Int32: Returns or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.

TopLevelControl

Control: Returns the parent control that is not parented by another Form. Typically, this is the outermost Form that the control is contained in.

UserData

Object: Returns a dynamic object that can be used to store custom data in relation to this control.

UseWaitCursor

Boolean: Returns or sets whether to use the wait cursor for the current control and all child controls.

ValidationCancelled

Boolean: Returns a flag indicating that the validation has been canceled.

Visible

Boolean: Returns or sets whether the control and all its child controls are displayed.

WheelDelta

Int32: Returns a value indicating the wheel delta from the last wheel event.

Width

Int32: Returns or sets the width of the control.

Methods

AddClientEventListener(name, script)

Adds a new listener script to the event name to the client widget.

Parameter

Type

Description

name

Name of the client event to attach the listener to.

script

JavaScript code to execute when the event occurs.

Returns: Int32. An integer id that you can use to remove the listener from the event using RemoveClientEventListener or to retrieve the listener script code using GetClientEventListener.

The script will execute in the browser when the event name occurs. You can attach multiple listeners to the same event.

AddCssClass(name)

Adds the CSS class name to the widget element. If the class already exists in the CssClass it's not added.

Parameter

Type

Description

name

Name of the css class to add.

Returns: String. The new value of the CssClass property.

AddState(state)

Adds the specified theme state to the widget.

Parameter

Type

Description

state

Name of the custom state to add to the widget.

Returns: String[]. The new list of states stored in the States property.

You can also assign a new array of states to the States property.

BeginInvoke(method)

Executes the specified delegate asynchronously.

Parameter

Type

Description

method

A delegate to a method that takes no parameters.

Returns: IAsyncResult. An IAsyncResult that represents the result of the BeginInvoke operation.

BeginInvoke(method, args)

Executes the specified delegate asynchronously.

Parameter

Type

Description

method

A delegate to a method that takes no parameters.

args

An optional array of objects to pass as arguments to the specified method.

Returns: IAsyncResult. An IAsyncResult that represents the result of the asynchronous call.

BringToFront()

Brings the control to the front of the z-order.

Call(function, args)

Runs the JavaScript function within the component's context in the browser.

Parameter

Type

Description

function

The name of the JavaScript function to execute.

args

The arguments to pass to the function.

Call(function, callback, args)

Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.

Parameter

Type

Description

function

The name of the JavaScript function to execute.

callback

Asynchronous callback method that receives the return value.

args

The arguments to pass to the function.

CallAsync(function, args)

Asynchronously runs the JavaScript function within the component's context in the browser and returns an awaitable Task containing the value returned by the remote call.

Parameter

Type

Description

function

The name of the JavaScript function to execute.

args

The arguments to pass to the function.

Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.

CenterToParent()

Centers the position of the control within the bounds of the parent.

CenterToParent(horizontal, vertical)

Centers the position of the control within the bounds of the parent either horizontally, vertically or both.

Parameter

Type

Description

horizontal

Center horizontally.

vertical

Center vertically.

Contains(control)

Indicates whether the specified control is a child of this control.

Parameter

Type

Description

control

The child to find.

Returns: Boolean. true if the specified control is a child of the control; otherwise, false.

CreateControl()

Creates and register this control and all its children.

DoDragDrop(data, allowedEffects)

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

One of the values.

Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.

DoDragDrop(data, allowedEffects, imageSource)

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

One of the values.

imageSource

The name or URL for an image to use as the drag cursor.

Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.

DoDragDrop(data, allowedEffects, imageSource, imageSize)

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

One of the values.

imageSource

The name or URL for an image to use as the drag cursor.

imageSize

The size of the drag image specified in imageSource.

Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.

DoDragDrop(data, allowedEffects, image)

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

One of the values.

image

An to use as the drag cursor.

Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.

DoDragDrop(data, allowedEffects, image, imageSize)

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

One of the values.

image

An to use as the drag cursor.

imageSize

The size of the drag image specified in image.

Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.

EndInvoke(asyncResult)

Retrieves the return value from the asynchronous operation represented by asyncResult .

Parameter

Type

Description

asyncResult

An that represents a operation started on a control.

Returns: Object. The return value from the asynchronous operation.

Eval(javaScript)

Runs the javaScript code within the component's context in the browser.

Parameter

Type

Description

javaScript

The JavaScript code to run on the client.

Eval(javaScript, callback)

Runs the javaScript code within the component's context in the browser and returns the value to the callback method.

Parameter

Type

Description

javaScript

The JavaScript code to evaluate on the client.

callback

Asynchronous callback method that receives the return value.

EvalAsync(javaScript)

Asynchronously runs the javaScript code within the component's context in the browser and returns an awaitable Task that contains the value returned by the remote call.

Parameter

Type

Description

javaScript

The JavaScript code to evaluate on the client.

Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.

FindForm()

Retrieves the form that the control is on.

Returns: Form.

FindPage()

Retrieves the page that the control is on.

Returns: Page.

Focus()

Sets input focus to the control.

Returns: Boolean. true if the input focus request was successful; otherwise, false.

GetChildAtPoint(pt, skipValue)

Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.

Parameter

Type

Description

A 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

One of the values of , determining whether to ignore child controls of a certain type.

Returns: Control. The child Control at the specified coordinates.

GetChildAtPoint(pt)

Retrieves the child control that is located at the specified coordinates.

Parameter

Type

Description

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

Returns: Control. A Control that represents the control that is located at the specified point.

GetClientEventListener(id)

Returns the script associated to the listener identified by id .

Parameter

Type

Description

Id of the listener to retrieve the script for.

Returns: String. JavaScript associated with the listener.

GetClientEventListener(name)

Returns the scripts for all the listeners attached to the event name .

Parameter

Type

Description

name

Name of the event.

Returns: String[]. String array containing the scripts for the listeners attached to the event.

GetContainerControl()

Returns the next IContainerControl up the control's chain of parents.

Returns: IContainerControl. The parent IContainerControl.

GetNextControl(control, forward)

Retrieves the next control forward or back in the tab order of child controls.

Parameter

Type

Description

control

The to start the search with.

forward

true to search forward in the tab order; false to search backward.

Returns: Control. The next Control in the tab order.

GetStyle(flag)

Retrieves the value of the specified control style bit for the control.

Parameter

Type

Description

flag

The bit to return the value from.

Returns: Boolean. true if the specified control style bit is set to true; otherwise, false.

HasClientEventListener(name)

Checks whether the specified event name has any listener attached.

Parameter

Type

Description

name

Name of the client event to verify.

Returns: Boolean. True if the event name has any listener attached.

HasCssClass(name)

Returns true if the property CssClass contains the specified class name .

Parameter

Type

Description

name

Css class name to verify.

Returns: Boolean. True of the css class name is already included in CssClass.

HasState(state)

Checks whether the specified theme state is present in the States property.

Parameter

Type

Description

state

Name of the state to check.

Returns: Boolean. True if the widget already has the state .

Hide()

Conceals the control from the user.

Invalidate()

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.

Invalidate(invalidateChildren)

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

invalidateChildren

When true, invalidates all the children of the control.

Invoke(method)

Executes the specified delegate.

Parameter

Type

Description

method

A delegate that contains a method to be called in the control's thread context.

Returns: Object. The return value from the delegate being invoked, or null if the delegate has no return value.

Invoke(method, args)

Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.

Parameter

Type

Description

method

A delegate to a method that takes parameters of the same number and type that are contained in the args parameter.

args

An array of objects to pass as arguments to the specified method. This parameter can be null if the method takes no arguments.

Returns: Object. An Object that contains the return value from the delegate being invoked, or null if the delegate has no return value.

IsMnemonic(charCode, text)

Determines whether the specified character is the mnemonic character.

Parameter

Type

Description

charCode

The character to test.

text

The string to search.

Returns: Boolean. true if the charCode character is the mnemonic character; otherwise, false.

LayoutChildren(dock, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control using the specified dock style, spaced by spacing pixels.

Parameter

Type

Description

dock

Indicates whether to arrange the horizontally or vertically.

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

LayoutChildren(dock, viewArea, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control using the specified dock style, spaced by spacing pixels.

Parameter

Type

Description

dock

Indicates whether to arrange the horizontally or vertically.

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

LayoutChildren(controls, dock, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control using the specified dock style, spaced by spacing pixels.

Parameter

Type

Description

controls

List of child controls to arrange. If null, all the children will be arranged.

dock

Indicates whether to arrange the horizontally or vertically.

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

LayoutChildren(controls, dock, viewArea, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control using the specified dock style, spaced by spacing pixels.

Parameter

Type

Description

controls

List of child controls to arrange. If null, all the children will be arranged.

dock

Indicates whether to arrange the horizontally or vertically.

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

LayoutChildren(direction, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control in the specified direction , spaced by spacing pixels.

Parameter

Type

Description

direction

Indicates whether to arrange the horizontally or vertically.

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

LayoutChildren(direction, viewArea, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .

Parameter

Type

Description

direction

Indicates whether to arrange the horizontally or vertically.

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

vAlign

Vertical alignment when using direction = .

LayoutChildren(controls, direction, spacing, useMargins, hAlign, vAlign)

Arranges the specified child controls in the specified direction , spaced by spacing pixels.

Parameter

Type

Description

controls

List of child controls to arrange. If null, all the children will be arranged.

direction

Indicates whether to arrange the controls horizontally or vertically.

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

Throws:

ArgumentException One of the controls is not a child of this control.

LayoutChildren(controls, direction, viewArea, spacing, useMargins, hAlign, vAlign)

Arranges the specified child controls in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .

Parameter

Type

Description

controls

List of child controls to arrange. If null, all the children will be arranged.

direction

Indicates whether to arrange the controls horizontally or vertically.

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

Throws:

ArgumentException One of the controls is not a child of this control.

PerformLayout()

Forces the control to apply layout logic to all its child controls.

PerformLayout(affectedControl, affectedProperty)

Forces the control to apply layout logic to all its child controls.

Parameter

Type

Description

affectedControl

A that represents the recently changed control.

affectedProperty

The name of the recently changed property on the control that caused the layout to change.

PointToClient(point)

Computes the location of the specified screen point into client coordinates.

Parameter

Type

Description

point

The screen coordinate to convert.

Returns: Point. A Point that represents the converted Point, point , in client coordinates.

PointToScreen(point)

Computes the location of the specified client point into screen coordinates.

Parameter

Type

Description

point

The client coordinate to convert.

Returns: Point. A Point that represents the converted Point, point , in screen coordinates.

RectangleToClient(rect)

Computes the size and location of the specified screen rectangle in client coordinates.

Parameter

Type

Description

rect

The screen coordinate to convert.

Returns: Rectangle. A Rectangle that represents the converted Rectangle, rect , in client coordinates.

RectangleToScreen(rect)

Computes the size and location of the specified client rectangle in screen coordinates.

Parameter

Type

Description

rect

The client coordinate to convert.

Returns: Rectangle. A Rectangle that represents the converted Rectangle, rect , in screen coordinates.

Refresh()

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.

Refresh(refreshChildren)

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

refreshChildren

True to also refresh all the children of this control.

RemoveClientEventListener(id)

Detaches and removes the listener identified by id .

Parameter

Type

Description

Id of the listener to remove.

Returns: Boolean. True if the id specified a valid lister and it was removed; otherwise false if id is invalid.

RemoveClientEventListener(name)

Removes all the listeners attached to the event name .

Parameter

Type

Description

name

Name of the event.

Returns: Boolean. True if the event name has any listener that was removed.

RemoveCssClass(name)

Removes the specified css class name from the control's CssClass property.

Parameter

Type

Description

name

The css class name to remove.

Returns: String. The new value of the CssClass property.

RemoveState(state)

Removes the specified theme state from the widget.

Parameter

Type

Description

state

Name of the state to remove.

Returns: String[]. The new list of states stored in the States property.

You can also assign a new array of states to the States property.

ResetBindings()

Removes all the data bindings from the control.

ResumeLayout()

Resumes layout logic.

ResumeLayout(performLayout)

Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.

Parameter

Type

Description

performLayout

true to apply all pending layout requests; otherwise, false.

ScrollControlIntoView(alignX, alignY)

Scrolls the control into view in the container using the specified alignX and alignY preferences.

Parameter

Type

Description

alignX

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 center, but will instead scroll it into the closest visible location with the minimum movement.

alignY

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.

ScrollControlIntoView()

Scrolls the child control into view.

Select()

Activates a control.

SelectNextControl(control, forward, tabStopOnly, nested, wrap)

Activates the next control in the list according to the specified selection rules.

Parameter

Type

Description

control

The at which to start the search.

forward

true to move forward in the tab order; false to move backward in the tab order.

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.

Returns: Boolean. true if a control was activated; otherwise, false.

SendToBack()

Sends the control to the back of the z-order.

SetBounds(x, y, width, height)

Sets the bounds of the control to the specified location and size.

Parameter

Type

Description

The new property value of the control.

width

The new property value of the control.

height

The new property value of the control.

SetBounds(x, y, width, height, specified)

Sets the specified bounds of the control to the specified location and size.

Parameter

Type

Description

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.

Show()

Displays the control to the user.

SuspendLayout()

Suspends the layout logic for the control.

Update()

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.

ValidateChildren(flags)

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

flags

Returns: Boolean. true if all of the children validated successfully; otherwise, false. If called from the Validating or Validated event handlers, this method will always return false.

ValidateChildren()

Validates all selectable child controls in the container, including descendants. This is equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See Selectable for details of exactly which child controls will be validated.

Returns: Boolean. true if all of the children validated successfully; otherwise, false. If called from the Validating or Validated event handlers, this method will always return false.

Events

Appear

EventHandler 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 Appear or Disappear to enable both events.

AutoSizeChanged

EventHandler Fired when the AutoSize property value changes.

BackColorChanged

EventHandler Fired when the value of the BackColor property changes.

BackgroundImageChanged

EventHandler Fired when the value of the BackgroundImage property changes.

BackgroundImageLayoutChanged

EventHandler Fired when the BackgroundImageLayout property changes.

BecomingActiveControlChanged

EventHandler Fired when the value of the BecomingActiveControl property changes.

BindingContextChanged

EventHandler Occurs when the value of the BindingContext property changes.

CausesValidationChanged

EventHandler Fired when the value of the CausesValidation property changes.

Click

EventHandler Fired when the control is clicked.

ClientSizeChanged

EventHandler Fired when the ClientSize property value changes.

ContextMenuChanged

EventHandler Fired when the value of the ContextMenu property changes.

ControlAdded

ControlEventHandler Fired when a new control is added to the ControlCollection.

ControlCreated

EventHandler Fired when a control is made visible the first time, fully created and sent to the client.

ControlRemoved

ControlEventHandler Fired when a control is removed from the ControlCollection.

CursorChanged

EventHandler Fired when the value of the Cursor property changes.

Disappear

EventHandler Fired after the control is no longer visible on the client.

Disposed

EventHandler Fired when the component is disposed.

DockChanged

EventHandler Fired when the value of the Dock property changes.

DoubleClick

EventHandler Fired when the control is double-clicked.

DragDrop

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

DragEnd

EventHandler Fired when a drag-drop operation is terminated either by a drop or canceled.

DragEnter

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

DragLeave

EventHandler Fired when an object is dragged out of the control's bounds.

DragOver

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

DragStart

EventHandler Fired when a drag-drop operation is started by the user.

EnabledChanged

EventHandler Fired when the Enabled property value has changed.

EndMove

EventHandler Fired when a control is Movable and the user ends the move operation.

This event fires only when Movable is true and the user moves the widget on the client. It doesn't fire when the Location property changes.

EndResize

EventHandler Fired when a control has ResizableEdges and the user ends the resize operation.

This event fires only when the ResizableEdges has a value different than None and the user resizes the widget on the client. It doesn't fire when the Size of the control changes.

Enter

EventHandler Fired when the control gains the input focus.

FontChanged

EventHandler Fired when the Font property value changes.

ForeColorChanged

EventHandler Fired when the ForeColor property value changes.

GotFocus

EventHandler Fired when the control gains the focus.

HelpRequested

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

ImeModeChanged

EventHandler Fired when the ImeMode property has changed.

KeyDown

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

KeyPress

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

KeyUp

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

Layout

LayoutEventHandler Fired when a control should reposition its child controls.

Leave

EventHandler Fired when the control loses the input focus.

LocationChanged

EventHandler Fired when the Location property value has changed.

LongTap

EventHandler Fired when a pointer holds on the screen.

LostFocus

EventHandler Fired when the control loses focus.

MarginChanged

EventHandler Fired when the control's margin changes.

MouseCaptureChanged

EventHandler Fired when the control loses mouse capture.

MouseClick

MouseEventHandler Fired when the control is clicked by the mouse.

MouseDoubleClick

MouseEventHandler Fired when the control is double clicked by the mouse.

MouseDown

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

MouseEnter

EventHandler Fired when the mouse pointer enters the control.

MouseHover

EventHandler Fired when the mouse pointer rests on the control.

MouseLeave

EventHandler Fired when the mouse pointer leaves the control.

MouseMove

MouseEventHandler Fired when the mouse pointer is moved over the control.

MouseUp

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

MouseWheel

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

PaddingChanged

EventHandler Fired when the control's padding changes.

Paint

PaintEventHandler Fired when a UserPaint control needs to redraw itself.

ParentChanged

EventHandler Fired when the Parent property value changes.

Pinch

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

PreviewKeyDown

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

QueryContinueDrag

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

Resize

EventHandler Fired when the control is resized.

ResponsiveProfileChanged

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

RightToLeftChanged

EventHandler Fired when the RightToLeft property value changes.

Rotate

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

SizeChanged

EventHandler Fired when the Size property value changes.

StartMove

EventHandler Fired when a control is Movable and the user begins the move operation.

This event fires only when Movable is true and the user begins moving the widget on the client.

StartResize

EventHandler Fired when a control has ResizableEdges and the user begins the resize operation.

This event fires only when the ResizableEdges has a value different than None and the user begins resizing the widget on the client.

StyleChanged

EventHandler Fired when the control style changed.

Swipe

SwipeEventHandler Fired when a pointer swipes over the screen.

TabIndexChanged

EventHandler Fired when the TabIndex property value has changed.

TabStopChanged

EventHandler Fired when the value of the TabStop property changes.

Tap

EventHandler Fired when a pointer taps on the screen.

TextChanged

EventHandler Fired when the Text property value changes.

TouchCancel

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

TouchEnd

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

TouchMove

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

TouchStart

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

Track

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

Validated

EventHandler Fired when the control is finished validating.

Validating

CancelEventHandler Fired when the control is validating.

VisibleChanged

EventHandler Fired when the Visible property value changes.

WidgetEvent

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

  this.fireWidgetEvent("myevent", {x:1, y:2, name:'test'});

On the server side, the event name and event data are available in the WidgetEvent handler:

  
  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;
    }
  }

Inherited By

Name

Description

Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.

UI implementation for the FileDialog class.

UI implementation for the FolderDialog class.

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

Implements

Name

Description

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