1 of 70

General

Application

Wisej.Web.Application

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

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

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

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

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

Properties

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

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.

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

Valid: Whether the license is valid. Note that a license may be expired and valid if the product release date is within the license expiration date.
ProductName: Full name of the licensed product.
CustomerName: Name of the registered customer that owns the license.
ExpirationDate: Expiration date for the product free updates.

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

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.

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

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.

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

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.

Cancels the fullscreen mode.

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

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 image to the client.

Downloads the bytes in the stream to the client.

Downloads the specified file on 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.

Terminates the application and the corresponding session.

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

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

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

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

EXPERIMENTAL: Returns a session-static instance of T . Since 3.2.7

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

Loads an assembly given the file name or path.

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.

Changes the current theme.

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

Navigate to the specified URL.

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

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

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.

Prints the specified control.

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

Prints the entire browser window.

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

Generates a new session id without losing the session.

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

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.

Sets the current session timeout in seconds.

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

Throws:

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.

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:

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

Events

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

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

Client

Wisej.Core.Client

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.2.0.0)

Represents a unique client using the application.

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

Properties

Browsers

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

ID

: Unique client ID.

IPAddress

: IP Address of the client computer.

SessionCount

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

ClientBrowser

Wisej.Core.ClientBrowser

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.2.0.0)

Properties of the client browser currently interacting with the application.

Fields

Name

Type

Description

Properties

CultureInfo

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

Device

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

Features

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

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

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

ClientCollection

Wisej.Core.ClientCollection

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.2.0.0)

List of Clients using the application.

public class ClientCollection : IList<Client>, ICollection<Client>, IEnumerable<Client>, IEnumerable

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

Constructors

ClientCollection()

Properties

Count

Int32: Returns the total number of Client items in the collection.

Item(index)

Client: Returns the Client at the specified index .

ClientProfile

Wisej.Core.ClientProfile

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.2.0.0)

Definition of the client device.

Fields

Name

Type

Description

Properties

Device

: Device type.

Landscape

: Device landscape mode.

MaxScreenWidth

: Maximum screen width.

MaxWidth

Application

Wisej.Web.Application

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

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

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

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

Manage cookies. Use to manage browser's cookies.
Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.
Read the application's URL. Use , , , and .
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 the client browser's information.

ClientId

: Returns the current unique client id.

Clients

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

CommandManager

: Returns the current .

CommonAppDataPath

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

CommonAppDataRegistry

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

CompanyName

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

Configuration

: Returns the current .

Cookies

: Collection of cookies.

Current

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

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

CurrentCulture

: Returns or sets the current for the session.

Desktop

: Returns or sets the current Desktop.

EnableUnloadConfirmation

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

ExecutablePath

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

FavIcon

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

FavIconSource

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

Hash

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

IsAuthenticated

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

IsDisposed

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

IsExpired

: Returns true when the current session has expired.

IsSecure

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

IsTerminated

: Returns true when the current session has been terminated.

IsWebSocket

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

LicenseInfo

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

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

Valid: Whether the license is valid. Note that a license may be expired and valid if the product release date is within the license expiration date.
LicenseKey: License key loaded from web.config or assigned to .
ProductName: Full name of the licensed product.
CustomerName: Name of the registered customer that owns the license.
ExpirationDate: Expiration date for the product free updates.

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

LicenseKey

: Returns or sets the runtime server license key.

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

MainPage

: Returns or sets the current full page window.

OpenForms

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

OpenPages

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

Platform

: The name of the currently loaded platform.

ProductName

: Returns the product name associated with this application.

ProductVersion

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

QueryString

: Returns the parameters used to launch the application.

RightToLeft

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

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

RuntimeMode

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

ServerName

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

ServerPort

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

ServerVariables

: Returns the server variables.

Services

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

Session

: Provides a generic storage for session-based objects.

SessionCount

: Returns the total number of currently active sessions.

SessionId

: Returns the unique current session ID.

ShowConsole

: Shows or hides the debug console on the browser.

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

ShowLoader

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

StartupPath

: Returns the root path of the web application.

StartupUri

: Returns the URI used to start the application.

StartupUrl

: Returns the URL used to start the application.

Theme

: Returns or sets the current .

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

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

Title

: Returns or sets the page title in the browser.

Uri

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

Url

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

User

: Returns the security information for the current request.

UserAgent

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

UserHostAddress

: Returns the IP host address of the remote client.

UserHostName

: Returns the DNS name of the remote client.

UserIdentity

: Returns the type for the current user.

UserLanguages

: Gets a sorted string array of client language preferences.

Methods

AddEventFilter(filter)

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

Parameter

Type

Description

AddTranslation(text, translation)

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

Parameter

Type

Description

AlertAsync(message)

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

Call(function, args)

Executes the JavaScript function on the client.

Parameter

Type

Description

Call(function, callback, args)

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

Parameter

Type

Description

CallAsync(function, args)

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

CancelFullScreen()

Cancels the fullscreen mode.

ConfirmAsync(message)

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

Dispose()

Download(filePath, fileName, ondownload)

Downloads the specified file on the client.

Parameter

Type

Description

Download(image, fileName, ondownload)

Downloads the specified image to the client.

Parameter

Type

Description

Download(stream, fileName, ondownload)

Downloads the bytes in the stream to the client.

Parameter

Type

Description

Downloads the specified image to the client.

Downloads the bytes in the stream to the client.

Downloads the specified file on 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.

Terminates the application and the corresponding session.

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

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

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

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

EXPERIMENTAL: Returns a session-static instance of T . Since 3.2.7

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

Loads an assembly given the file name or path.

Creates an instance of the specified component from the assembly.

Changes the current theme.

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

Navigate to the specified URL.

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

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

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.

Prints the specified control.

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

Prints the entire browser window.

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

Generates a new session id without losing the session.

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

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.

Sets the current session timeout in seconds.

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

Throws:

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.

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

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

Events

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

Configuration

Wisej.Core.Configuration

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.2.0.0)

Wisej configuration settings.

public class Configuration

Public Class Configuration

Constructors

Configuration(json)

Creates a new instance from the specified json string.

Name

Type

Description

Properties

AllowedRoutes

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

AutoReload

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

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


  <script>
    Wisej.onExit = function() {
      // this is the default implementation
      // when AutoReload is set to true.
      location.reload();
    }
  </script>

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

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

Boolean: Enabled/disables debug mode.

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

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

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

Boolean: Enables the PWA installation of the application.

Boolean: Enabled/disables the WebSocket protocol.

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

String: The full path of the configuration file.

Boolean: Enables impersonation mode.

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

Int32: The keep-alive interval in seconds.

Int32: The ajax loader timeout in milliseconds.

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

Int32: Returns the maximum number of nested modal loops.

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

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

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

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

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

Object: Native client-side platform options.

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

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

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

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

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

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

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

Object: Application settings.

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

String: The startup Main method.

String: Theme name.

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

String: Url redirection.

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

Methods

Loads or retrieves the configuration file.

Returns: Configuration.

Events

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

An application can install a custom configuration handler and return a custom Configuration object. In alternative, the handler can change the value of FilePath and let Wisej.NET load the alternative json file. This is a static event and should be attached to before the application starts. One way to do that is to register an HttpModuleStartup method with IIS when using .NET 4.8. When running on .NET Core, attach to the event in the Startup method.


[assembly: PreApplicationStartMethod(typeof(ApplicationNameSpace.HttpModuleStartup), "Start")]

namespace ApplicationNameSpace
{
  public static class HttpModuleStartup
  {
    public static void Start()
    {
      Wisej.Core.Configuration.LoadConfiguration += (s, e) =>
      {
        // load json from a file, or build a json object.
        // you can also implement your own caching mechanism here.
        
        e.SuppressCache = true;
        
        return new Wisej.Core.Configuration(new
        {
          url = "Default.html",
          theme = "bootstrap-4",
          startup = "ApplicationNameSpace.Program.Main, Application"
          
        }.ToJSON());
      }
    }
  }
}

ClientTheme

Wisej.Core.ClientTheme

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.2.0.0)

Represents a Wisej theme.

public class ClientTheme : IWisejSerializable

Public Class ClientTheme
    Inherits IWisejSerializable

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


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

// create a new custom theme from a JSON string.
var myTheme2 = new ClientTheme("MyTheme2", json);

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

Constructors

ClientTheme(name)

Default private constructor.

Name

Type

Description

Constructs a new theme from the name and JSON definition.

Constructs a new theme from the base theme.

Properties

Object: Theme appearances.

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


// alter the border of buttons.
// note that when there is a keyword clash you can use the @ prefix.
Application.Theme.Appearances.button.states.@default.styles.width = 3;
Application.Theme.Appearances.button.states.@default.styles.radius = 0;

// additionally, you my use a string indexer to reach any property.
Application.Theme.Appearances.button.states["default"].styles.radius = 0;

Object: Theme colors.

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



// change existing color.
Application.Theme.Colors.buttonFace = "red";

// create a new color.
Application.Theme.Colors.myCoolColor = "rgba(5,23,55,0.9)";

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

Object: Theme fonts.

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



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

Object: Theme images.

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

Absolute URL An URL starting with http: or https: pointing to an image resource.
Relative URL An URL relative to the current site or relative to value of Images.baseUrl.
base64 A base64 encoded embedded image.

String: The name of the theme.

Object: Theme settings.

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

native-scrollbars Instructs Wisej to use the native scrollbars instead of the themed scrollbars. Setting this property can have negative side effects for virtual scrolling widgets like the DataGridView. The default is false.
overlapped-scrollbars Instructs Wisej to layout the scrollbars over the content being scrolled, similar to Windows' fluent themes or mobiles. The default is false.

Object: Stylesheet rules embedded in the theme.

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



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

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

Methods

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

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

Returns the resolved theme color from the color list.

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

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

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

Returns the resolved font defined from the font list.

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

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

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

Returns the resolved image defined from the image list.

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

Returns the size of the inset border and padding.

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

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

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

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

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

Returns true if the color is a theme color.

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

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

Returns true if the font is a theme font.

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

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

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

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

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

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

Implements

Control

Wisej.Web.Control

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Base class for all Wisej controls.

Constructors

Control()

Initializes a new instance of the class.

Properties

AccessibleDescription

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

AccessibleName

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

AccessibleRole

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

You can use any CSS style string.

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.

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

Methods

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

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

Adds the specified theme state to the widget.

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

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

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.

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.

Creates and register this control and all its children.

Begins a drag-and-drop operation.

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

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.

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.

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

Returns the script associated to the listener identified by id .

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

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

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

Checks whether the specified event name has any listener attached.

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, in the context of the session that owns the control.

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

Determines whether the specified character is the mnemonic character.

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

Throws:

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

Throws:

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

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

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

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

Computes the size and location of the specified client rectangle 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 the corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.

Detaches and removes the listener identified by id .

Removes all the listeners attached to the event name .

Removes the specified theme state from the widget.

Removes all the data bindings from the control.

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.

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 the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by 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:

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

Inherited By

Implements

DataObject

Wisej.Web.DataObject

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Implements a basic data transfer mechanism.

public class DataObject : IDataObject

Public Class DataObject
    Inherits IDataObject

Constructors

DataObject()

Initializes a new instance of the DataObject class.

DataObject(data)

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

Name

Type

Description

DataObject(format, data)

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

Name

Type

Description

DataObject(format, data)

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

Methods

Indicates whether the data object contains data in the WaveAudio format.

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

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

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

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

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

Indicates whether the data object contains data in the UnicodeText format.

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

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

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

Retrieves an audio stream from the data object.

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

Returns the data associated with the specified class type format.

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

Returns the data associated with the specified data format.

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

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

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

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

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

Returns the data associated with the specified class type format.

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

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

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

Returns the list of file types from the data object.

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

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

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

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

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

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

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

Retrieves an image from the data object.

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

Retrieves text data from the data object in the UnicodeText format.

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

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

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

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

Throws:

ArgumentNullException audioBytes is null.

Adds a Stream to the data object in the WaveAudio format.

Throws:

ArgumentNullException audioStream is null.

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

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

Adds the specified object to the DataObject using the specified format.

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

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

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

Throws:

ArgumentNullException filePaths is null.

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

Throws:

ArgumentNullException filePaths is null.

Adds an Image to the data object in the Bitmap format.

Throws:

ArgumentNullException image is null.

Adds text data to the data object in the UnicodeText format.

Throws:

ArgumentNullException textData is null or Empty.

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

Throws:

ArgumentNullException textData is null or Empty.

General

Application

Properties

Methods

Events

Implements

Client

Properties

Browsers

ID

IPAddress

SessionCount

ClientBrowser

Fields

Properties

CultureInfo

Device

Features

ClientCollection

Constructors

ClientCollection()

Properties

Count

Item(index)

ClientProfile

Fields

Properties

Device

Landscape

MaxScreenWidth

MaxWidth

ClientCollection

Constructors

ClientCollection()

Properties

Count

Item(index)

Client

Properties

Browsers

ID

IPAddress

SessionCount

ClientBrowser

Fields

Properties

CultureInfo

Device

Features

IPAddress

IsDarkMode

IsFullScreen

IsSecure

Language

OS

PixelRatio

Profiles

ScreenSize

SessionId

Size

TabId

TimezoneOffset

Type

UserAgent

UserData

Version

Application

Properties

ActiveProfile

Browser

ClientId

Clients

CommandManager

CommonAppDataPath

CommonAppDataRegistry

CompanyName

Configuration

Cookies

Current

CurrentCulture