1 of 100

v2.2

Welcome

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

This is the API book, for the concepts documentation please refer to the link below. 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

Application

Wisej.Web.Application

Namespace: Wisej.Web

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

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

Properties

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

The client fingerprint is generated by hashing all the available information returned by the browser (OS, user agent, version, etc.) and it's not guaranteed to be unique.

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

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.

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

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

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

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

Methods

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

Parameter

Type

Description

filter

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.

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.

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.

Parameter

Type

Description

function

The name of the function to execute.

args

The arguments to pass to the function.

Cancels the fullscreen mode.

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.

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.

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.

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.

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.

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.

Stops the polling requests from the client.

Executes the JavaScript script on the client.

Parameter

Type

Description

script

The script to evaluate.

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.

Parameter

Type

Description

script

The script to evaluate.

Terminates the application and the corresponding session.

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

Parameter

Type

Description

match

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

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

Parameter

Type

Description

match

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

Loads an assembly given the file name or path.

Parameter

Type

Description

filePath

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

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

Creates an instance of the specified component from the assembly.

Parameter

Type

Description

filePath

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

className

Parameter

Type

Description

packages

callback

Parameter

Type

Description

packages

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.

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

Parameter

Type

Description

path

Navigate to the specified URL.

Parameter

Type

Description

url

URL to navigate to.

target

The target browser window: _self, _blank, etc.

Plays one of the built-in sounds

Parameter

Type

Description

type

Plays a sound.

Parameter

Type

Description

soundUrl

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

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

Prints the specified window.

Parameter

Type

Description

window

The window to print

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

Prints the entire browser window.

Causes the application to reload on the browser.

Removes the filter from the list of registered event filters.

Parameter

Type

Description

filter

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

Parameter

Type

Description

context

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.

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.


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

Parameter

Type

Description

action

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

Application.StartTask(() => {

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

Parameter

Type

Description

action

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

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.

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.

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

Parameter

Type

Description

context

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

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.

Implements

Name

Description

All wisej components implement this interface.

Application.FormCollection

Wisej.Web.Application FormCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Holds the collection of all top-level application forms.

public class FormCollection : ICollection, IEnumerable

Public Class FormCollection
    Inherits ICollection
    Implements IEnumerable

Properties

Methods

Returns an enumerator that iterates through the open forms.

Application.PageCollection

Wisej.Web.Application PageCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Holds the collection of all top-level application pages.

public class PageCollection : ICollection, IEnumerable

Public Class PageCollection
    Inherits ICollection
    Implements IEnumerable

Properties

Methods

Returns an enumerator that iterates through the open pages.

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

public class HashChangedEventArgs : EventArgs

Public Class HashChangedEventArgs
    Inherits EventArgs

Constructors

Name

Type

Description

value

Initial hash value.

Properties

Used By

Name

Description

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

public delegate void HashChangedEventHandler(Object sender, HashChangedEventArgs e)

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

Parameters

Fired By

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

public class ResponsiveProfileChangedEventArgs : EventArgs

Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs

Constructors

Name

Type

Description

oldValue

newValue

Properties

Used By

Name

Description

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

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Parameters

Fired By

Component

Wisej.Web.Component

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Constructors

Default constructor

Methods

Updates the component on the client.

Inherited By

Implements

ControlEventArgs

Wisej.Web.ControlEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Constructors

Properties

Used By

ControlEventHandler

Wisej.Web.ControlEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Parameters

Fired By

Buttons

Common Dialogs

Containers

Application

Wisej.Web.Application

Namespace: Wisej.Web

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

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

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 .
Read the applications's system information. Use , , , etc.
Listen to the application's global events. See , , , , , , and many more.
Retrieve browser related information. Use the to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The object is updated automatically when the user resizes the browser or the page is reloaded.
Control the client browser. Start a , execute JavaScript functions or scriptlets using or . Make the browser navigate to a different URL using or simply the page.
Manage the main page or current desktop. lets you change the object that fills the browser and "navigate" from page to page. lets you change the active object on the client browser.
Manage all live components in the session. Through the class you can find, iterate, inspect all live components of any type. See for all the currently created (visible or invisible) instances of . returns all the created objects. and 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. 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 to load a Wisej theme into the application. Or use the object to read all sorts of information from the current .
Terminate the application without waiting for the session to timeout. Use to terminate the current session and free all the related memory.

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 sets the client browser information.

ClientFingerprint

: Returns the unique client "fingerprint" ID. It can be used to distinguish client devices.

The client fingerprint is generated by hashing all the available information returned by the browser (OS, user agent, version, etc.) and it's not guaranteed to be unique.

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

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

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

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.

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.

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

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

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.

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.

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

: 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

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

filter

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

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.

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.

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.

Parameter

Type

Description

function

The name of the function to execute.

args

The arguments to pass to the function.

Cancels the fullscreen mode.

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.

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.

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.

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.

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.

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.

Stops the polling requests from the client.

Executes the JavaScript script on the client.

Parameter

Type

Description

script

The script to evaluate.

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.

Parameter

Type

Description

script

The script to evaluate.

Terminates the application and the corresponding session.

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

Parameter

Type

Description

match

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

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

Parameter

Type

Description

match

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

Loads an assembly given the file name or path.

Parameter

Type

Description

filePath

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

Creates an instance of the specified component from the assembly.

Parameter

Type

Description

filePath

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

className

Parameter

Type

Description

packages

callback

Parameter

Type

Description

packages

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.

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

Parameter

Type

Description

path

Navigate to the specified URL.

Parameter

Type

Description

url

URL to navigate to.

target

The target browser window: _self, _blank, etc.

Plays one of the built-in sounds

Parameter

Type

Description

type

Plays a sound.

Parameter

Type

Description

soundUrl

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

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

Prints the specified window.

Parameter

Type

Description

window

The window to print

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

Prints the entire browser window.

Causes the application to reload on the browser.

Removes the filter from the list of registered event filters.

Parameter

Type

Description

filter

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

Parameter

Type

Description

context

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.

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.


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

Parameter

Type

Description

action

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

Application.StartTask(() => {

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

Parameter

Type

Description

action

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

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.

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.

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

Parameter

Type

Description

context

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.

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

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.

Implements

Name

Description

All wisej components implement this interface.

Control

Wisej.Web.Control

Namespace: Wisej.Web

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

Properties

You can use this collection at design time or in code or through the listener methods:

You can use any CSS style string.


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

  // change the background color of the internal label of the button widget.
  this.button1.InitScript = "this.getChildControl('label').setBackgroundColor('red')";

  // attach a JavaScript event handler.
  this.textBox1.InitScript = @"this.addListener('keydown', function(e) {
    if (e.getKeyIdentifier() == "PageDown") {
      alert('You pressed PageDown.');
    }
  });

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.

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:

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

Methods

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.

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

Parameter

Type

Description

name

Name of the css class to add.

Adds the specified theme state to the widget.

Parameter

Type

Description

state

Name of the custom state to add to the widget.

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.

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

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

Parameter

Type

Description

function

The name of the JavaScript function to execute.

args

The arguments to pass to the function.

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.

Parameter

Type

Description

function

The name of the JavaScript function to execute.

args

The arguments to pass to the function.

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

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

Parameter

Type

Description

horizontal

Center horizontally.

vertical

Center vertically.

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

Parameter

Type

Description

control

Creates and register this control and all its children.

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

imageSource

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

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

imageSource

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

imageSize

The size of the drag image specified in imageSource.

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

image

Begins a drag-and-drop operation.

Parameter

Type

Description

data

The data to drag.

allowedEffects

image

imageSize

The size of the drag image specified in image.

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

Parameter

Type

Description

javaScript

The JavaScript code to run on the client.

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.

Parameter

Type

Description

javaScript

The JavaScript code to evaluate on the client.

Retrieves the form that the control is on.

Retrieves the page that the control is on.

Sets input focus to the control.

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

Parameter

Type

Description

skipValue

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

Parameter

Type

Description

Returns the script associated to the listener identified by id .

Parameter

Type

Description

Id of the listener to retrieve the script for.

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

Parameter

Type

Description

name

Name of the event.

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

Parameter

Type

Description

control

forward

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

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

Parameter

Type

Description

flag

Checks whether the specified event name has any listener attached.

Parameter

Type

Description

name

Name of the client event to verify.

Parameter

Type

Description

name

Css class name to verify.

Parameter

Type

Description

state

Name of the state to check.

Conceals the control from the user.

Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

Parameter

Type

Description

invalidateChildren

When true, invalidates all the children of the control.

Executes the specified delegate.

Parameter

Type

Description

method

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

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.

Determines whether the specified character is the mnemonic character.

Parameter

Type

Description

charCode

The character to test.

text

The string to search.

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

Parameter

Type

Description

point

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

Parameter

Type

Description

point

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

Parameter

Type

Description

rect

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

Parameter

Type

Description

rect

Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control, including the non-client areas such as the caption of forms or panels.

Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.

Parameter

Type

Description

refreshChildren

True to also refresh all the children of this control.

Detaches and removes the listener identified by id .

Parameter

Type

Description

Id of the listener to remove.

Removes all the listeners attached to the event name .

Parameter

Type

Description

name

Name of the event.

Parameter

Type

Description

name

The css class name to remove.

Removes the specified theme state from the widget.

Parameter

Type

Description

state

Name of the state to remove.

Resumes layout logic.

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.

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

Parameter

Type

Description

alignX

alignY

Scrolls the child control into view.

Activates a control.

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

Parameter

Type

Description

control

forward

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

tabStopOnly

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.

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

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

Parameter

Type

Description

width

height

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

Parameter

Type

Description

width

height

specified

Displays the control to the user.

Suspends the layout logic for the control.

Causes the control to update the corresponding client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .

Parameter

Type

Description

flags

Events

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.

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

UI implementation for the FileDialog class.

UI implementation for the FolderDialog class.

Displays data in a customizable list format.

Represents a shape control. Displays an element a border in any of the four sides.

Represents a panel that dynamically arranges its child controls.

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

Displays child controls vertically or horizontally in a scrollable container.

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.

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.

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.

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.

Displays information to the user in a about the object being viewed, the object's components, or the object's operation.

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

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 data grid control.

Represents a desktop container that can host floating windows.

Represents a control that can host ASP.NET or MVC pages within a Wisej application.

Represents the HTML5 canvas element.

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.

Base implementation for media controls.

Represents a split button control.

Represent an upload widget. Allows users to selected one or more files and upload them to the server.

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.

Represents a toolbar component.

Implements

Name

Description

Bindable components implement this interface.

All wisej components implement this interface.

Allows an object to serialize itself.

v2.2

Welcome

Legend

Concepts & Reference

Skills

Wisej.Web

General

Application

Properties

Methods

Events

Implements

Application.FormCollection

Properties

Methods

Application.PageCollection

Properties

Methods

HashChangedEventArgs

Constructors

Properties

Used By

HashChangedEventHandler

Parameters

Fired By

ResponsiveProfileChangedEventArgs

Constructors

Properties

Used By

ResponsiveProfileChangedEventHandler

Parameters

Fired By

Component

Constructors

Methods

Inherited By

Implements

ControlEventArgs

Constructors

Properties

Used By

ControlEventHandler

Parameters

Fired By

Buttons

Common Dialogs

Containers

Application.PageCollection

Properties

Count

Item(index)

Item(name)

Methods

GetEnumerator()

Count

Item(index)

Item(name)

GetEnumerator()

HashChangedEventHandler

Parameters

Fired By

HashChangedEventArgs

Constructors

HashChangedEventArgs(value)

Properties

Hash

Used By

Application.FormCollection

Properties

Count

Item(index)

Item(name)

Methods

GetEnumerator()

Welcome

Legend

Concepts & Reference

Skills

Application

Properties