1 of 100

v3.5

Wisej.NET API

Welcome to the Wisej.NET API reference.

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

Legend

Icon

Description

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

Represents a unique client using the application.

public class Client

Public Class Client

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

Properties

Browsers

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

ClientBrowser

Wisej.Core.ClientBrowser

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.5.0.0)

Properties of the client browser currently interacting with the application.

Fields

ClientCollection

Wisej.Core.ClientCollection

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.5.0.0)

List of s using the application.

Constructors

ClientPlatform

Wisej.Core.ClientPlatform

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.5.0.0)

Represents the client platform used to render the widgets.

Properties

ClientProfile

Wisej.Core.ClientProfile

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.5.0.0)

Definition of the client device.

public class ClientProfile

Public Class ClientProfile

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

Specifies the event arguments for the event.

Properties

LoadConfigurationEventHandler

Wisej.Core.LoadConfigurationEventHandler

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.5.0.0)

Represents a method that handles the LoadConfiguration event.

public delegate void LoadConfigurationEventHandler(Object sender, LoadConfigurationEventArgs args)

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

Parameters

Name

Type

Description

Fired By

Name

Description

PlatformProvider

Wisej.Core.PlatformProvider

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.5.0.0)

Platforms supported by Wisej.

Fields

Application.FormCollection

Wisej.Web.Application FormCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Holds the collection of all top-level application forms.

Properties

Application.PageCollection

Wisej.Web.Application PageCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Holds the collection of all top-level application pages.

Properties

Application.RequestType

Wisej.Web.Application RequestType

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Type of incoming request. Since 3.5.5

Fields

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the HashChanged event.

public class HashChangedEventArgs : EventArgs

Public Class HashChangedEventArgs
    Inherits EventArgs

Constructors

HashChangedEventArgs(value)

Initializes a new instance of the class.

Name

Type

Description

Properties

Hash

: The hash string from the client.

Used By

Name

Description

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the event.

Parameters

LicenseErrorEventArgs

Wisej.Web.LicenseErrorEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the event.

Constructors

LicenseErrorEventHandler

Wisej.Web.LicenseErrorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the event.

Parameters

RequestEventArgs

Wisej.Web.RequestEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

public class RequestEventArgs : EventArgs

Public Class RequestEventArgs
    Inherits EventArgs

Constructors

RequestEventArgs(type)

Initializes an for the delegate.

Name

Type

Description

Properties

Type

: Returns the .

Used By

Name

Description

RequestEventHandler

Wisej.Web.RequestEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represent a method that handles the BeginRequest, and EndRequest events. Since 3.5.5

public delegate void RequestEventHandler(Object sender, RequestEventArgs e)

Public Delegate Sub RequestEventHandler(ByVal sender As [Object], ByVal e As RequestEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the ResponsiveProfileChanged event.

public class ResponsiveProfileChangedEventArgs : EventArgs

Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs

Constructors

ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the class.

Name

Type

Description

Properties

CurrentProfile

: The new active profile.

PreviousProfile

: The previously active profile.

Used By

Name

Description

BackgroundWorker

Wisej.Web.BackgroundWorker

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Executes an operation on a background task.

Constructors

ControlEventArgs

Wisej.Web.ControlEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the ControlAdded and ControlRemoved events.

public class ControlEventArgs : EventArgs

Public Class ControlEventArgs
    Inherits EventArgs

Constructors

ControlEventArgs(control)

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

Name

Type

Description

Properties

Control

: Returns the control object used by this event.

Used By

Name

Description

ControlEventHandler

Wisej.Web.ControlEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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

public delegate void ControlEventHandler(Object sender, ControlEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

HelpEventArgs

Wisej.Web.HelpEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the HelpRequested event.

public class HelpEventArgs : EventArgs

Public Class HelpEventArgs
    Inherits EventArgs

Constructors

HelpEventArgs(target)

Initializes a new instance of the class.

Name

Type

Description

Properties

Handled

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

Target

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

Used By

Name

Description

HelpEventHandler

Wisej.Web.HelpEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the event of a .

JavaScript.ClientEvent

Wisej.Web.JavaScript ClientEvent

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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

public class ClientEvent

Public Class ClientEvent

Constructors

ClientEvent()

Initializes a new instance of .

Properties

Event

: 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. (Default: null)

JavaScript

: Returns or sets the JavaScript handler for the event. (Default: "")

KeyEventHandler

Wisej.Web.KeyEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the KeyUp or KeyDown event of a Control.

public delegate void KeyEventHandler(Object sender, KeyEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

KeyPressEventArgs

Wisej.Web.KeyPressEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the event.

Constructors

KeyPressEventHandler

Wisej.Web.KeyPressEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the event of a .

LayoutEventHandler

Wisej.Web.LayoutEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the event of a .

PaintEventArgs

Wisej.Web.PaintEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the event.

Constructors

PaintEventHandler

Wisej.Web.PaintEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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

public delegate void PaintEventHandler(Object sender, PaintEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

PinchEventArgs

Wisej.Web.PinchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for event.

Properties

PinchEventHandler

Wisej.Web.PinchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the Pinch event.

public delegate void PinchEventHandler(Object sender, PinchEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

PreviewKeyDownEventHandler

Wisej.Web.PreviewKeyDownEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the PreviewKeyDown event.

public delegate void PreviewKeyDownEventHandler(Object sender, PreviewKeyDownEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

QueryContinueDragEventArgs

Wisej.Web.QueryContinueDragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the event.

Constructors

QueryContinueDragEventHandler

Wisej.Web.QueryContinueDragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the event of a .

RotateEventArgs

Wisej.Web.RotateEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for Rotate event.

public class RotateEventArgs : EventArgs

Public Class RotateEventArgs
    Inherits EventArgs

Properties

Angle

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

Used By

Name

Description

RotateEventHandler

Wisej.Web.RotateEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the Rotate event.

public delegate void RotateEventHandler(Object sender, RotateEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

SwipeAxis

Wisej.Web.SwipeAxis

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Indicates the axis of the swipe gesture.

public enum SwipeAxis : Enum

Public Enum SwipeAxis As [Enum]

Fields

Name

Description

Used By

Name

Description

SwipeDirection

Wisej.Web.SwipeDirection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Indicates the direction of the swipe gesture.

Fields

SwipeEventHandler

Wisej.Web.SwipeEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the event.

Parameters

TouchEventArgs

Wisej.Web.TouchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for Swipe event.

public class TouchEventArgs : EventArgs

Public Class TouchEventArgs
    Inherits EventArgs

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

TrackEventArgs

Wisej.Web.TrackEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for Track event.

public class TrackEventArgs : EventArgs

Public Class TrackEventArgs
    Inherits EventArgs

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

Represents the method that will handle the Track event.

public delegate void TrackEventHandler(Object sender, TrackEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

WidgetEventHandler

Wisej.Web.WidgetEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that handles the WidgetEvent event.

public delegate void WidgetEventHandler(Object sender, WidgetEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

Screen

Wisej.Web.Screen

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the display on the client device.

public class Screen

Public Class Screen

Properties

Bounds

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

DeviceName

: Returns the device name associated with a display.

WorkingArea

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

SessionReference<T>

Wisej.Web.SessionReference<T>

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Keeps a to an singleton instance of T stored in the current . Since 3.2.7

Use to retrieve the session-singleton instance of your object of type T .

Buttons

MenuButtonItemClickedEventArgs

Wisej.Web.MenuButtonItemClickedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the event.

Constructors

MenuButtonItemClickedEventHandler

Wisej.Web.MenuButtonItemClickedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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

Common Dialogs

FileDialogRootCollection

Wisej.Web.FileDialogRootCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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

Containers

AccordionAction

Wisej.Web.AccordionAction

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Defines values representing events.

Fields

ClientTheme

Wisej.Core.ClientTheme

Namespace: Wisej.Core

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

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

Constructors

ClientTheme(name)

Default private constructor.

Name

Type

Description

ClientTheme(name, json)

Constructs a new theme from the name and JSON definition.

Name

Type

Description

ClientTheme(name, baseTheme)

Constructs a new theme from the base theme.

Name

Type

Description

Properties

Appearances

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

Colors

: Theme colors.

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

Fonts

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

Images

: 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

: The name of the theme.

Settings

: Theme settings.

The Settings property allows a theme to define certain internal properties. Currently these are the supported properties:

native-scrollbars Instructs Wisej.NET 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

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

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

Returns: . A representing the color in the theme.

GetColor(name)

Returns the resolved theme color from the color list.

Parameter

Type

Description

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

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

GetFont(name)

Returns the resolved font defined from the font list.

Parameter

Type

Description

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

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

GetImage(name)

Returns the resolved image defined from the image list.

Parameter

Type

Description

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

GetInsets(appearance, state, includePadding)

Returns the size of the inset border and padding.

Parameter

Type

Description

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

GetProperty<T>(appearance, name, state)

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

Parameter

Type

Description

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

GetStyle<T>(appearance, name, state)

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

Parameter

Type

Description

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

IsThemeColor(color)

Returns true if the color is a theme color.

Parameter

Type

Description

Returns: . True if color is a theme color.

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

IsThemeFont(font)

Returns true if the font is a theme font.

Parameter

Type

Description

Returns: . True if font is a theme font.

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

TranslateColor(color)

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

Parameter

Type

Description

Returns: . A instance with the resolved RGB values.

TranslateFont(font)

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

Parameter

Type

Description

Returns: . A instance that can be used directly.

Implements

Name

Description

Application

Wisej.Web.Application

Namespace: Wisej.Web

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

Public Class Application
    Inherits IWisejComponent
    Implements IDisposable, IWisejSynchronized

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

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

Manage cookies. Use to manage browser's cookies.
Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.
Read the application's URL. Use , , , and .

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

Properties

ActiveProfile

: 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

: Returns or the client browser's information.

ClientCertificate

: EXPERIMENTAL: Provides the client certificate fields issued by the client in response to the server's request for the client's identity. Since 3.5.6

ClientId

: Returns the current unique client id.

Clients

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

CommandManager

: Returns the current .

CommonAppDataPath

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

CommonAppDataRegistry

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

CompanyName

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

Configuration

: Returns the current .

Cookies

: Collection of cookies.

Current

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

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

CurrentCulture

: Returns or sets the current for the session.

Desktop

: Returns or sets the current Desktop.

EnableUnloadConfirmation

: 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

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

FavIcon

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

FavIconSource

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

Hash

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

IsAuthenticated

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

IsDisposed

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

IsExpired

: Returns true when the current session has expired.

IsSecure

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

IsTerminated

: Returns true when the current session has been terminated.

IsWebSocket

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

LicenseInfo

: Returns a dynamic object containing the currently loaded license information. Since 3.1.3

These are the currently available fields (may change in future releases):

Valid: Whether the license is valid. Note that a license may be expired and valid if the product release date is within the license expiration date.
LicenseKey: License key loaded from web.config or assigned to .
ProductName: Full name of the licensed product.

Retrieve the values either using a dynamic object or a property indexer:

LicenseKey

: Returns or sets the runtime server license key.

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

MainPage

: Returns or sets the current full page window.

OpenForms

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

OpenPages

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

Platform

: The name of the currently loaded platform.

ProductName

: Returns the product name associated with this application.

ProductVersion

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

QueryString

: Returns the parameters used to launch the application.

RightToLeft

: 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

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

ServerName

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

ServerPort

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

ServerVariables

: Returns the server variables.

Services

: Returns the implementation used by Wisej.NET to manage Dependency Injection across the application. Since 3.1

Session

: Provides a generic storage for session-based objects.

SessionCount

: Returns the total number of currently active sessions.

SessionId

: Returns the unique current session ID.

ShowConsole

: 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

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

StartupPath

: Returns the root path of the web application.

StartupUri

: Returns the URI used to start the application.

StartupUrl

: Returns the URL used to start the application.

Theme

: Returns or sets the current .

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

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

Title

: Returns or sets the page title in the browser.

Uri

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

Url

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

User

: Returns the security information for the current request.

UserAgent

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

UserHostAddress

: Returns the IP host address of the remote client.

UserHostName

: Returns the DNS name of the remote client.

UserIdentity

: Returns the type for the current user.

UserLanguages

: 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

AddTranslation(text, translation)

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

Parameter

Type

Description

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

Returns: . An awaitable that represents the asynchronous operation.

Call(function, args)

Executes the JavaScript function on the client.

Parameter

Type

Description

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

CallAsync(function, args)

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

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

Returns: . An awaitable that represents the asynchronous operation.

Dispose()

Download(filePath, fileName, ondownload)

Downloads the specified file on the client.

Parameter

Type

Description

Download(image, fileName, ondownload)

Downloads the specified image to the client.

Parameter

Type

Description

Download(stream, fileName, ondownload)

Downloads the bytes in the stream to the client.

Parameter

Type

Description

DownloadAndOpen(target, filePath, fileName, ondownload)

Downloads the specified file on the client.

Parameter

Type

Description

DownloadAndOpen(target, image, fileName, ondownload)

Downloads the specified image to the client.

Parameter

Type

Description

DownloadAndOpen(target, stream, fileName, ondownload)

Downloads the bytes in the stream to the client.

Parameter

Type

Description

EndPolling()

Stops the polling requests from the client.

Eval(script)

Executes the JavaScript script on the client.

Parameter

Type

Description

Eval(script, callback)

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

Parameter

Type

Description

EvalAsync(script)

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

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

Returns: . The first qualified by the match expression.

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

FindComponents(match)

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

Parameter

Type

Description

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

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

GetInstance<T>(reference, builder)

Returns a session-static instance of T . Since 3.2.7

Parameter

Type

Description

Returns: . The singleton instance of T associated with the current session.

This utility method simplifies the management of session-static (or session singleton) instances. It should be used to convert traditional static variables to session-static instances when changing an application designed for single users to a multi-user system. The code below shows how to use this feature together with the to manage session-static instances and, at the same time, improve the speed of the code that relies on the singleton objects. Using the backing field allows the code that retrieves the session-static instance to quickly check the last instance and compare the session id and avoid accessing the dictionary for every access within the same request. Otherwise the code would have to always store a local variable in order to speed up multiple operations using the same static field.

If the class a private constructor (to simulate a static class) or required initialization code or arguments, use the optional builder method:

LoadAssembly(nameOrFile)

Loads an assembly given the file name or path.

Parameter

Type

Description

Returns: . The loaded .

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

LoadComponent(nameOrFile, className)

Creates an instance of the specified component from the assembly.

Parameter

Type

Description

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

LoadPackages(packages, callback)

Parameter

Type

Description

LoadPackagesAsync(packages)

Parameter

Type

Description

Returns: .

LoadTheme(name, mixins)

Changes the current theme.

Parameter

Type

Description

MapPath(path)

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

Parameter

Type

Description

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

Navigate(url, target)

Navigate to the specified URL.

Parameter

Type

Description

Navigate(url, target, onclose)

Navigate to the specified URL in a new browser tab and receive an optional callback when the tab is closed.

Parameter

Type

Description

OpenWindow(url, target, windowFeatures, onclose)

Opens the specified URL in a browser's popup window and receive an optional callback when the tab is closed.

Parameter

Type

Description

Play(type)

Plays one of the built-in sounds

Parameter

Type

Description

Play(soundUrl)

Plays a sound.

Parameter

Type

Description

Post(callback)

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

Parameter

Type

Description

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

Print(control)

Prints the specified control.

Parameter

Type

Description

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

Returns: . An awaitable that represents the asynchronous operation.

RefreshSessionId()

Generates a new session id without losing the session. Since 3.5.2

Use this method after a successful login to prevent potential session fixation attacks.

Reload()

Causes the application to reload on the browser.

RemoveEventFilter(filter)

Removes the filter from the list of registered event filters.

Parameter

Type

Description

RequestFullScreen()

Requests the browser to enable fullscreen mode if supported.

RunInContext(context, action)

Executes the callback in context.

Parameter

Type

Description

SetInstance<T>(reference, instance)

Replaces the object assigned to a session-static singleton. Since 3.5.2

Parameter

Type

Description

SetSessionTimeout(seconds)

Sets the current session timeout in seconds.

Parameter

Type

Description

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

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

Throws:

The interval specified is less than 1.

StartTask(action)

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

Parameter

Type

Description

Returns: . An awaitable .

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

StartTask<T>(action)

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

Parameter

Type

Description

Returns: .

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

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

StartTimer(dueTime, period, callback)

Starts a bound to the current session context.

Parameter

Type

Description

Returns: . An instance of .

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

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

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

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

Events

ActiveWindowChanged

Fired when the active window changes.

ApplicationExit

Fired when the application is about to shut down.

ApplicationRefresh

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

ApplicationStart

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

BeforeInstallPrompt

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

BeginRequest

Fired at the beginning of every request.

BrowserSizeChanged

Fired when the user resizes the browser.

BrowserTabActivated

Fired when the user activates the browser tab.

BrowserTabDeactivated

Fired when the user deactivates the browser tab.

CultureChanged

Fired when the changes.

EndRequest

Fired at the end of every request.

FocusedControlChanged

Fired when the focused control changes.

HashChanged

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

Idle

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

ImpersonationBegin

Fired right after , only when is set to true, to allow user code to take over the thread impersonation operations.

Set e.Handled to true if your application takes care of impersonation; otherwise false to let the default implementation attempt to impersonate the user. This event is not related to a session. It is best to attach to this event from a static type initializer, otherwise each listener will be called for every thread, regardless of the session. The default implementation in Wisej.NET is supported only in .NET Framework and the Windows platform.

ImpersonationEnd

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

LicenseError

Fired when a license error occurs.

ResponsiveProfileChanged

Fired when the active responsive profile is changed.

RightToLeftChanged

Fired when the value changes.

SessionTimeout

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

Fired when the current theme is changed.

ThreadException

Fired when a thread exception is thrown.

Implements

Name

Description

Control

Wisej.Web.Control

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Base class for all Wisej controls.

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

Public Class Control
    Implements IWisejControl, IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfiles, IDropTarget

Constructors

Control()

Initializes a new instance of the class.

Properties

AccessibleDescription

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

AccessibleName

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

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. (Default: Default)

AllowDrag

: Returns or sets whether the control can initiate a drag-drop operation. (Default: False)

AllowDrop

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

Anchor

: Returns or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. (Default: Top, Left)

Anonymous

: Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents. (Default: False)

AppearanceKey

: Sets the appearance key for the theme engine. (Default: null)

BackColor

: Returns or sets the background color for the control.

BackgroundImage

: Returns or sets the background image displayed in the control. (Default: null)

BackgroundImageLayout

: Returns or sets the background image layout as defined in the enumeration. (Default: None)

BackgroundImageSource

: Returns or sets the background image displayed in the control. (Default: null)

BecomingActiveControl

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

BindingContext

: Returns or sets the for the control.

Bottom

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

Bounds

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

CanExecute

: Determines whether the control can execute a command.

CanFocus

: Returns whether the control can receive focus.

CanSelect

: Returns whether the control can be selected.

Capture

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

CausesValidation

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

ClientEvents

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

ClientRectangle

: Returns the client rectangle of the control.

ClientSize

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

ContainsFocus

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

ContextMenu

: Returns or sets the shortcut menu associated with the control. (Default: null)

Controls

: Returns the collection of controls contained within the control.

Created

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

CssClass

: Returns or sets additional CSS class names to add to the widget.

Use this property to add or remove custom CSS classes that you may add to your application as standard css files or through the extender. You can assign multiple class names separated by a space and you can manage this property using the related methods:

CssStyle

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

You can use any CSS style string.

Cursor

: Returns or sets the cursor that is displayed when the mouse pointer is over the control. (Default: null)

DataBindings

: Returns the data bindings for the control.

DefaultBackColor

: Returns the default background color of the control.

DefaultFont

: Returns the default font of the control.

DefaultForeColor

: Returns the default background color of the control.

DisplayRectangle

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

Disposing

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

Dock

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

Enabled

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

EnableNativeContextMenu

: Enables or disables the browser's context menu.

Focusable

: Returns or sets whether the control can gain the focus. (Default: True)

Focused

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

Font

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

ForeColor

: Returns or sets the text color of the control.

Handle

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

HasChildren

: Returns whether the control contains any child control.

HasDataBindings

: Returns whether the control specifies data bindings.

HasResponsiveProfiles

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

HasUserData

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

Height

: Returns or sets the height of the control.

InitScript

: Returns or sets an initialization script to execute when the widget is created (or reloaded) in the browser.

Use this property to add custom initialization JavaScript that is always executed when the client widget is created. The context (this) of the script is the instance of the widget. You can use the entire qooxdoo and wisej.js api. See and .

You may also use the init script to attach events to the widget or to its internal children. Event handlers can also be attached using the collection and the client events methods:

InvokeRequired

: Returns true when this control belogs to a session different than the currently executing thread.

IsDisposed

: Returns whether the control has been disposed.

IsHandleCreated

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

IsMirrored

: Returns whether the control is mirrored.

LayoutEngine

: Returns the control's layout engine.

Left

: 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

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

Margin

: Returns or sets the space between controls.

MaximumSize

: Returns or sets the maximum size for the control.

MinimumSize

: Returns or sets the minimum size for the control.

ModifierKeys

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

MouseButtons

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

MousePosition

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

Movable

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

Name

: Gets or sets the name of the control.

Padding

: Returns or sets padding within the control.

Parent

: Returns or sets the parent container of the control.

PreferredSize

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

ResizableEdges

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

ResponsiveProfiles

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

Right

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

RightToLeft

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

When set to , the control inherits the value of this property from its parent. However, when the control is a top-level control (i.e. Window, Page, Desktop), and the value is set to , the right-to-left mode is automatically retrieved from the current language.

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

: 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 (Default: False)

Not to be confused with , which corresponds to the property. When is set to true, the text of the control (i.e. a label or a button) can be highlighted in the browser and copied to the clipboard. It will also make the widget "focusable" but only in the browser.

ShowLoader

: Returns or sets whether the control is blocked by the ajax loader. (Default: False)

Size

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

States

: Returns or sets additional theme states to the client widget.

Use this property to manage additional custom states that you may want to add to a widget. The state will update the visualization of the widget using the styles and properties set in the current theme and loaded theme mixins. You can also force the usage of built-in states. However, this property will not return the current states of the widget as updated by the client browser. It only returns the states set by the application.

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

Since 3.5.5 Add a + after the name of the state to propagate the state to the child controls of the widget. See also .

TabIndex

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

TabStop

: Returns or sets whether the user can give the focus to this control using the TAB key and the property is set to true. (Default: True)

Tag

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

Text

: Returns or sets the text associated with this control. (Default: "")

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 "<BR/>".

ToolTipText

: Returns or sets the tooltip text to show for this control. (Default: "")

When using property you can only set the ToolTip text and cannot change the default ToolTip icon set in the theme. To change the ToolTip icon you can either create a custom theme, or a theme mixin, or use the extender and the property added by the extender. You can change the default , , , , or enable HTML in by using a extender also without setting the property added by the extender.

Top

: 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

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

UserData

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

UseWaitCursor

: Returns or sets whether to use the wait cursor for the current control and all child controls. (Default: False)

ValidationCancelled

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

Visible

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

WheelDelta

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

Width

: 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

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

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

AddCssClass(name)

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

Parameter

Type

Description

Returns: . The new value of the property.

AddState(state)

Adds the specified theme state to the widget.

Parameter

Type

Description

Returns: . The new list of states stored in the property.

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

AddState(state, forward)

Adds the specified theme state to the widget and optionally propagates it to the child components when forward is true. Since 3.5.5

Parameter

Type

Description

Returns: . The new list of states stored in the property.

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

BeginInvoke(method)

Executes the specified delegate asynchronously, in the context of the session that owns the control.

Parameter

Type

Description

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

BeginInvoke(method, args)

Executes the specified delegate asynchronously, in the context of the session that owns the control, with the specified list of arguments.

Parameter

Type

Description

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

BringToFront()

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

Returns: .

Call(function, args)

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

Parameter

Type

Description

Returns: . this control

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

Returns: . this control

CallAsync(function, args)

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

CenterToParent()

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

Returns: . this control

CenterToParent(horizontal, vertical)

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

Parameter

Type

Description

Returns: . this control

Contains(control)

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

Parameter

Type

Description

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

CreateControl()

Creates and register this control and all its children.

Returns: .

DoDragDrop(data, allowedEffects)

Begins a drag-and-drop operation.

Parameter

Type

Description

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

DoDragDrop(data, allowedEffects, imageSource)

Begins a drag-and-drop operation.

Parameter

Type

Description

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

DoDragDrop(data, allowedEffects, imageSource, imageSize)

Begins a drag-and-drop operation.

Parameter

Type

Description

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

DoDragDrop(data, allowedEffects, image)

Begins a drag-and-drop operation.

Parameter

Type

Description

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

DoDragDrop(data, allowedEffects, image, imageSize)

Begins a drag-and-drop operation.

Parameter

Type

Description

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

EndInvoke(asyncResult)

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

Parameter

Type

Description

Returns: . The return value from the asynchronous operation.

Eval(javaScript)

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

Parameter

Type

Description

Returns: . this control

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

Returns: . this control

EvalAsync(javaScript)

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

FindForm()

Retrieves the that contains the control.

Returns: .

FindPage()

Retrieves the that contains the control.

Returns: .

Focus()

Sets input focus to the control.

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

Returns: . The child at the specified coordinates.this control

GetChildAtPoint(pt)

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

Parameter

Type

Description

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

GetClientEventListener(id)

Returns the script associated to the listener identified by id .

Parameter

Type

Description

Returns: . JavaScript associated with the listener.

GetClientEventListener(name)

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

Parameter

Type

Description

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

GetContainerControl()

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

Returns: . The parent .

GetNextControl(control, forward)

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

Parameter

Type

Description

Returns: . The next in the tab order.

GetStyle(flag)

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

Parameter

Type

Description

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

HasClientEventListener(name)

Checks whether the specified event name has any listener attached.

Parameter

Type

Description

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

HasCssClass(name)

Returns true if the property contains the specified class name .

Parameter

Type

Description

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

HasState(state)

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

Parameter

Type

Description

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

To check only if a propagated state is present, use HasState("state+");

Hide()

Conceals the control from the user.

Returns: .

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

Invoke(method)

Executes the specified delegate, in the context of the session that owns the control.

Parameter

Type

Description

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

Invoke(method, args)

Executes the specified delegate, in the context of the session that owns the control, with the specified list of arguments.

Parameter

Type

Description

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

IsMnemonic(charCode, text)

Determines whether the specified character is the mnemonic character.

Parameter

Type

Description

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

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

Throws:

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

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

Throws:

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

PointToClient(point)

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

Parameter

Type

Description

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

PointToScreen(point)

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

Parameter

Type

Description

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

RectangleToClient(rect)

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

Parameter

Type

Description

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

RectangleToScreen(rect)

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

Parameter

Type

Description

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

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

RemoveClientEventListener(id)

Detaches and removes the listener identified by id .

Parameter

Type

Description

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

RemoveClientEventListener(name)

Removes all the listeners attached to the event name .

Parameter

Type

Description

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

RemoveCssClass(name)

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

Parameter

Type

Description

Returns: . The new value of the property.

RemoveState(state)

Removes the specified theme state from the widget.

Parameter

Type

Description

Returns: . The new list of states stored in the property.

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

RemoveState(state, forward)

Removes the specified theme state from the widget. Since 3.5.5

Parameter

Type

Description

Returns: . The new list of states stored in the property.

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

ResetBindings()

Removes all the data bindings from the control.

Returns: .

ResumeLayout()

Resumes layout logic.

ResumeLayout(performLayout)

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

Parameter

Type

Description

ScrollControlIntoView(alignX, alignY)

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

Parameter

Type

Description

Returns: . this control

ScrollControlIntoView()

Scrolls the child control into view.

Returns: . this control

Select()

Activates, including setting the focus, a control.

Returns: .

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

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

Parameter

Type

Description

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

SendToBack()

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

Returns: .

SetBounds(x, y, width, height)

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

Parameter

Type

Description

Returns: .

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

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

Parameter

Type

Description

Returns: . this control

Show()

Displays the control to the user.

Returns: .

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

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

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

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

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

Events

Appear

Fired after the control has been fully rendered on the client.

This is a "lazy" event. It fires only when there is an handler attached to it, otherwise the companion On{Name} protected method is not invoked. It's enough to attach to either one of or to enable both events.

AutoSizeChanged

Fired when the property value changes.

BackColorChanged

Fired when the value of the property changes.

BackgroundImageChanged

Fired when the value of the property changes.

BackgroundImageLayoutChanged

Fired when the property changes.

BecomingActiveControlChanged

Fired when the value of the property changes.

BindingContextChanged

Occurs when the value of the property changes.

CausesValidationChanged

Fired when the value of the property changes.

Click

Fired when the control is clicked.

ClientSizeChanged

Fired when the property value changes.

ContextMenuChanged

Fired when the value of the property changes.

ControlAdded

Fired when a new control is added to the .

ControlCreated

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

ControlRemoved

Fired when a control is removed from the .

CursorChanged

Fired when the value of the property changes.

Disappear

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

Disposed

Fired when the component is disposed.

DockChanged

Fired when the value of the property changes.

DoubleClick

Fired when the control is double-clicked.

DragDrop

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

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

DragEnter

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

DragLeave

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

DragOver

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

DragStart

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

EnabledChanged

Fired when the property value has changed.

EndMove

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

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

EndResize

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

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

Enter

Fired when the control gains the input focus.

FontChanged

Fired when the property value changes.

ForeColorChanged

Fired when the property value changes.

GotFocus

Fired when the control gains the focus.

HelpRequested

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

ImeModeChanged

Fired when the ImeMode property has changed.

KeyDown

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

KeyPress

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

KeyUp

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

Layout

Fired when a control should reposition its child controls.

Leave

Fired when the control loses the input focus.

LocationChanged

Fired when the property value has changed.

LongTap

Fired when a pointer holds on the screen.

LostFocus

Fired when the control loses focus.

MarginChanged

Fired when the control's margin changes.

MouseCaptureChanged

Fired when the control loses mouse capture.

MouseClick

Fired when the control is clicked by the mouse.

MouseDoubleClick

Fired when the control is double clicked by the mouse.

MouseDown

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

MouseEnter

Fired when the mouse pointer enters the control.

MouseHover

Fired when the mouse pointer rests on the control.

MouseLeave

Fired when the mouse pointer leaves the control.

MouseMove

Fired when the mouse pointer is moved over the control.

MouseUp

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

MouseWheel

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

PaddingChanged

Fired when the control's padding changes.

Paint

Fired when a UserPaint control needs to redraw itself.

ParentChanged

Fired when the property value changes.

Pinch

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

PreviewKeyDown

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

QueryContinueDrag

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

Resize

Fired when the control is resized.

ResponsiveProfileChanged

Fired when the active responsive profile is changed.

RightToLeftChanged

Fired when the property value changes.

Rotate

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

SizeChanged

Fired when the property value changes.

StartMove

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

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

StartResize

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

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

StyleChanged

Fired when the control style changed.

Swipe

Fired when a pointer swipes over the screen.

TabIndexChanged

Fired when the property value has changed.

TabStopChanged

Fired when the value of the property changes.

Tap

Fired when a pointer taps on the screen.

TextChanged

Fired when the property value changes.

TouchCancel

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

TouchEnd

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

TouchMove

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

TouchStart

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

Track

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

Validated

Fired when the control is finished validating.

Validating

Fired when the control is validating.

VisibleChanged

Fired when the property value changes.

WidgetEvent

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

JavaScript code can fire any event back to a control, including custom data, using:

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

Inherited By

Name

Description

Implements

Name

Description