1 of 100

v3.0

Welcome

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

Legend

Icon

Description

Instance method, or property, or event.

Static method or property or event.

Protected method or property or event.

Deprecated method or property or event.

Concepts & Reference

The concept documentation and the namespace reference are a never-ending work in progress. We update it almost daily. Please check back if what you are looking for is not available.

Skills

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

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

Wisej.Web

General

Client

Wisej.Core.Client

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents a unique client using the application.

public class Client

Public Class Client

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

Properties

Browsers

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

ID

String: Unique client ID.

IPAddress

String: IP Address of the client computer.

SessionCount

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

ClientBrowser

Wisej.Core.ClientBrowser

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Properties of the client browser currently interacting with the application.

public class ClientBrowser

Public Class ClientBrowser

Fields

Name

Type

Description

CookieStorage

LocalStorage

SessionStorage

Properties

CultureInfo

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

Device

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

Features

Object: Returns the set of features supported/not-supported by the browser. Currently we detect: geolocation, webSocket, fullScreen, speechSynthesis, speechRecognition, notification, fullScreen, browserStorage.

String: IP Address of the client computer.

Boolean: Returns true if the browser is using dark mode. [Since 3.0.10]

Boolean: Returns true if the browser is in full screen mode.

Boolean: Returns true if the connection is secure.

String: Client language.

String: Client OS. Can be one of "iOS", "Android", "WebOS", "BlackBerry", "MacOS", "Linux", "Windows", "Unix", "Other".

Double: Returns the ratio of the resolution in physical pixels to the resolution in CSS pixels for the current display device.

ClientProfile[]:

Size: Screen size.

String: Returns the session ID associated with this ClientBrowser.

Size: Browser size. This is the window size, which can be different from the device (or screen) size.

String: Identifies the browser tab associated with with this ClientBrowser instance.

Int32: Returns the time difference between UTC time and local time, in minutes.

String: Browser type. Can be one of "IE", "Edge", "Chrome", "Opera", "Firefox", "Safari", "Other".

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

Object: Returns a value or map set by the client when loading the application's first HTML page.

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

<script>
Wisej.userData = {
value1: 100,
someName: "test"
};
</script>

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


int value1 = Application.Browser.UserData.value1;
string value2 = Application.Browser.UserData.someName;

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.

Int32: Browser version.

ClientCollection

Wisej.Core.ClientCollection

Namespace: Wisej.Core

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

ClientPlatform

Wisej.Core.ClientPlatform

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents the client platform used to render the widgets.

public class ClientPlatform

Public Class ClientPlatform

Properties

JavaScripts

String[]: List of javascript files associated with the platform.

Name

String: The name of this platform configuration.

Provider

PlatformProvider: The platform provider.

StyleSheets

String[]: List of style sheets associated with the platform.

Version

Version: Returns the file version of the

ClientProfile

Wisej.Core.ClientProfile

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Definition of the client device.

public class ClientProfile

Public Class ClientProfile

Fields

Name

Type

Description

Default

Properties

Device

String: Device type.

Landscape

Nullable<Boolean>: Device landscape mode.

MaxScreenWidth

Int32: Maximum screen width.

MaxWidth

Int32: Maximum browser width.

Int32: Minimum screen width.

Int32: Minimum browser width.

String: Name of the profile.

String: User agent string.

ClientTheme

Wisej.Core.ClientTheme

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents a Wisej theme.

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

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

Constructors

ClientTheme(name)

Default private constructor.

Name

Type

Description

ClientTheme(name, json)

Constructs a new theme from the name and JSON definition.

Constructs a new theme from the base theme.

Properties

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.

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

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:

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.

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.

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

Methods

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

Returns the resolved theme color from the color list.

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

Returns the resolved font defined from the font list.

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

Returns the resolved image defined from the image list.

Returns the size of the inset border and padding.

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

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

Returns true if the color is a theme color.

Returns true if the font is a theme font.

Implements

LoadConfigurationEventArgs

Wisej.Core.LoadConfigurationEventArgs

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Specifies the event arguments for the event.

Properties

FilePath

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

SuppressCache

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

Used By

Name

Description

LoadConfigurationEventHandler

Wisej.Core.LoadConfigurationEventHandler

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents a method that handles the event.

Parameters

Name

Type

Description

Fired By

Name

Description

Application.FormCollection

Wisej.Web.Application FormCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Holds the collection of all top-level application forms.

Properties

Count

: Returns the total number of currently open forms.

Item(index)

: Returns the form at the specified index.

Item(name)

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

Methods

GetEnumerator()

Returns an enumerator that iterates through the open forms.

Buttons

Common Dialogs

Containers

Application

Wisej.Web.Application

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public class Application : IWisejComponent, IDisposable, IWisejSynchronized, IServiceProvider

Public Class Application
    Inherits IWisejComponent
    Implements IDisposable, IWisejSynchronized, IServiceProvider

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

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

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

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

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

Properties

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.

String: Returns the current unique client id.

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

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 the Update method.

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

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

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

Parameter

Type

Description

filter

EXPERIMENTAL: Adds a scoped service to the service container.

Parameter

Type

Description

serviceType

Type of the service to add.

serviceInstance

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

scope

Scope of the serviceInstance .

Throws:

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

EXPERIMENTAL: Adds a scoped service to the service container.

Parameter

Type

Description

serviceType

Type of the service to add.

callback

A callback object that can create the service. This allows a service to be declared as available, but delays creation of the object until the service is requested.

scope

Scope of the service.

Throws:

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

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

Parameter

Type

Description

text

The text to translate.

translation

The translation override.

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

Parameter

Type

Description

message

A string you want to display in the alert dialog.

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

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

Parameter

Type

Description

function

The name of the function to execute.

callback

Asynchronous callback method that receives the return value.

args

The arguments to pass to the function.

Executes the JavaScript function on the client.

Parameter

Type

Description

function

The name of the function to execute.

args

The arguments to pass to the function.

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

Parameter

Type

Description

function

The name of the function to execute.

args

The arguments to pass to the function.

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

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.

Parameter

Type

Description

message

A string you want to display in the confirm dialog.

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

Downloads the specified file on the client.

Parameter

Type

Description

filePath

The file to download.

fileName

The name of the file to save on the client.

ondownload

Optional callback invoked when fileName is downloaded.

Downloads the specified image to the client.

Parameter

Type

Description

image

The image to download.

fileName

The name of the file to save on the client.

ondownload

Optional callback invoked when fileName is downloaded.

Downloads the bytes in the stream to the client.

Parameter

Type

Description

stream

The stream to send to the client.

fileName

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

ondownload

Optional callback invoked when fileName is downloaded.

Downloads the specified file on the client.

Parameter

Type

Description

target

Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.

filePath

The file to download.

fileName

The name of the file to save on the client.

ondownload

Optional callback invoked when fileName is downloaded.

Downloads the specified image to the client.

Parameter

Type

Description

target

Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.

image

The image to download.

fileName

The name of the file to save on the client.

ondownload

Optional callback invoked when fileName is downloaded.

Downloads the bytes in the stream to the client.

Parameter

Type

Description

target

Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.

stream

The stream to send to the client.

fileName

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

ondownload

Optional callback invoked when fileName is downloaded.

Stops the polling requests from the client.

Executes the JavaScript script on the client.

Parameter

Type

Description

script

The script to evaluate.

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

Parameter

Type

Description

script

The script to evaluate.

callback

Asynchronous callback method that receives the return value.

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

Parameter

Type

Description

script

The script to evaluate.

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

Terminates the application and the corresponding session.

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

Parameter

Type

Description

match

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.

Parameter

Type

Description

match

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

EXPERIMENTAL: Returns the requested service.

Parameter

Type

Description

Type of the service to retrieve.

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

EXPERIMENTAL: Returns the requested service.

Parameter

Type

Description

serviceType

Type of the service to add.

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

Throws:

ArgumentNullException serviceType is null.

Loads an assembly given the file name or path.

Parameter

Type

Description

nameOrFile

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

Returns: Assembly. The loaded Assembly.

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

Creates an instance of the specified component from the assembly.

Parameter

Type

Description

nameOrFile

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

className

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

Parameter

Type

Description

packages

callback

Parameter

Type

Description

packages

Returns: Task<Boolean>.

Changes the current theme.

Parameter

Type

Description

name

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

mixins

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

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

Parameter

Type

Description

path

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

Navigate to the specified URL.

Parameter

Type

Description

url

URL to navigate to.

target

The target browser window: _self, _blank, etc.

Plays one of the built-in sounds

Parameter

Type

Description

type

Plays a sound.

Parameter

Type

Description

soundUrl

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

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

Parameter

Type

Description

callback

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

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


void Test() {

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

Prints the specified control.

Parameter

Type

Description

control

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

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

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.

Parameter

Type

Description

message

A string of text to display to the user.

defaultValue

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

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

Causes the application to reload on the browser.

Removes the filter from the list of registered event filters.

Parameter

Type

Description

filter

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

Parameter

Type

Description

serviceType

Type of the service to remove.

Throws:

ArgumentNullException serviceType is null.

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

Parameter

Type

Description

context

action

Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.

Sets the current session timeout in seconds.

Parameter

Type

Description

seconds

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

Parameter

Type

Description

interval

Polling interval in milliseconds. The minimum is 1000ms.

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


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

Application.StartTask(() => {

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

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

});

Throws:

ArgumentOutOfRangeException The interval specified is less than 1.

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

Parameter

Type

Description

action

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

Returns: Task. An awaitable Task.

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

Application.StartTask(() => {

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

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

Parameter

Type

Description

action

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

Returns: Task<T>.

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

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

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

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

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

Starts a Timer bound to the current session context.

Parameter

Type

Description

dueTime

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

period

The time interval between invocations, in milliseconds.

callback

A callback method to invoke at the specified intervals.

Returns: Timer. An instance of Timer.

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

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

Parameter

Type

Description

context

action

Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.

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

Application.StartTask(() => {

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

});

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

Application.StartTask(() => {

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

});

Events

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.

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

Set Handled to true if your application takes care of impersonation. The default implementation in Wisej is supported only in .NET Framework and the Windows platform.

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

Set Handled to true if your application takes care of impersonation. The default implementation in Wisej is supported only in .NET Framework and the Windows platform.

LicenseErrorEventHandler Fired when a license error occurs.

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

Name

Description

All wisej components implement this interface.

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

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

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

value

Initial hash value.

Properties

Hash

String: The hash string from the client.

Used By

Name

Description

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

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

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

Application.PageCollection

Wisej.Web.Application PageCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Holds the collection of all top-level application pages.

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.

PlatformProvider

Wisej.Core.PlatformProvider

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Platforms supported by Wisej.

public enum PlatformProvider : Enum

Public Enum PlatformProvider As [Enum]

Fields

Name

Description

QXDesktop

Desktop platform by qooxdoo.

Used By

Name

Description

The platform provider.

Configuration

Wisej.Core.Configuration

Namespace: Wisej.Core

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

json

The json string that defines the configuration values.

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.

Boolean: Returns whether this Wisej application is running in a standalone host (Wisej.Application.exe).

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.

Parameter

Type

Description

filePath

The full path to the .json file to load.

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. This is a static event and should be attached to before the application starts. One way to do that is to register an HttpModul with IIS, or a middleware for .NET Core, and attach to the event there.

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

LicenseErrorEventHandler

Wisej.Web.LicenseErrorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the LicenseError event.

public delegate void LicenseErrorEventHandler(Object sender, HashChangedEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Fired when a license error occurs.

LicenseErrorEventArgs

Wisej.Web.LicenseErrorEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the LicenseError event.

public class LicenseErrorEventArgs : EventArgs

Public Class LicenseErrorEventArgs
    Inherits EventArgs

Constructors

LicenseErrorEventArgs(error)

Initializes a new instance of the LicenseErrorEventArgs class.

Name

Type

Description

error

License error.

Properties

Error

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

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void ResponsiveProfileChangedEventHandler(Object sender, ResponsiveProfileChangedEventArgs e)

Public Delegate Sub ResponsiveProfileChangedEventHandler(ByVal sender As [Object], ByVal e As ResponsiveProfileChangedEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Fired when the active responsive profile is changed.

Component

Wisej.Web.Component

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Component
- Component

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

public class Component : Component, IComponent

Public Class Component
    Inherits Component
    Implements IComponent

Constructors

Component()

Default constructor

Methods

Update()

Updates the component on the client.

Inherited By

Name

Description

Implements a timer that raises an event at user-defined intervals.

Provides support for animating controls or windows using predefined animations definitions or custom animations in response to certain events.

Provides a user interface for indicating that a control on a form has an error associated with it.

Represents a small rectangular pop-up window that displays a brief help text next to a control when it gets activated (focused).

Allows controls to execute javascript code.

Adds CSS styling to controls.

Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.

Represents the base functionality for all menus.

Implements

Name

Description

All wisej components implement this interface.

Allows an object to serialize itself.

Clipboard

Wisej.Web.Clipboard

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public class Clipboard

Public Class Clipboard

Methods

Clear()

Removes all data from the Clipboard.

ContainsAudio()

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

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

format

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

ContainsFileDropList()

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

Returns: Boolean. true if there is a file drop list on the Clipboard; otherwise, false.

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

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

Indicates whether there is data on the Clipboard in the Text or UnicodeText format, depending on the operating system.

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

Indicates whether there is text data on the Clipboard in the format indicated by the specified TextDataFormat value.

Parameter

Type

Description

format

Returns: Boolean. true if there is text data on the Clipboard in the value specified for format ; otherwise, false.

Retrieves an audio stream from the Clipboard.

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

Retrieves data from the Clipboard in the specified format.

Parameter

Type

Description

format

Returns: Object. An Object representing the Clipboard data or null if the Clipboard does not contain any data that is in the specified format or can be converted to that format.

Retrieves the data that is currently on the system Clipboard.

Returns: IDataObject. An IDataObject that represents the data currently on the Clipboard, or null if there is no data on the Clipboard.

Retrieves a collection of file names from the Clipboard.

Returns: StringCollection. A StringCollection containing file names or null if the Clipboard does not contain any data that is in the FileDrop format or can be converted to that format.

Retrieves an image from the Clipboard.

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

Retrieves text data from the Clipboard in the Text or UnicodeText format, depending on the operating system.

Returns: String. The Clipboard text data or Empty if the Clipboard does not contain data in the Text or UnicodeText format, depending on the operating system.

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

Parameter

Type

Description

format

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

Saves the Byte array in the WaveAudio format after converting it to a Stream to the clipboard.

Parameter

Type

Description

audioBytes

Throws:

ArgumentNullException audioBytes is null.

Saves the Stream in the WaveAudio format to the clipboard.

Parameter

Type

Description

audioStream

Throws:

ArgumentNullException audioStream is null.

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

Parameter

Type

Description

text

The text to save to the client's temporary clipboard.

Throws:

ArgumentNullException text is null.

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

Parameter

Type

Description

format

data

Throws:

ArgumentNullException data is null.

Saves the specified data to the clipboard.

Parameter

Type

Description

data

The data to place on the Clipboard.

Throws:

ArgumentNullException The value of data is null.

Saves the collection of file names in the FileDrop format to the clipboard.

Parameter

Type

Description

filePaths

Throws:

ArgumentNullException filePaths is null.
ArgumentException filePaths does not contain any strings, or at least one of the strings in filePaths is empty, contains only white space, contains one or more invalid characters as defined by InvalidPathChars, is null, contains a colon (:), or exceeds the system-defined maximum length. See the InnerException property of the ArgumentException for more information.

Saves the Image in the Bitmap format to the clipboard

Parameter

Type

Description

image

Throws:

ArgumentNullException image is null.

Saves the text data in the UnicodeText format to the clipboard.

Parameter

Type

Description

text

The text to add to the Clipboard.

Throws:

ArgumentNullException text is null or Empty.

Saves the text data in the format indicated by the specified TextDataFormat value to the clipboard.

Parameter

Type

Description

text

The text to add to the Clipboard.

format

Throws:

ArgumentNullException text is null.

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the ResponsiveProfileChanged event.

public class ResponsiveProfileChangedEventArgs : EventArgs

Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs

Constructors

ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the ResponsiveProfileChangedEventArgs class.

Name

Type

Description

oldValue

newValue

Properties

CurrentProfile

ClientProfile: The new active profile.

PreviousProfile

ClientProfile: The previously active profile.

Used By

Name

Description

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

Control

Wisej.Web.Control

Namespace: Wisej.Web

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

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.

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

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.

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.

Executes the specified delegate, on the thread that owns the control's underlying window handle, 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 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

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

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

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

KeyEventHandler

Wisej.Web.KeyEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void KeyEventHandler(Object sender, KeyEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

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

LayoutEventArgs

Wisej.Web.LayoutEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the Layout event.

public class LayoutEventArgs : EventArgs

Public Class LayoutEventArgs
    Inherits EventArgs

Constructors

LayoutEventArgs(affectedComponent, affectedProperty)

Initializes a new instance of the LayoutEventArgs class with the specified component and property affected.

Name

Type

Description

affectedComponent

affectedProperty

The property affected by the layout change.

LayoutEventArgs(affectedControl, affectedProperty)

Initializes a new instance of the LayoutEventArgs class with the specified control and property affected.

Name

Type

Description

affectedControl

affectedProperty

The property affected by the layout change.

Properties

AffectedComponent

IComponent: Returns the IComponent affected by the layout change.

Control: Returns the child control affected by the change.

String: Returns the property affected by the change.

Used By

Name

Description

KeyPressEventArgs

Wisej.Web.KeyPressEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the KeyPress event.

public class KeyPressEventArgs : EventArgs

Public Class KeyPressEventArgs
    Inherits EventArgs

Constructors

KeyPressEventArgs(keyChar)

Initializes a new instance of the KeyPressEventArgs class.

Name

Type

Description

keyChar

The ASCII character corresponding to the key the user pressed.

Properties

Handled

Boolean: Returns or sets whether the KeyPress event was handled.

KeyChar

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

Used By

Name

Description

LayoutEventHandler

Wisej.Web.LayoutEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void LayoutEventHandler(Object sender, LayoutEventArgs e)

Public Delegate Sub LayoutEventHandler(ByVal sender As [Object], ByVal e As LayoutEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Fired when a control should reposition its child controls.

KeyPressEventHandler

Wisej.Web.KeyPressEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void KeyPressEventHandler(Object sender, KeyPressEventArgs e)

Public Delegate Sub KeyPressEventHandler(ByVal sender As [Object], ByVal e As KeyPressEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

PaintEventHandler

Wisej.Web.PaintEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void PaintEventHandler(Object sender, PaintEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Fired when a UserPaint control needs to redraw itself.

PaintEventArgs

Wisej.Web.PaintEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the Paint event.

public class PaintEventArgs : EventArgs

Public Class PaintEventArgs
    Inherits EventArgs

Constructors

PaintEventArgs(graphics, clipRect)

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

Name

Type

Description

graphics

clipRect

Properties

ClipRectangle

Rectangle: Returns the rectangle in which to paint.

Graphics

Graphics: Returns the graphics used to paint.

Used By

Name

Description

KeyEventArgs

Wisej.Web.KeyEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the KeyDown or KeyUp event.

public class KeyEventArgs : EventArgs

Public Class KeyEventArgs
    Inherits EventArgs

Constructors

KeyEventArgs(keyData)

Initializes a new instance of the KeyEventArgs class.

Name

Type

Description

keyData

Properties

Alt

Boolean: Returns whether the ALT key was pressed.

Control

Boolean: Returns whether the CTRL key was pressed.

Handled

Boolean: Returns or sets whether the event was handled.

Keys: Returns the keyboard code..

Keys: Returns the key data.

Int32: Returns the keyboard value.

Keys: Returns the modifier flags indicating which combination of CTRL, SHIFT, and ALT keys was pressed.

Boolean: Returns a value indicating whether the SHIFT key was pressed.

Methods

Returns whether the Alt key is pressed.

Returns: Boolean.

Returns whether the Control key is pressed.

Returns: Boolean.

Returns whether the Shift key is pressed.

Returns: Boolean.

Used By

Name

Description

MouseEventArgs

Wisej.Web.MouseEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the MouseUp, MouseDown, and MouseMove events.

public class MouseEventArgs : EventArgs

Public Class MouseEventArgs
    Inherits EventArgs

Constructors

MouseEventArgs(button, clicks, x, y, delta)

Initializes a new instance of the MouseEventArgs class.

Name

Type

Description

button

clicks

The number of times a mouse button was pressed.

The x-coordinate of a pointer click, in pixels.

The y-coordinate of a pointer click, in pixels.

delta

A signed count of the number of dents the wheel has rotated.

MouseEventArgs(button, clicks, x, y, delta, role)

Initializes a new instance of the MouseEventArgs class.

Name

Type

Description

button

clicks

The number of times a mouse button was pressed.

The x-coordinate of a pointer click, in pixels.

The y-coordinate of a pointer click, in pixels.

delta

A signed count of the number of dents the wheel has rotated.

role

The internal role assigned to the element that generated the pointer event.

Properties

MouseButtons: Returns which mouse button was pressed.

Int32: Returns the number of clicks or taps.

Int32: Returns the number of times the mouse wheel has rotated.

Point: Returns the location of the mouse or pointer event.

Control: Returns the original target Control when the pointer event has bubbled up because the original target was either not Enabled or Anonymous.

String: Returns the internal role assigned to the element that generated the pointer event: checkbox, button, ...

The value in the Role property is taken from the "role" attribute of the clicked element inside the widget. You can detect clicks on custom HTML content by adding the role attribute to the custom element.

Int32: Returns the x-coordinate of the mouse or touch event.

Int32: Returns the y-coordinate of the mouse or touch event.

Used By

Name

Description

Represents the method that will handle the MouseDown, MouseUp, or MouseMove event of a form, control, or other component.

JavaScript.ClientEventCollection

Wisej.Web.JavaScript ClientEventCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents a collection of JavaScript events and their corresponding handler code.

public class ClientEventCollection : IList, ICollection, IEnumerable, IList<ClientEvent>, ICollection<ClientEvent>, IEnumerable<ClientEvent>

Public Class ClientEventCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of ClientEvent), ICollection(Of ClientEvent), IEnumerable(Of ClientEvent)

Constructors

ClientEventCollection()

Properties

Count

Int32: Returns the number of items in the collection.

Item(index)

ClientEvent: Returns the ClientEvent element at the specified index .

Methods

Adds the ClientEvent instance to the collection.

Parameter

Type

Description

item

Removes all the ClientEvent items from the collection.

Checks whether the specified item exists in the collection.

Parameter

Type

Description

item

Returns: Boolean. True of the collection contains the specified item .

Returns the position of the specified item in the collection.

Parameter

Type

Description

item

Returns: Int32. The index of the specified item or -1 if not found.

Inserts the item into the collection at the specified index .

Parameter

Type

Description

index

Position where to insert the item .

item

Removes the item from the collection.

Parameter

Type

Description

item

Returns: Boolean. True of the specified item was found and removed from the collection.

Removes the ClientEvent item at the location index .

Parameter

Type

Description

index

Position of the item to remove from the collection.

Events

CollectionChangeEventHandler Fired when the collection has changed.

MouseEventHandler

Wisej.Web.MouseEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the MouseDown, MouseUp, or MouseMove event of a form, control, or other component.

public delegate void MouseEventHandler(Object sender, MouseEventArgs e)

Public Delegate Sub MouseEventHandler(ByVal sender As [Object], ByVal e As MouseEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Fired when the user clicks the control with the mouse.

Fired when the control is clicked by the mouse.

Fired when the control is double clicked by the mouse.

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

Fired when the mouse pointer is moved over the control.

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

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

PinchEventHandler

Wisej.Web.PinchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Pinch event.

public delegate void PinchEventHandler(Object sender, PinchEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

PreviewKeyDownEventHandler

Wisej.Web.PreviewKeyDownEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the PreviewKeyDown event.

public delegate void PreviewKeyDownEventHandler(Object sender, PreviewKeyDownEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

QueryContinueDragEventHandler

Wisej.Web.QueryContinueDragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void QueryContinueDragEventHandler(Object sender, QueryContinueDragEventArgs e)

Public Delegate Sub QueryContinueDragEventHandler(ByVal sender As [Object], ByVal e As QueryContinueDragEventArgs)

Parameters

Name

Type

Description

sender

The source of an event.

A that contains the event data.

Fired By

Name

Description

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

QueryContinueDragEventArgs

Wisej.Web.QueryContinueDragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the QueryContinueDrag event.

public class QueryContinueDragEventArgs : EventArgs

Public Class QueryContinueDragEventArgs
    Inherits EventArgs

Constructors

QueryContinueDragEventArgs(args)

Initializes a new instance of the QueryContinueDragEventArgs class.

Name

Type

Description

args

The arguments received from the client.

Properties

Action

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

EscapePressed

Boolean: Returns if the user pressed the ESC key.

KeyState

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

Used By

Name

Description

PreviewKeyDownEventArgs

Wisej.Web.PreviewKeyDownEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the PreviewKeyDown event.

public class PreviewKeyDownEventArgs : EventArgs

Public Class PreviewKeyDownEventArgs
    Inherits EventArgs

Constructors

PreviewKeyDownEventArgs(keyData)

Initializes a new instance of the PreviewKeyDownEventArgs class with the specified key.

Name

Type

Description

keyData

Properties

Alt

Boolean: Returns whether the ALT key was pressed.

Control

Boolean: Returns whether the CTRL key was pressed.

IsInputKey

Boolean: Returns whether a key is a regular input key.

Keys: Returns the keyboard code.

Keys: Returns the key data.

Int32: Returns the keyboard value.

Keys: Returns the modifier flags indicating which combination of CTRL, SHIFT, and ALT keys was pressed.

Boolean: Returns whether the SHIFT key was pressed.

Used By

Name

Description

PinchEventArgs

Wisej.Web.PinchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for Pinch event.

public class PinchEventArgs : EventArgs

Public Class PinchEventArgs
    Inherits EventArgs

Properties

Scale

Double: Returns the calculated scale factor.

Used By

Name

Description

Represents the method that will handle the event.

TrackEventArgs

Wisej.Web.TrackEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for Track event.

public class TrackEventArgs : EventArgs

Public Class TrackEventArgs
    Inherits EventArgs

Properties

Axis

SwipeAxis: Returns the Axis of the track event.

Location

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

X

Int32: Returns the X delta of the track event.

Y

Int32: Returns Y delta of the track event.

Used By

Name

Description

WidgetEventArgs

Wisej.Web.WidgetEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the WidgetEvent event.

public class WidgetEventArgs : EventArgs

Public Class WidgetEventArgs
    Inherits EventArgs

Constructors

WidgetEventArgs(type, data)

Initializes a new instance of the WidgetEventArgs class.

Name

Type

Description

type

The type (name) of event.

data

The data object received with the event.

Properties

Data

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

Type

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

Used By

Name

Description

ServiceScope

Wisej.Web.ServiceScope

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

EXPERIMENTAL: Specifies the scope of services added using AddService.

public enum ServiceScope : Enum

Public Enum ServiceScope As [Enum]

Fields

Name

Description

Global

A single static instance of the service is available to all sessions.

Session

The registered instance is available only to the current sessions. A new session should create and register a new instance.

Transient

A new instance of the service is created every time it's needed and automatically disposed at the end of the request.

Used By

Name

Description

EXPERIMENTAL: Adds a scoped service to the service container.

Padding

Wisej.Web.Padding

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents padding or margin information associated with a user interface (UI) element.

public struct Padding : ValueType, IWisejSerializable

Public Structure Padding
    Implements ValueType, IWisejSerializable

Constructors

Padding(left, top, right, bottom)

Initializes a new instance of the Padding class using a separate padding size for each edge.

Name

Type

Description

left

The padding size, in pixels, for the left edge.

top

The padding size, in pixels, for the top edge.

right

The padding size, in pixels, for the right edge.

bottom

The padding size, in pixels, for the bottom edge.

Padding(all)

Initializes a new instance of the Padding class using the supplied padding size for all edges.

Name

Type

Description

all

The number of pixels to be used for padding for all edges.

Properties

Int32: Returns or sets the padding value for all the edges.

Int32: Returns or sets the padding value for the bottom edge.

Int32: Returns the combined padding for the right and left edges.

Boolean: Returns if the padding is empty.

Int32: Returns or sets the padding value for the left edge.

Int32: Returns or sets the padding value for the right edge.

Size: Returns the padding information in the form of a Size.

Int32: Returns or sets the padding value for the top edge.

Int32: Returns the combined padding for the top and bottom edges.

Methods

Computes the sum of the two specified Padding values.

Parameter

Type

Description

Returns: Padding. A Padding that contains the sum of the two specified Padding values.

Subtracts one specified Padding value from another.

Parameter

Type

Description

Returns: Padding. A Padding that contains the result of the subtraction of one specified Padding value from another.

Used By

Name

Description

Returns or sets padding within the control.

Returns or sets the space between controls.

Returns or sets the additional padding around the label. This property can be defined in the theme.

Returns or sets the offset in pixels from the calculated position of the popup.

Returns or sets padding within the statusbar panel.

Returns or sets padding within the toolbar button.

Returns or sets the space between toolbar buttons.

Returns the size of the inset border and padding.

DataObject

Wisej.Web.DataObject

Namespace: Wisej.Web

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

data

The data to store.

DataObject(format, data)

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

Name

Type

Description

format

data

The data to store.

DataObject(format, data)

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

Name

Type

Description

format

data

The data to store.

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.

Parameter

Type

Description

format

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.

Parameter

Type

Description

format

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

Returns the data associated with the specified data format.

Parameter

Type

Description

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.

Parameter

Type

Description

format

autoConvert

true to the convert data to the specified format; otherwise, false.

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.

Parameter

Type

Description

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.

Parameter

Type

Description

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.

Parameter

Type

Description

format

autoConvert

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.

Parameter

Type

Description

autoConvert

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.

Parameter

Type

Description

format

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.

Parameter

Type

Description

audioBytes

Throws:

ArgumentNullException audioBytes is null.

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

Parameter

Type

Description

audioStream

Throws:

ArgumentNullException audioStream is null.

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

Parameter

Type

Description

data

The data to store.

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

Parameter

Type

Description

format

data

The data to store.

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

Parameter

Type

Description

format

data

The data to store.

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

Parameter

Type

Description

format

autoConvert

true to allow the data to be converted to another format; otherwise, false.

data

The data to store.

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

Parameter

Type

Description

url

The url to the file to download.

fileName

The name of the file to download from the url.

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

Parameter

Type

Description

filePaths

Throws:

ArgumentNullException filePaths is null.

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

Parameter

Type

Description

filePaths

Throws:

ArgumentNullException filePaths is null.

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

Parameter

Type

Description

image

Throws:

ArgumentNullException image is null.

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

Parameter

Type

Description

textData

The text to add to the data object.

Throws:

ArgumentNullException textData is null or Empty.

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

Parameter

Type

Description

textData

The text to add to the data object.

format

Throws:

ArgumentNullException textData is null or Empty.

Implements

Name

Description

Provides a format-independent mechanism for transferring data.

Cursors

Wisej.Web.Cursors

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Defines a collection of predefined Cursor objects.

public class Cursors

Public Class Cursors

Properties

Alias

Cursor: Returns the "shortcut" cursor.

Arrow

Cursor: Returns the "arrow" cursor.

Cell

Cursor: Returns "cell" cursor.

Copy

Cursor: Returns the clipboard "copy" cursor.

Cross

Cursor: Returns the "crosshair" cursor.

Cursor: Returns the "default" cursor, which is usually an arrow cursor.

Cursor: Returns the "grab" cursor.

Cursor: Returns the "hand" cursor, typically used when hovering over a Web link.

Cursor: Returns the "help" cursor, which is a combination of an arrow and a question mark.

Cursor: Returns the "row-resize" cursor that appears when the mouse is positioned over a horizontal splitter bar.

Cursor: Returns the "text" cursor, which is used to show where the text cursor appears when the mouse is clicked.

Cursor: Returns the "move" cursor, typically an cross shape.

Cursor: Returns the "not-allowed" cursor that indicates that a particular region is invalid for the current operation.

Cursor: Returns the "none" cursor.

Cursor: Returns the "not-allowed" cursor.

Cursor: Returns the "move" sizing cursor, which consists of four joined arrows that point north, south, east, and west.

Cursor: Returns the "ne-resize" diagonal (north/east) sizing cursor.

Cursor: Returns the "nesw-resize" diagonal (northeast/southwest) sizing cursor.

Cursor: Returns the "n-resize" vertical (north/south) sizing cursor.

Cursor: Returns the "nw-resize" diagonal (north/west) sizing cursor.

Cursor: Returns the "nwse-resize" diagonal (northwest/southeast) sizing cursor.

Cursor: Returns the "se-resize" diagonal (south/east) sizing cursor.

Cursor: Returns the "sw-resize" diagonal (south/west) sizing cursor.

Cursor: Returns the "w-resize" horizontal (west/east) sizing cursor.

Cursor: Returns the "text" cursor.

Cursor: Returns the "col-resize" cursor that appears when the mouse is positioned over a vertical splitter bar.

Cursor: Returns the "wait" cursor, typically an hourglass shape.

Cursor: Returns the "zoom-in" cursor.

Cursor: Returns the "zoom-out" cursor.

Screen

Wisej.Web.Screen

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the display on the client device.

public class Screen

Public Class Screen

Properties

Bounds

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

DeviceName

String: Returns the device name associated with a display.

WorkingArea

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

Cursor

Wisej.Web.Cursor

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the mouse pointer.

public class Cursor

Public Class Cursor

Constructors

Cursor(image)

Creates a new cursor using the Image.

Name

Type

Description

image

Cursor(source)

Creates a new cursor using an image source: can use a themed image or URL.

Name

Type

Description

source

The name of a theme image or a URL to an image resource.

Cursor(stream)

Creates a new cursor using the Image.

Name

Type

Description

stream

Cursor(image, x, y)

Creates a new cursor using the Image.

Name

Type

Description

image

x-coordinate of the hotspot location.

y-coordinate of the hotspot location.

Creates a new cursor using the Image.

Name

Type

Description

stream

x-coordinate of the hotspot location.

y-coordinate of the hotspot location.

Creates a new cursor using an image source: can use a themed image or URL.

Name

Type

Description

source

The name of a theme image or a URL to an image resource.

x-coordinate of the hotspot location.

y-coordinate of the hotspot location.

Properties

String: Returns the name of the cursor.

Point: Returns or sets the pointer's position.

WidgetEventHandler

Wisej.Web.WidgetEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that handles the WidgetEvent event.

public delegate void WidgetEventHandler(Object sender, WidgetEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

TrackEventHandler

Wisej.Web.TrackEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Track event.

public delegate void TrackEventHandler(Object sender, TrackEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

RadioButton

Wisej.Web.RadioButton

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Control
- ButtonBase
  - RadioButton

Enables the user to select a single option from a group of choices when paired with other RadioButton controls.

public class RadioButton : ButtonBase, IReadOnly

Public Class RadioButton
    Inherits ButtonBase
    Implements IReadOnly

Constructors

RadioButton()

Initializes a new instance of the RadioButton class.

Properties

Appearance

Appearance: Returns or sets the value that determines the appearance of a CheckBox control.

AutoCheck

Boolean: Returns or set a value indicating whether the Checked or CheckState values and the CheckBox's appearance are automatically changed when the CheckBox is clicked.

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.

ContentAlignment: Returns or sets the horizontal and vertical alignment of the check mark on a CheckBox control.

Boolean: Gets or sets whether the control is checked.

Color: Returns or sets the text color used when the RadioButton is checked.

Boolean: Returns or sets a value that indicates that the control is invalid.

String: Returns or sets the invalid message that is shown in the invalid tooltip.

Boolean: Returns or sets whether the control is read-only.

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.

ContentAlignment: Returns or sets the alignment of the text on the CheckBox control.

Methods

Generates a Click event for a RadioButton.

Events

EventHandler Fired when the value of the Appearance property changes.

EventHandler Fired when the value of the Checked property changes.

EventHandler Fired when the value of the ReadOnly property has changed.

Implements

Name

Description

Bindable components implement this interface.

Provides access to common image properties across the controls that implement this interface.

All wisej components implement this interface.

Allows an object to serialize itself.

Button

Wisej.Web.Button

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Control
- ButtonBase
  - Button

Represents a button control.

public class Button : ButtonBase, IButtonControl, ICommandSource

Public Class Button
    Inherits ButtonBase
    Implements IButtonControl, ICommandSource

Constructors

Button()

Initializes a new instance of the Button class.

Properties

AutoSizeMode

AutoSizeMode: Returns or sets the mode by which the Button automatically resizes itself.

BorderStyle

BorderStyle: Returns or sets the border style of the button control.

ICommand: EXPERIMENTAL. Returns or sets the ICommand implementation to invoke.

DialogResult: Returns or sets a value that is returned to the parent form when the button is clicked.

Display: Returns or sets the Display mode of the control to determine whether to display the icon, the text or both.

Nullable<Int32>: Returns or sets the distance in pixels between the image and the label inside the button.

MenuItemCollection: Returns the collection of MenuItem objects associated with the button.

Boolean: Enables or disables the auto-repeat feature. When enabled, the button keeps firing click events at an increasing rate while the user keeps the button pressed.

Shortcut: Returns or sets a value indicating the shortcut key associated with the button.

Methods

Generates a Click event for a button.

Events

EventHandler Fired when the Command property value changes.

MenuButtonItemClickedEventHandler Fired when the user clicks one of the drop down menu items.

Inherited By

Name

Description

Represents a split button control.

Implements

Name

Description

Bindable components implement this interface.

Provides access to common image properties across the controls that implement this interface.

All wisej components implement this interface.

Allows an object to serialize itself.

ButtonBase

Wisej.Web.ButtonBase

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Control
- ButtonBase

Implements the basic functionality common to button controls.

public class ButtonBase : Control, IImage

Public Class ButtonBase
    Inherits Control
    Implements IImage

Constructors

ButtonBase()

Initializes a new instance of the ButtonBase class.

Properties

AllowHtml

Boolean: Returns or sets a value indicating that the control can display HTML in the Text property.

Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.

AutoEllipsis

Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the button, denoting that the text extends beyond the size of the button.

Boolean: Returns or sets whether the application blocks the browser with a modal mask when this button is clicked and until the server is done processing the execution request.

AutoShowLoader blocks the entire browser as soon as the button is clicked since it's implemented on the client side, while ShowLoader blocks the specific widget when returning from the request.

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.

CharacterCasing: Returns or sets the case of the text to display to the user.

Image: Returns or sets the image that is displayed in a button control.

ContentAlignment: Returns or sets the alignment of the image in the button control.

Int32: Returns or sets the image list index value of the image in the ImageList displayed in the button control.

Throws:

ArgumentOutOfRangeException The specified index is less than -1.

String: Returns or sets the key accessor for the image in the ImageList displayed in the button control.

ImageList: Returns or sets the ImageList that contains the Image displayed in a button control.

String: Returns or sets the theme name or URL for the image to display in the button control.

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

Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.

ContentAlignment: Returns or sets the alignment of the text in the button control.

TextImageRelation: Returns or sets the position of text and image relative to each other.

Boolean: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control.

Methods

Generates a Click event for a button.

Inherited By

Name

Description

Represents a button control.

Represents a check box control.

Represents a split button control.

Implements

Name

Description

Bindable components implement this interface.

Provides access to common image properties across the controls that implement this interface.

All wisej components implement this interface.

Allows an object to serialize itself.

CheckBox

Wisej.Web.CheckBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Control
- ButtonBase
  - CheckBox

Represents a check box control.

public class CheckBox : ButtonBase, IReadOnly

Public Class CheckBox
    Inherits ButtonBase
    Implements IReadOnly

Constructors

CheckBox()

Initializes a new instance of the CheckBox class.

Properties

Appearance

Appearance: Returns or sets the value that determines the appearance of a CheckBox control.

AutoCheck

Boolean: Returns or set a value indicating whether the Checked or CheckState values and the CheckBox's appearance are automatically changed when the CheckBox is clicked.

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.

ContentAlignment: Returns or sets the horizontal and vertical alignment of the check mark on a CheckBox control.

Boolean: Returns or set a value indicating whether the CheckBox is in the checked state.

Color: Returns or sets the text color used when the CheckBox is checked.

CheckState: Returns or sets the state of the CheckBox.

Boolean: Returns or sets a value that indicates that the control is invalid.

String: Returns or sets the invalid message that is shown in the invalid tooltip.

Boolean: Returns or sets whether the control is read-only.

ContentAlignment: Returns or sets the alignment of the text on the CheckBox control.

Boolean: Returns or sets whether the CheckBox will allow three check states rather than two.

Methods

Generates a Click event for a CheckBox.

Events

EventHandler Fired when the value of the Appearance property changes.

EventHandler Fired when the value of the Checked property changes.

EventHandler Fired when the value of the CheckState property changes.

EventHandler Fired when the value of the ReadOnly property has changed.

Implements

Name

Description

Bindable components implement this interface.

Provides access to common image properties across the controls that implement this interface.

All wisej components implement this interface.

Allows an object to serialize itself.

MenuButtonItemClickedEventArgs

Wisej.Web.MenuButtonItemClickedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the ItemClicked event.

public class MenuButtonItemClickedEventArgs : EventArgs

Public Class MenuButtonItemClickedEventArgs
    Inherits EventArgs

Constructors

MenuButtonItemClickedEventArgs(item)

Initializes a new instance of the MenuButtonItemClickedEventArgs class.

Name

Type

Description

item

Properties

Item

MenuItem: Returns the clicked menu item.

Used By

Name

Description

MenuButtonItemClickedEventHandler

Wisej.Web.MenuButtonItemClickedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void MenuButtonItemClickedEventHandler(Object sender, MenuButtonItemClickedEventArgs e)

Public Delegate Sub MenuButtonItemClickedEventHandler(ByVal sender As [Object], ByVal e As MenuButtonItemClickedEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Fired when the user clicks one of the drop down menu items.

SaveFileDialog

Wisej.Web.SaveFileDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

CommonDialog
- FileDialog
  - SaveFileDialog

Prompts the user to select a location for saving a file on the server.

public class SaveFileDialog : FileDialog

Public Class SaveFileDialog
    Inherits FileDialog

You can:

Override PromptFileNotFound. It's called when the specified file doesn't exist and the property CheckFileExists is true.
Override PromptFileCreate. It's called when the specified file doesn't exist and the property CreatePrompt is true.
Override PromptFileOverwrite. It's called when the specified file doesn't exist and the property OverwritePrompt is true.
Override CreateUI to create your custom Form when the method ShowDialog is called.
Set the DialogTemplate to a Form class that has a constructor that accepts FileDialog as the single argument to change the User Interface (UI) of the file dialog.
Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.

You must add at least one IFileSystemProvider to the Roots collection before showing the dialog.

Constructors

Initializes a new instance of SaveFileDialog.

Initializes a new instance of the SaveFileDialog extender with a specified container.

Name

Type

Description

container

Properties

Boolean: Returns or sets a value indicating whether the dialog box prompts the user for permission to create a file, if the file specified file does not exist.

Boolean: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that already exists.

Methods

Opens the file with read/write permission selected by the user.

Returns: Stream. A Stream that specifies the read/write file selected by the user.

Throws:

ArgumentNullException FileName is empty or null.

Receives the file names selected by the user and validates them according to the properties set in the FileDialog instance.

Parameter

Type

Description

fileNames

Array containing the selected file paths.

Returns: Boolean. True if the files have been validated and the dialog can close; otherwise false to keep the dialog open.

Resets all dialog box options to their default values.

Accordion

Wisej.Web.Accordion

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Control
- Accordion

Displays collapsible set of AccordionPanel panels for presenting information in a limited amount of space.

public class Accordion : Control, ISupportInitialize

Public Class Accordion
    Inherits Control
    Implements ISupportInitialize

Constructors

Accordion()

Initializes a new instance of the Accordion class.

Properties

BorderStyle

BorderStyle: Returns or sets the type of border that is drawn around the Accordion panel.

Collapsible

Boolean: Returns or sets a value indicating whether the Accordion control collapses when all the AccordionPanel children are collapsed.

When this property is set to false (default) one panel is always expanded.

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

Int32: Returns or sets the size of the header. When the header is horizontal, the size if the height; when it's vertical, the size if the width. Set it to -1 to reset to the size set in the current theme.

ImageList: Returns or sets the images to display on the panel's title bar.

Int32: Returns the number of panels in the container.

PanelCollection: Returns the collection of panels in the container.

Int32: Returns or sets the index of the currently selected panel.

Throws:

ArgumentOutOfRangeException The value is less than -1.

Boolean: Returns or sets a value indicating whether the selected panel is moved to the top of the Accordion container.

AccordionPanel: Returns or sets the currently selected panel.

Boolean: Returns or sets whether a panel's ToolTip is shown when the mouse passes over the panel's title.

Methods

Makes the AccordionPanel following the AccordionPanel with the specified index the current panel.

Parameter

Type

Description

index

Throws:

ArgumentOutOfRangeException index is less than 0 or greater than the number of AccordionPanel controls in the Panels collection minus 1.

Makes the AccordionPanel following the specified AccordionPanel the current panel.

Parameter

Type

Description

panel

Throws:

ArgumentNullException panel is null.

Makes the AccordionPanel following the AccordionPanel the specified name the current panel.

Parameter

Type

Description

panelName

Throws:

ArgumentNullException panelName is null; or panelName does not match the Name property of any AccordionPanel in the Panels collection.

Returns the AccordionPanel panel at the specified location.

Parameter

Type

Description

index

Returns: Control. The AccordionPanel at the specified location.

Throws:

ArgumentOutOfRangeException index is less than 0 or greater than the number of AccordionPanel controls in the Panels collection minus 1.

Makes the AccordionPanel with the specified index the current AccordionPanel.

Parameter

Type

Description

index

Throws:

ArgumentOutOfRangeException index is less than 0 or greater than the number of AccordionPanel controls in the Panels collection minus 1.

Makes the specified AccordionPanel the current AccordionPanel.

Parameter

Type

Description

panel

Throws:

ArgumentNullException panel is null.

Makes AccordionPanel with the specified name the current AccordionPanel.

Parameter

Type

Description

panelName

Throws:

ArgumentNullException panelName is null; or panelName does not match the Name property of any AccordionPanel in the Panels collection.

Events

AccordionEventHandler Fired when a panel is deselected.

AccordionCancelEventHandler Occurs before a panel is deselected, enabling a handler to cancel the panel change.

AccordionEventHandler Fired when a panel is selected.

EventHandler Fired when the SelectedIndex property has changed.

AccordionCancelEventHandler Occurs before a panel is selected, enabling a handler to cancel the panel change.

Implements

Name

Description

Bindable components implement this interface.

All wisej components implement this interface.

Allows an object to serialize itself.

OpenFileDialog

Wisej.Web.OpenFileDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

CommonDialog
- FileDialog
  - OpenFileDialog

Prompts the user to open a file from the server.

public class OpenFileDialog : FileDialog

Public Class OpenFileDialog
    Inherits FileDialog

You can:

Override PromptFileNotFound. It's called when the specified file doesn't exist and the property CheckFileExists is true.
Override CreateUI to create your custom Form when the method ShowDialog is called.
Set the DialogTemplate to a Form class that has a constructor that accepts FileDialog as the single argument to change the User Interface (UI) of the file dialog.
Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.

You must add at least one IFileSystemProvider to the Roots collection before showing the dialog.

Constructors

OpenFileDialog()

Initializes a new instance of OpenFileDialog.

Initializes a new instance of the OpenFileDialog extender with a specified container.

Name

Type

Description

container

Properties

Boolean: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.

Boolean: Returns or sets a value indicating whether the dialog box allows multiple files to be selected.

String: Returns the file name and extension for the file selected in the dialog box. The file name does not include the path.

String[]: Returns an array of file names and extensions for all the selected files in the dialog box. The file names do not include the path.

Methods

Opens the file selected by the user, with read-only permission. The file is specified by the FileName property.

Returns: Stream. A Stream that specifies the read-only file selected by the user.

Throws:

ArgumentNullException FileName is empty or null.

Resets all properties to their default values.

Accordion.PanelCollection

Wisej.Web.Accordion PanelCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Contains a collection of AccordionPanel objects.

public class PanelCollection : IList, ICollection, IEnumerable, IList<AccordionPanel>, ICollection<AccordionPanel>, IEnumerable<AccordionPanel>

Public Class PanelCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of AccordionPanel), ICollection(Of AccordionPanel), IEnumerable(Of AccordionPanel)

Properties

Count

Int32: Returns the number of panels in the collection.

Item(index)

AccordionPanel: Returns or sets a AccordionPanel in the collection at the specified index.

Throws:

ArgumentOutOfRangeException index is less than zero or greater than the highest available index.
ArgumentNullException value is null.

Item(name)

AccordionPanel: Returns the AccordionPanel with the specified key from the collection.

Methods

Adds a AccordionPanel to the collection.

Parameter

Type

Description

panel

Throws:

ArgumentNullException The specified panel is null.

Creates a AccordionPanel with the specified text, and adds it to the collection.

Parameter

Type

Description

text

The text to display on the panel.

Creates a AccordionPanel with the specified key and text and adds it to the collection.

Parameter

Type

Description

key

text

Creates a AccordionPanel with the specified key, text, and image, and adds it to the collection.

Parameter

Type

Description

key

text

imageIndex

Creates a AccordionPanel with the specified key, text, and image, and adds it to the collection.

Parameter

Type

Description

key

text

imageKey

Adds a set of AccordionPanel panels to the collection.

Parameter

Type

Description

panels

Throws:

ArgumentNullException The value of panels is null.

Removes all the AccordionPanel panels from the collection.

Removes and disposes all AccordionPanel panels from the collection.

Parameter

Type

Description

dispose

Determines whether a specified AccordionPanel is in the collection.

Parameter

Type

Description

panel

Returns: Boolean. true if the specified AccordionPanel is in the collection; otherwise, false.

Throws:

ArgumentNullException The value of panel is null.

Determines whether the collection contains a AccordionPanel with the specified key.

Parameter

Type

Description

key

Returns: Boolean. true to indicate a AccordionPanel with the specified key was found in the collection; otherwise, false.

Copies the AccordionPanel panels in the collection to the specified array, starting at the specified index.

Parameter

Type

Description

array

index

The zero-based index in the array at which copying begins.

Throws:

ArgumentNullException array is null.
ArgumentOutOfRangeException array is less than zero.
ArgumentException array is multidimensional or the number of elements in the Panels is greater than the available space from index to the end of array .

Returns the index of the AccordionPanel in the collection.

Parameter

Type

Description

panel

Returns: Int32. The zero-based index of the panel; -1 if it cannot be found.

Throws:

ArgumentNullException The value of panel is null.

Returns the index of the first occurrence of the AccordionPanel with the specified key.

Parameter

Type

Description

key

Returns: Int32. The zero-based index of the first occurrence of a AccordionPanel with the specified key, if found; otherwise, -1.

Inserts an existing AccordionPanel into the collection at the specified index.

Parameter

Type

Description

index

panel

Creates a new AccordionPanel with the specified text and inserts it into the collection at the specified index.

Parameter

Type

Description

index

text

Creates a new AccordionPanel with the specified key and text, and inserts it into the collection at the specified index.

Parameter

Type

Description

index

key

text

Creates a new AccordionPanel with the specified key, text, and image, and inserts it into the collection at the specified index.

Parameter

Type

Description

index

key

text

imageIndex

Creates a AccordionPanel with the specified key, text, and image, and inserts it into the collection at the specified index.

Parameter

Type

Description

index

key

text

imageKey

Removes the AccordionPanel from the collection.

Parameter

Type

Description

panel

Throws:

ArgumentNullException The panel parameter is null.

Removes the AccordionPanel at the specified index from the collection.

Parameter

Type

Description

index

Removes the AccordionPanel with the specified key from the collection.

Parameter

Type

Description

key

AccordionAction

Wisej.Web.AccordionAction

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Defines values representing Accordion events.

public enum AccordionAction : Enum

Public Enum AccordionAction As [Enum]

Fields

Name

Description

Deselected

Represents the event.

Deselecting

Represents the event.

Selected

Represents the event.

Selecting

Represents the event.

Used By

Name

Description

Returns a value indicating which event is occurring.

FolderBrowserDialogUI

Wisej.Web.FolderBrowserDialogUI

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Control
- ScrollableControl
  - ContainerControl
    Form
    FolderBrowserDialogUI

UI implementation for the FolderDialog class.

public class FolderBrowserDialogUI : Form

Public Class FolderBrowserDialogUI
    Inherits Form

Constructors

FolderBrowserDialogUI()

FolderBrowserDialogUI(folderDialog)

Name

Type

Description

folderDialog

Implements

Name

Description

Bindable components implement this interface.

Provides the functionality for a control to act as a parent for other controls.

All wisej components implement this interface.

All wisej top-level windows implement this interface.

Allows an object to serialize itself.

AccordionEventHandler

Wisej.Web.AccordionEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void AccordionEventHandler(Object sender, AccordionEventArgs e)

Public Delegate Sub AccordionEventHandler(ByVal sender As [Object], ByVal e As AccordionEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Fired when a panel is selected.

Fired when a panel is deselected.

AccordionCancelEventArgs

Wisej.Web.AccordionCancelEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the Selecting and Deselecting events of a Accordion control.

public class AccordionCancelEventArgs : CancelEventArgs

Public Class AccordionCancelEventArgs
    Inherits CancelEventArgs

Constructors

AccordionCancelEventArgs(panel, panelIndex, cancel, action)

Initializes a new instance of the AccordionCancelEventArgs class.

Name

Type

Description

panel

panelIndex

cancel

true to cancel the panel change by default; otherwise, false.

action

Properties

Action

AccordionAction: Returns a value indicating which event is occurring.

Panel

AccordionPanel: Returns the AccordionPanel the event is occurring for.

Int32: Returns the zero-based index of the Panel in the Panels collection.

Used By

Name

Description

AccordionCancelEventHandler

Wisej.Web.AccordionCancelEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public delegate void AccordionCancelEventHandler(Object sender, AccordionCancelEventArgs e)

Public Delegate Sub AccordionCancelEventHandler(ByVal sender As [Object], ByVal e As AccordionCancelEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Occurs before a panel is selected, enabling a handler to cancel the panel change.

Occurs before a panel is deselected, enabling a handler to cancel the panel change.

AccordionEventArgs

Wisej.Web.AccordionEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the Selected and Deselected events of a Accordion control.

public class AccordionEventArgs : EventArgs

Public Class AccordionEventArgs
    Inherits EventArgs

Constructors

AccordionEventArgs(panel, panelIndex, action)

Initializes a new instance of the AccordionEventArgs class.

Name

Type

Description

panel

panelIndex

action

Properties

Action

AccordionAction: Returns a value indicating which event is occurring.

Panel

AccordionPanel: Returns the AccordionPanel the event is occurring for.

Int32: Returns the zero-based index of the Panel in the Panels collection.

Used By

Name

Description