1 of 100

v2.2

Welcome

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

Legend

Icon

Description

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:

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

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

Manage cookies. Use Cookies to manage browser's cookies.
Read server variables. Use ServerVariables to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: ServerPort, ServerName, UserAgent, etc.
Read the application's URL. Use Uri, Url, StartupUri, and StartupUrl.
Read the applications's system information. Use StartupPath, ProductName, ProductVersion, etc.
Listen to the application's global events. See SessionTimeout , BeginRequest, ApplicationStart, ApplicationExit ApplicationRefresh, BrowserSizeChanged ResponsiveProfileChanged, CultureChanged, and many more.
Retrieve browser related information. Use the Browser to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The Browser object is updated automatically when the user resizes the browser or the page is reloaded.
Control the client browser. Start a Download, execute JavaScript functions or scriptlets using Call or Eval. Make the browser navigate to a different URL using Navigate or simply Reload the page.
Manage the main page or current desktop. MainPage lets you change the Page object that fills the browser and "navigate" from page to page. Desktop lets you change the active Desktop object on the client browser.
Manage all live components in the session. Through the Application class you can find, iterate, inspect all live components of any type. See OpenForms for all the currently created (visible or invisible) instances of Form. OpenPages returns all the created Page objects. FindComponent and FindComponents provide an easy way to find any component in the session or to iterate the list of components that match a custom expression.
Start background tasks in context. StartTask provides a powerful way to start a background task on the server that can keep interacting with the client browser while running independently.
Manage the application's theme. Use LoadTheme to load a Wisej theme into the application. Or use the Theme object to read all sorts of information from the current ClientTheme.
Terminate the application without waiting for the session to timeout. Use Exit to terminate the current session and free all the related memory.

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

Properties

ClientProfile: Returns or sets the current client responsive profile.

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

ClientBrowser: Returns or sets the client browser information.

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

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

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

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

Configuration: Returns the current Configuration.

CookieCollection: Collection of cookies.

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

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

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

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

Desktop: Returns or sets the current Desktop.

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

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

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

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

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

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

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

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

Boolean: Returns true when the current session has expired.

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

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

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

String: Returns or sets the runtime server license key.

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

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

Page: Returns or sets the current full page window.

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

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

ClientPlatform: The name of the currently loaded platform.

String: Returns the product name associated with this application.

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

NameValueCollection: Returns the parameters used to launch the application.

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

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

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

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

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

NameValueCollection: Returns the server variables.

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

Int32: Returns the total number of currently active sessions.

String: Returns the unique current session ID.

Boolean: Shows or hides the debug console on the browser.

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

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

String: Returns the root path of the web application.

Uri: Returns the URI used to start the application.

String: Returns the URL used to start the application.

ClientTheme: Returns or sets the current ClientTheme.

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

// create a new custom theme cloned from the current theme.
var myTheme = new ClientTheme("MyTheme", Application.Theme);

// alter the buttonFace color.
myTheme.Colors.buttonFace = "red";

// update the current session using the new custom theme.
Application.Theme = myTheme;

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


// change the buttonFace color in the current theme.
// if the theme is one of the global themes, i.e. it was loaded
// using Application.LoadTheme(name), then the change is also global.
Application.Theme.Colors.buttonFace = "red";

// since the theme objects are all dynamic and use a special DynamicObject
// class part of the Wisej Framework, you can also use a string indexer
// to address any field.
Application.Theme.Colors["buttonFace"] = "red";

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

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

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

IPrincipal: Returns the security information for the current request.

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

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

String: Gets the DNS name of the remote client.

WindowsIdentity: Returns the WindowsIdentity type for the current user.

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

Methods

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

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

Executes the JavaScript function on the client.

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

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

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

Cancels the fullscreen mode.

Downloads the specified file on the client.

Downloads the specified image to the client.

Downloads the bytes in the stream to the client.

Downloads the specified file on the client.

Downloads the specified image to the client.

Downloads the bytes in the stream to the client.

Stops the polling requests from the client.

Executes the JavaScript script on the client.

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

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

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

Terminates the application and the corresponding session.

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

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

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

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

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

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

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

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

Loads an assembly given the file name or path.

Returns: Assembly. The loaded Assembly.

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

Creates an instance of the specified component from the assembly.

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

Returns: Task<Boolean>.

Changes the current theme.

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

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

Navigate to the specified URL.

Plays one of the built-in sounds

Plays a sound.

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

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.

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.

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

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

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


// this has not effect when the client and server are connected using WebSocket.
Application.StartPolling(1000);

Application.StartTask(() => {

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

  // this has not effect when the client and server are connected using WebSocket.
  Application.EndPolling();

});

Throws:

ArgumentOutOfRangeException The interval specified is less than 1.

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

Returns: Task. An awaitable Task.

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

Application.StartTask(() => {

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

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

Returns: Task<T>.

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

string text = await Application.StartTask(() => {

  string value = "";
  for (int i = 0; i < 100; i++) {
  
    value += i.ToString();
    
    // just wait a bit or it's too fast.
    Thread.Sleep(100);
  }
  return value;
});

this.label.Text = text;
Application.Update(this);

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

Starts a Timer bound to the current session context.

Returns: Timer. An instance of Timer.

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

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

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

EventHandler Fired when the active window changes.

EventHandler Fired when the application is about to shut down.

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

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

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

EventHandler Fired at the beginning of every request.

EventHandler Fired when the user resizes the browser.

EventHandler Fired when the user activates the browser tab.

EventHandler Fired when the user deactivates the browser tab.

EventHandler Fired when the CurrentCulture changes.

EventHandler Fired at the end of every request.

EventHandler Fired when the focused control changes.

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

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

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

EventHandler Fired when the RightToLeft value changes.

HandledEventHandler Fired when the session is about to time out.

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

EventHandler Fired when the current theme is changed.

ThreadExceptionEventHandler Fired when a thread exception is thrown.

Implements

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

Count

Int32: Returns the total number of currently open forms.

Item(index)

Form: Returns the form at the specified index.

Item(name)

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

Methods

GetEnumerator()

Returns an enumerator that iterates through the open forms.

Returns: IEnumerator.

Application.PageCollection

Wisej.Web.Application PageCollection

Namespace: Wisej.Web

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

Count

Int32: Returns the total number of currently open pages.

Item(index)

Page: Returns the page at the specified index.

Item(name)

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

Methods

GetEnumerator()

Returns an enumerator that iterates through the open pages.

Returns: IEnumerator.

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

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

Name

Type

Description

Properties

Hash

String: The hash string from the client.

Used By

Name

Description

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the HashChanged event.

public delegate void HashChangedEventHandler(Object sender, HashChangedEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

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

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

Name

Type

Description

Fired By

Name

Description

Clipboard

Wisej.Web.Clipboard

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Methods

Clear()

Removes all data from the Clipboard.

ContainsAudio()

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

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

ContainsData(format)

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

Parameter

Type

Description

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

ContainsFileDropList()

Retrieves an audio stream from the Clipboard.

Retrieves data from the Clipboard in the specified format.

Retrieves the data that is currently on the system Clipboard.

Retrieves a collection of file names from the Clipboard.

Retrieves an image from the Clipboard.

Throws:

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

Throws:

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

Throws:

Saves the specified data to the clipboard.

Throws:

Component

Wisej.Web.Component

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Extends and enabled the components to appear on the designer surface.

Constructors

Component()

Default constructor

Methods

Update()

Updates the component on the client.

Inherited By

Implements

Control.ControlCollection

Wisej.Web.Control ControlCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents a collection of objects.

Constructors

ControlCollection(owner)

Initializes a new instance of the class.

Name

Type

Description

Properties

IsDisposed

: Returns whether the owner control has already been disposed.

Item(index)

: Returns the at the specified indexed location.

Item(key)

Methods

Adds the specified control to the control collection.

Adds an array of control objects to the collection.

Removes all controls from the collection.

Removes and disposes all controls from the collection.

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

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

Throws:

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

Throws:

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

Throws:

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

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

Removes the specified control from the control collection.

Removes the child control with the specified key.

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

ControlEventArgs

Wisej.Web.ControlEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the and events.

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

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

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

Manage cookies. Use Cookies to manage browser's cookies.
Read server variables. Use ServerVariables to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: ServerPort, ServerName, UserAgent, etc.
Read the application's URL. Use Uri, Url, StartupUri, and StartupUrl.
Read the applications's system information. Use StartupPath, ProductName, ProductVersion, etc.
Listen to the application's global events. See SessionTimeout , BeginRequest, ApplicationStart, ApplicationExit ApplicationRefresh, BrowserSizeChanged ResponsiveProfileChanged, CultureChanged, and many more.
Retrieve browser related information. Use the Browser to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The Browser object is updated automatically when the user resizes the browser or the page is reloaded.
Control the client browser. Start a Download, execute JavaScript functions or scriptlets using Call or Eval. Make the browser navigate to a different URL using Navigate or simply Reload the page.
Manage the main page or current desktop. MainPage lets you change the Page object that fills the browser and "navigate" from page to page. Desktop lets you change the active Desktop object on the client browser.
Manage all live components in the session. Through the Application class you can find, iterate, inspect all live components of any type. See OpenForms for all the currently created (visible or invisible) instances of Form. OpenPages returns all the created Page objects. FindComponent and FindComponents provide an easy way to find any component in the session or to iterate the list of components that match a custom expression.
Start background tasks in context. StartTask provides a powerful way to start a background task on the server that can keep interacting with the client browser while running independently.
Manage the application's theme. Use LoadTheme to load a Wisej theme into the application. Or use the Theme object to read all sorts of information from the current ClientTheme.
Terminate the application without waiting for the session to timeout. Use Exit to terminate the current session and free all the related memory.

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

Properties

ActiveProfile

ClientProfile: Returns or sets the current client responsive profile.

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

Browser

ClientBrowser: Returns or sets the client browser information.

ClientFingerprint

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

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

CommonAppDataRegistry

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

CompanyName

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

Configuration

Configuration: Returns the current Configuration.

Cookies

CookieCollection: Collection of cookies.

Current

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

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

CurrentCulture

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

Desktop

Desktop: Returns or sets the current Desktop.

EnableUnloadConfirmation

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

ExecutablePath

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

FavIcon

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

FavIconSource

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

Hash

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

IsAuthenticated

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

IsDisposed

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

IsExpired

Boolean: Returns true when the current session has expired.

IsSecure

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

IsTerminated

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

IsWebSocket

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

LicenseKey

String: Returns or sets the runtime server license key.

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

MainPage

Page: Returns or sets the current full page window.

OpenForms

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

OpenPages

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

Platform

ClientPlatform: The name of the currently loaded platform.

ProductName

String: Returns the product name associated with this application.

ProductVersion

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

QueryString

NameValueCollection: Returns the parameters used to launch the application.

RightToLeft

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

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

RuntimeMode

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

ServerName

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

ServerPort

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

ServerVariables

NameValueCollection: Returns the server variables.

Session

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

SessionCount

Int32: Returns the total number of currently active sessions.

SessionId

String: Returns the unique current session ID.

ShowConsole

Boolean: Shows or hides the debug console on the browser.

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

ShowLoader

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

StartupPath

String: Returns the root path of the web application.

StartupUri

Uri: Returns the URI used to start the application.

StartupUrl

String: Returns the URL used to start the application.

Theme

ClientTheme: Returns or sets the current ClientTheme.

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

// create a new custom theme cloned from the current theme.
var myTheme = new ClientTheme("MyTheme", Application.Theme);

// alter the buttonFace color.
myTheme.Colors.buttonFace = "red";

// update the current session using the new custom theme.
Application.Theme = myTheme;

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


// change the buttonFace color in the current theme.
// if the theme is one of the global themes, i.e. it was loaded
// using Application.LoadTheme(name), then the change is also global.
Application.Theme.Colors.buttonFace = "red";

// since the theme objects are all dynamic and use a special DynamicObject
// class part of the Wisej Framework, you can also use a string indexer
// to address any field.
Application.Theme.Colors["buttonFace"] = "red";

Title

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

Uri

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

Url

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

User

IPrincipal: Returns the security information for the current request.

UserAgent

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

UserHostAddress

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

UserHostName

String: Gets the DNS name of the remote client.

UserIdentity

WindowsIdentity: Returns the WindowsIdentity type for the current user.

UserLanguages

Type

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 Task with the result of the remote call.

Parameter

Type

Description

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

Exit()

Terminates the application and the corresponding session.

FindComponent(match)

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

Parameter

Type

Description

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

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

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

FindComponents(match)

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

Parameter

Type

Description

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

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

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

LoadAssembly(filePath)

Loads an assembly given the file name or path.

Parameter

Type

Description

Returns: Assembly. The loaded Assembly.

LoadComponent(filePath, className)

Creates an instance of the specified component from the assembly.

Parameter

Type

Description

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

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

Parameter

Type

Description

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

Navigate(url, target)

Navigate to the specified URL.

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.


void Test() {

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

Print(window)

Prints the specified window.

Parameter

Type

Description

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

Print()

Prints the entire browser window.

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

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


// this has not effect when the client and server are connected using WebSocket.
Application.StartPolling(1000);

Application.StartTask(() => {

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

  // this has not effect when the client and server are connected using WebSocket.
  Application.EndPolling();

});

Throws:

ArgumentOutOfRangeException The interval specified is less than 1.

StartTask(action)

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

Parameter

Type

Description

Returns: Task. An awaitable Task.

Application.StartTask(() => {

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

StartTask<T>(action)

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

Parameter

Type

Description

Returns: Task<T>.

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

string text = await Application.StartTask(() => {

  string value = "";
  for (int i = 0; i < 100; i++) {
  
    value += i.ToString();
    
    // just wait a bit or it's too fast.
    Thread.Sleep(100);
  }
  return value;
});

this.label.Text = text;
Application.Update(this);

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

StartTimer(dueTime, period, callback)

Starts a Timer bound to the current session context.

Parameter

Type

Description

Returns: Timer. An instance of Timer.

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

Application.StartTask(() => {

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

});

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

Application.StartTask(() => {

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

});

Events

ActiveWindowChanged

EventHandler Fired when the active window changes.

ApplicationExit

EventHandler Fired when the application is about to shut down.

ApplicationRefresh

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

ApplicationStart

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

BeforeInstallPrompt

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

BeginRequest

EventHandler Fired at the beginning of every request.

BrowserSizeChanged

EventHandler Fired when the user resizes the browser.

BrowserTabActivated

EventHandler Fired when the user activates the browser tab.

BrowserTabDeactivated

EventHandler Fired when the user deactivates the browser tab.

CultureChanged

EventHandler Fired when the CurrentCulture changes.

EndRequest

EventHandler Fired at the end of every request.

FocusedControlChanged

EventHandler Fired when the focused control changes.

HashChanged

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

Idle

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

ResponsiveProfileChanged

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

RightToLeftChanged

EventHandler Fired when the RightToLeft value changes.

SessionTimeout

HandledEventHandler Fired when the session is about to time out.

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

ThemeChanged

EventHandler Fired when the current theme is changed.

ThreadException

ThreadExceptionEventHandler Fired when a thread exception is thrown.

Implements

Name

Description

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

Control()

Initializes a new instance of the Control class.

Properties

AccessibleDescription

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

AccessibleName

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

AccessibleRole

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

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

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

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

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

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

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

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

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

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

Boolean: Determines whether the control can execute a command.

Boolean: Returns whether the control can receive focus.

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

ClientEventCollection: Returns a collection of client events and JavaScript listeners. You may attach multiple listeners to same event.

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

AddClientEventListener
HasClientEventListener
RemoveClientEventListener
RemoveClientEventListener
GetClientEventListener

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

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

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

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

AddCssClass
RemoveCssClass
HasCssClass

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

You can use any CSS style string.


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

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

ControlBindingsCollection: Returns the data bindings for the control.

Color: Returns the default background color of the control.

Font: Returns the default font of the control.

Color: Returns the default background color of the control.

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

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

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

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

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

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

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

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

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

Boolean: Returns whether the control specifies data bindings.

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

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

Int32: Returns or sets the height of the control.

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

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

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

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

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

AddClientEventListener
HasClientEventListener
RemoveClientEventListener
RemoveClientEventListener
GetClientEventListener

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

Boolean: Returns whether the control is mirrored.

LayoutEngine: Returns the control's layout engine.

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

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

Padding: Returns or sets the space between controls.

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

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

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

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

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

String: Gets or sets the name of the control.

Padding: Returns or sets padding within the control.

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

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

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

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

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

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

The behavior of this property is configurable in Default.json setting the "rightToLeft" property to "true", "false", or "auto". The default is "auto", causing the value to be retrieved from the current language.

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

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

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

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

  // force the widget to update the UI as if it was hovered and focused.
  this.button1.States = new [] { "hovered", "focused" };

  // apply a custom state defined in a custom theme or theme mixing.
  this.panel1.States = new [] { "alert" };

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

AddState
RemoveState
HasState

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

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

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

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

When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with " ".

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

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

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

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

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

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

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

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

Int32: Returns or sets the width of the control.

Methods

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

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

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

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

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

Adds the specified theme state to the widget.

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

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

Executes the specified delegate asynchronously.

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

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

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

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

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

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

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

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

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

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

Creates and register this control and all its children.

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

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

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

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

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

Retrieves the form that the control is on.

Returns: Form.

Retrieves the page that the control is on.

Returns: Page.

Sets input focus to the control.

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

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

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

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

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

Returns the script associated to the listener identified by id .

Returns: String. JavaScript associated with the listener.

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

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

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

Returns: IContainerControl. The parent IContainerControl.

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

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

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

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

Checks whether the specified event name has any listener attached.

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

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

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

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

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

Conceals the control from the user.

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

Executes the specified delegate.

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

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

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

Determines whether the specified character is the mnemonic character.

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

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

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

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

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

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

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

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

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

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

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

Detaches and removes the listener identified by id .

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

Removes all the listeners attached to the event name .

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

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

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

Removes the specified theme state from the widget.

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

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

Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values.

Resumes layout logic.

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

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

Scrolls the child control into view.

Activates a control.

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

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

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

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

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

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 selectable child controls in the container, including descendants. This is equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See Selectable for details of exactly which child controls will be validated.

Returns: Boolean.

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

Returns: Boolean.

Events

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

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

EventHandler Fired when the AutoSize property value changes.

EventHandler Fired when the value of the BackColor property changes.

EventHandler Fired when the value of the BackgroundImage property changes.

EventHandler Fired when the BackgroundImageLayout property changes.

EventHandler Occurs when the value of the BindingContext property changes.

EventHandler Fired when the value of the CausesValidation property changes.

EventHandler Fired when the control is clicked.

EventHandler Fired when the ClientSize property value changes.

EventHandler Fired when the value of the ContextMenu property changes.

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

EventHandler Fired when the value of the Cursor property changes.

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

EventHandler Fired when the component is disposed.

EventHandler Fired when the value of the Dock property changes.

EventHandler Fired when the control is double-clicked.

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

This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

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

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

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

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

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

EventHandler Fired when the Enabled property value has changed.

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

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

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

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

EventHandler Fired when the control gains the input focus.

EventHandler Fired when the Font property value changes.

EventHandler Fired when the ForeColor property value changes.

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

EventHandler Fired when the ImeMode property has changed.

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

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

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

LayoutEventHandler Fired when a control should reposition its child controls.

EventHandler Fired when the control loses the input focus.

EventHandler Fired when the Location property value has changed.

EventHandler Fired when a pointer holds on the screen.

EventHandler Fired when the control's margin changes.

EventHandler Fired when the control loses mouse capture.

MouseEventHandler Fired when the control is clicked by the mouse.

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

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

EventHandler Fired when the mouse pointer enters the control.

EventHandler Fired when the mouse pointer rests on the control.

EventHandler Fired when the mouse pointer leaves the control.

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

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

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

EventHandler Fired when the control's padding changes.

PaintEventHandler Fired when a UserPaint control needs to redraw itself.

EventHandler Fired when the Parent property value changes.

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

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

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

EventHandler Fired when the control is resized.

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

EventHandler Fired when the RightToLeft property value changes.

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

EventHandler Fired when the Size property value changes.

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

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

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

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

EventHandler Fired when the control style changed.

SwipeEventHandler Fired when a pointer swipes over the screen.

EventHandler Fired when the TabIndex property value has changed.

EventHandler Fired when the value of the TabStop property changes.

EventHandler Fired when a pointer taps on the screen.

EventHandler Fired when the Text property value changes.

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

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

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

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

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

EventHandler Fired when the control is finished validating.

CancelEventHandler Fired when the control is validating.

EventHandler Fired when the Visible property value changes.

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

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

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

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

  
  private void control_WidgetEvent(object sender, WidgetEventArgs e) {
    
    switch (e.Type) {
    
      case "myevent":
        var data = e.Data;
        Alert.Show($"x={data.x}, y={data.y}, name={data.name}");
        break;
    }
  }