1 of 100

v2.2

Welcome

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

Legend

Icon

Description

Instance method, or property, or event.

This is the API book, for the concepts documentation please refer to the link below. The concept documentation and the namespace reference are a never-ending work in progress. We update it almost daily. Please check back if what you are looking for is not available.

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

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

Wisej.Web

General

Application.FormCollection

Wisej.Web.Application FormCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Holds the collection of all top-level application forms.

: Returns the total number of currently open forms.

: Returns the form at the specified index.

Application.PageCollection

Wisej.Web.Application PageCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Holds the collection of all top-level application pages.

: Returns the total number of currently open pages.

: Returns the page at the specified index.

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Initializes a new instance of the class.

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Name

Type

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Initializes a new instance of the class.

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Name

Type

ControlEventArgs

Wisej.Web.ControlEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the and events.

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

ControlEventHandler

Wisej.Web.ControlEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the and events of the class.

Name

DragEventHandler

Wisej.Web.DragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the , , or event of a .

Name

HelpEventArgs

Wisej.Web.HelpEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Initializes a new instance of the class.

HelpEventHandler

Wisej.Web.HelpEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

Name

KeyEventHandler

Wisej.Web.KeyEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Name

KeyPressEventArgs

Wisej.Web.KeyPressEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Initializes a new instance of the class.

KeyPressEventHandler

Wisej.Web.KeyPressEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

Name

LayoutEventHandler

Wisej.Web.LayoutEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

Name

PaintEventHandler

Wisej.Web.PaintEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

Name

PinchEventArgs

Wisej.Web.PinchEventArgs

Namespace: Wisej.Web

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

PinchEventHandler

Wisej.Web.PinchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Name

Type

PreviewKeyDownEventHandler

Wisej.Web.PreviewKeyDownEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Name

Type

QueryContinueDragEventArgs

Wisej.Web.QueryContinueDragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Initializes a new instance of the class.

QueryContinueDragEventHandler

Wisej.Web.QueryContinueDragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

Name

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Initializes a new instance of the class.

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Name

Type

RotateEventHandler

Wisej.Web.RotateEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Name

Type

SwipeEventArgs

Wisej.Web.SwipeEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for event.

: Returns whether the performed swipe was on the x or y axis.

: Returns the direction of the performed swipe in reference to the axis: X = Up / Down Y = Left / Right

SwipeEventHandler

Wisej.Web.SwipeEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Name

Type

TouchEventArgs

Wisej.Web.TouchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for event.

: Returns the unique identifiers for the touch items.

: Returns whether more than one touch is associated with the event target element.

WidgetEventHandler

Wisej.Web.WidgetEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that handles a event.

Name

Type

Screen

Wisej.Web.Screen

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents a display device or multiple display devices on a single system.

public class Screen

Public Class Screen

Properties

Bounds

Rectangle: Returns the bounds of the display.

DeviceName

String: Returns the device name associated with a display.

WorkingArea

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

Buttons

MenuButtonItemClickedEventArgs

Wisej.Web.MenuButtonItemClickedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Initializes a new instance of the class.

MenuButtonItemClickedEventHandler

Wisej.Web.MenuButtonItemClickedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Name

Common Dialogs

FileDialogLoadPathEventHandler

Wisej.Web.FileDialogLoadPathEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the and events.

Name

Containers

FileDialog

Wisej.Web.FileDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

CommonDialog

Displays a dialog box from which the user can select a file.

This class is abstract. The current implementations in Wisej are and . You can override this class or and to add your own custom behavior and localization. You can:

Override . It's called when the specified file doesn't exist and the property is true.
Override to create your custom when the method is called.
Set the to a class that has a constructor that accepts

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

Initializes a new instance of .

Initializes a new instance of using the initial roots .

Name

Type

Description

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

Name

Type

Description

: Returns or sets whether the dialog box automatically adds an extension to a file name if the user omits the extension.

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

: Returns or sets the default file name extension.

: Returns or sets a string containing the file name selected in the file dialog box.

: Returns the file names of all selected files in the dialog box.

: Returns the that contains the selected .

: Returns or sets the current file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box.

: Returns or sets the index of the filter currently selected in the file dialog box.

: Returns or sets the initial directory displayed by the file dialog box.

: List of root file systems displayed by the FileDialog.

The Roots collection and the implementations allow the application to use arbitrary names mapped to a specific path. For example, the app may add a root object named "Documents" to "c:\users[logged-user-id]\files\documents". Each user will see "Documents" as the root, but will also see only the files in the [logged-user-id] directory.

: Returns or sets whether the Help button is displayed in the file dialog box.

: Returns or sets the file dialog box title.

Returns the that contains the specified path .

Parameter

Type

Description

Returns: . The that contains the specified path or null if not found.

Maps the virtual path to the corresponding physical path on the specific implementation.

Parameter

Type

Description

Returns: . The physical path for the implementation.

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

Parameter

Type

Description

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

Resets all properties to their default values.

Fired when the user clicks on the Open or Save button on a file dialog box.

Fired when the file dialog is loading a file or folder.

Name

Description

Control.ControlCollection

Wisej.Web.Control ControlCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents a collection of Control objects.

public class ControlCollection : ControlCollection,

Public Class ControlCollection
    Inherits ControlCollection
    Implements IList(Of Control), ICollection(Of Control), IEnumerable(Of Control), IWisejSynchronized

Constructors

ControlCollection(owner)

Initializes a new instance of the ControlCollection class.

Name

Type

Description

: Returns whether the owner control has already been disposed.

: Returns the at the specified indexed location.

: Returns the with the specified key in the collection.

: Returns the control that owns this .

Adds the specified control to the control collection.

Parameter

Type

Description

Adds an array of control objects to the collection.

Parameter

Type

Description

Removes all controls from the collection.

Removes and disposes all controls from the collection.

Parameter

Type

Description

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

Parameter

Type

Description

Returns: . true if the is a member of the collection; otherwise, false.

Determines whether the contains an item with the specified key.

Parameter

Type

Description

Returns: . true if the contains an item with the specified key; otherwise, false.

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

Parameter

Type

Description

Returns: . Array of controls that are derived from the specified type .

Throws:

type is null.

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

Parameter

Type

Description

Returns: . Array of controls with the specified name.

Throws:

The key parameter is null or an empty string ("").

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

Parameter

Type

Description

Returns: . A zero-based index value that represents the location of the specified child control within the control collection; otherwise -1 if the specified is not found in the .

Throws:

The child is not in the , and the throwException parameter value is true.

Retrieves a reference to an enumerator object that is used to iterate over a .

Returns: . An .

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

Parameter

Type

Description

Returns: . A zero-based index value that represents the position of the specified in the .

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

Parameter

Type

Description

Returns: . The zero-based index of the first occurrence of the control with the specified name in the collection.

Removes the specified control from the control collection.

Parameter

Type

Description

Removes the child control with the specified key.

Parameter

Type

Description

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

Parameter

Type

Description

Clipboard

Wisej.Web.Clipboard

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

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: . true if there is audio data on the Clipboard; otherwise, false.

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

Parameter

Type

Description

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

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

Returns: . 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 format or can be converted to that format.

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

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

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

Parameter

Type

Description

Returns: . 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: . A containing audio data or null if the Clipboard does not contain any data in the format.

Retrieves data from the Clipboard in the specified format.

Parameter

Type

Description

Returns: . An 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: . An 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: . A containing file names or null if the Clipboard does not contain any data that is in the format or can be converted to that format.

Retrieves an image from the Clipboard.

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

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

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

Throws:

audioBytes is null.

Saves the in the format to the clipboard.

Parameter

Type

Description

Throws:

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

Throws:

text is null.

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

Parameter

Type

Description

Throws:

data is null.

Saves the specified data to the clipboard.

Parameter

Type

Description

Throws:

The value of data is null.

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

Parameter

Type

Description

Throws:

filePaths is null.
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 , is null, contains a colon (:), or exceeds the system-defined maximum length. See the property of the for more information.

Saves the in the format to the clipboard

Parameter

Type

Description

Throws:

image is null.

Saves the text data in the format to the clipboard.

Parameter

Type

Description

Throws:

text is null or .

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

Parameter

Type

Description

Throws:

text is null.

Accordion

Wisej.Web.Accordion

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Control

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

Initializes a new instance of the class.

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

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

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

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

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

: Returns the number of panels in the container.

: Returns the collection of panels in the container.

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

Throws:

The value is less than -1.

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

: Returns or sets the currently selected panel.

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

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

Parameter

Type

Description

Throws:

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

Makes the following the specified the current panel.

Parameter

Type

Description

Throws:

panel is null.

Makes the following the the specified name the current panel.

Parameter

Type

Description

Throws:

panelName is null; or panelName does not match the property of any in the collection.

Returns the panel at the specified location.

Parameter

Type

Description

Returns: . The at the specified location.

Throws:

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

Makes the with the specified index the current .

Parameter

Type

Description

Throws:

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

Makes the specified the current .

Parameter

Type

Description

Throws:

panel is null.

Makes with the specified name the current .

Parameter

Type

Description

Throws:

panelName is null; or panelName does not match the property of any in the collection.

Fired when a panel is deselected.

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

Fired when a panel is selected.

Fired when the property has changed.

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

Name

Description

DataRepeater

Wisej.Web.DataRepeater

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Control

Displays data in a customizable list format.

Initializes a new instance of the class.

: Returns or sets whether users can add a new row to the at run time.

: Returns or sets whether users can delete a row from the at run time.

: Returns or sets the border style for the control.

: Returns the current in the control.

: Returns or sets the index of the current in a control.

: Return or sets the name of the list or table in the data source for which the is displaying data.

: Returns or sets the data source for which the is displaying data.

: Returns the list of items currently displayed on the client.

: Return the index of the first currently displayed in a control.

: Return whether the data for a in the control has been changed by a user.

: Returns or sets the border style for the items in a control.

: Returns or sets the number of items that are in the control.

: Return sets the size of the item header in a control.

: Returns or sets whether item headers are displayed in a control.

: Returns or sets the background color for the panel when it's the .

: Returns or sets the size of the child panels.

: Returns the template that represents the for the control.

: Return or sets whether the control will be displayed with a vertical or horizontal orientation.

: Returns or sets the number of items to prefetch outside of the visible area. The default is 0 (disabled).

: Enables or disables right-to-left layout when the value of is

: Returns or sets whether the scrollbar is visible. When the scrollbar is hidden, the user can still scroll using touch events, the keyboard, or the wheel.

: Returns or sets a value that indicates whether you have provided your own data-management operations for the control.

Adds a new to the control.

Throws:

The property is set to False.

Allows users to cancel an edit to the current child control in the current .

Forces a full reload of the data displayed by this .

Parameter

Type

Description

Removes a at the specified position from a control.

Parameter

Type

Description

Throws:

The value specified for index is less than 0 or greater than - 1.

Resets the value of to the original value.

Scrolls the specified into view.

Parameter

Type

Description

Throws:

The value specified for index is less than 0 or greater than - 1.

Scrolls a specified into view, optionally aligning it with the top of the control.

Parameter

Type

Description

Throws:

The value specified for index is less than 0 or greater than - 1.

Fired when the property changes.

Fired when an external data-parsing or validation operation throws an exception, or when an attempt to commit data to a data source fails.

Fired when the property changes.

Fired after the and its controls are cloned from the .

Fired before the and its controls are cloned from the .

Fired when a new is added to the control.

Fired after the becomes the current item.

Fired when a is deleted from the control.

Fired when an instance of is updated.

Fired when the property is set to true and a new value for a child control of a is needed.

Fired when the property is set to true and the value of a child control in the changes.

Fired when the property changes.

Fired when the property is set to true and the user creates a new .

Fired when the user adds a new .

Fired after the user deletes a .

Fired when the user deletes a .

Fired when the property changes.

Name

Description

Application

Wisej.Web.Application

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public class Application : IWisejComponent,

Public Class Application
    Inherits IWisejComponent
    Implements IDisposable, IWisejSynchronized

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

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

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

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

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

: Returns or sets the client browser information.

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

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

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

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

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

: Returns the current .

: Collection of cookies.

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

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

: Returns or sets the current for the session.

: Returns or sets the current Desktop.

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

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

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

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

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

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

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

: Returns true when the current session has expired.

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

: Returns true when the current session has been terminated.

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

: Returns or sets the runtime server license key.

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

: Returns or sets the current full page window.

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

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

: The name of the currently loaded platform.

: Returns the product name associated with this application.

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

: Returns the parameters used to launch the application.

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

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

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

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

: Returns the server variables.

: Provides a generic storage for session-based objects.

: Returns the total number of currently active sessions.

: Returns the unique current session ID.

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

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

: Returns the root path of the web application.

: Returns the URI used to start the application.

: Returns the URL used to start the application.

: Returns or sets the current .

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

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

: Returns or sets the page title in the browser.

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

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

: Returns the security information for the current request.

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

: Returns the IP host address of the remote client.

: Gets the DNS name of the remote client.

: Returns the type for the current user.

: Gets a sorted string array of client language preferences.

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

Parameter

Type

Description

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

Parameter

Type

Description

Executes the JavaScript function on the client.

Parameter

Type

Description

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

Parameter

Type

Description

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

Cancels the fullscreen mode.

Downloads the specified file on the client.

Parameter

Type

Description

Downloads the specified image to the client.

Parameter

Type

Description

Downloads the bytes in the stream to the client.

Parameter

Type

Description

Downloads the specified file on the client.

Parameter

Type

Description

Downloads the specified image to the client.

Parameter

Type

Description

Downloads the bytes in the stream to the client.

Parameter

Type

Description

Stops the polling requests from the client.

Executes the JavaScript script on the client.

Parameter

Type

Description

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

Parameter

Type

Description

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

Terminates the application and the corresponding session.

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

Parameter

Type

Description

Returns: . The first qualified by the match expression.

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

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

Parameter

Type

Description

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

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

Loads an assembly given the file name or path.

Parameter

Type

Description

Returns: . The loaded .

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

Creates an instance of the specified component from the assembly.

Parameter

Type

Description

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

Parameter

Type

Description

Parameter

Type

Description

Returns: .

Changes the current theme.

Parameter

Type

Description

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

Parameter

Type

Description

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

Navigate to the specified URL.

Parameter

Type

Description

Plays one of the built-in sounds

Parameter

Type

Description

Plays a sound.

Parameter

Type

Description

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

Parameter

Type

Description

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

Prints the specified window.

Parameter

Type

Description

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

Prints the entire browser window.

Causes the application to reload on the browser.

Removes the filter from the list of registered event filters.

Parameter

Type

Description

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

Parameter

Type

Description

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

Parameter

Type

Description

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

Throws:

The interval specified is less than 1.

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

Parameter

Type

Description

Returns: . An awaitable .

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

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

Parameter

Type

Description

Returns: .

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

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

Starts a bound to the current session context.

Parameter

Type

Description

Returns: . An instance of .

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

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

Parameter

Type

Description

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

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

Fired when the active window changes.

Fired when the application is about to shut down.

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

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

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

Fired at the beginning of every request.

Fired when the user resizes the browser.

Fired when the user activates the browser tab.

Fired when the user deactivates the browser tab.

Fired when the changes.

Fired at the end of every request.

Fired when the focused control changes.

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

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

Fired when the active responsive profile is changed.

Fired when the value changes.

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.

Fired when the current theme is changed.

Fired when a thread exception is thrown.

Name

Description

Control

Wisej.Web.Control

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Base class for all Wisej controls.

public class Control : IWisejControl,

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

Constructors

Control()

Initializes a new instance of the Control class.

Properties

AccessibleDescription

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

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

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

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

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

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

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

: Returns or sets the background color for the control.

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

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

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

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

: Determines whether the control can execute a command.

: Returns whether the control can receive focus.

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

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

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

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

: Returns or sets the shortcut menu associated with the control.

: Returns the collection of controls contained within the control.

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

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

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

You can use any CSS style string.

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

: Returns the data bindings for the control.

: Returns the default background color of the control.

: Returns the default font of the control.

: Returns the default background color of the control.

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

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

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

: Enables or disables the browser's context menu.

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

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

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

: Returns or sets the text color of the control.

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

: Returns whether the control specifies data bindings.

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

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

: Returns or sets the height of the control.

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

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

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

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

: Returns whether the control is mirrored.

: Returns the control's layout engine.

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

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

: Returns or sets the space between controls.

: Returns or sets the maximum size for the control.

: Returns or sets the minimum size for the control.

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

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

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

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

: Gets or sets the name of the control.

: Returns or sets padding within the control.

: Returns or sets the parent container of the control.

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

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

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

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

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

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

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

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

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

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

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

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

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

: Returns or sets the text associated with this control.

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

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

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

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

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

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

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

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

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

: Returns or sets the width of the control.

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

Parameter

Type

Description

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

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

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

Parameter

Type

Description

Returns: . The new value of the property.

Adds the specified theme state to the widget.

Parameter

Type

Description

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

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

Executes the specified delegate asynchronously.

Parameter

Type

Description

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

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

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

Parameter

Type

Description

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

Parameter

Type

Description

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

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

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

Parameter

Type

Description

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

Parameter

Type

Description

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

Creates and register this control and all its children.

Begins a drag-and-drop operation.

Parameter

Type

Description

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

Begins a drag-and-drop operation.

Parameter

Type

Description

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

Begins a drag-and-drop operation.

Parameter

Type

Description

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

Begins a drag-and-drop operation.

Parameter

Type

Description

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

Begins a drag-and-drop operation.

Parameter

Type

Description

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

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

Parameter

Type

Description

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

Parameter

Type

Description

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

Parameter

Type

Description

Returns: . An awaitable that represents the asynchronous operation.

Retrieves the form that the control is on.

Returns: .

Retrieves the page that the control is on.

Returns: .

Sets input focus to the control.

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

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

Parameter

Type

Description

Returns: . The child at the specified coordinates.

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

Parameter

Type

Description

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

Returns the script associated to the listener identified by id .

Parameter

Type

Description

Returns: . JavaScript associated with the listener.

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

Parameter

Type

Description

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

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

Returns: . The parent .

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

Parameter

Type

Description

Returns: . The next in the tab order.

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

Parameter

Type

Description

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

Checks whether the specified event name has any listener attached.

Parameter

Type

Description

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

Returns true if the property contains the specified class name .

Parameter

Type

Description

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

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

Parameter

Type

Description

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

Conceals the control from the user.

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

Parameter

Type

Description

Executes the specified delegate.

Parameter

Type

Description

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

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

Parameter

Type

Description

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

Determines whether the specified character is the mnemonic character.

Parameter

Type

Description

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

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

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

Parameter

Type

Description

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

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

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

Parameter

Type

Description

Detaches and removes the listener identified by id .

Parameter

Type

Description

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

Removes all the listeners attached to the event name .

Parameter

Type

Description

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

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

Parameter

Type

Description

Returns: . The new value of the property.

Removes the specified theme state from the widget.

Parameter

Type

Description

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

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

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

Resumes layout logic.

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

Parameter

Type

Description

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

Parameter

Type

Description

Scrolls the child control into view.

Activates a control.

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

Parameter

Type

Description

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

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

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

Parameter

Type

Description

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

Parameter

Type

Description

Displays the control to the user.

Suspends the layout logic for the control.

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

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

Returns: .

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

Parameter

Type

Description

Returns: .

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

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

Fired when the property value changes.

Fired when the value of the property changes.

Fired when the property changes.

Occurs when the value of the property changes.

Fired when the value of the property changes.

Fired when the control is clicked.

Fired when the property value changes.

Fired when the value of the property changes.

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

Fired when the value of the property changes.

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

Fired when the component is disposed.

Fired when the value of the property changes.

Fired when the control is double-clicked.

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

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

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

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

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

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

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

Fired when the property value has changed.

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

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

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

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

Fired when the control gains the input focus.

Fired when the property value changes.

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

Fired when the ImeMode property has changed.

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

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

Fired when a control should reposition its child controls.

Fired when the control loses the input focus.

Fired when the property value has changed.

Fired when a pointer holds on the screen.

Fired when the control's margin changes.

Fired when the control loses mouse capture.

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 enters the control.

Fired when the mouse pointer rests on the control.

Fired when the mouse pointer leaves the control.

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.

Fired when the control's padding changes.

Fired when a UserPaint control needs to redraw itself.

Fired when the property value changes.

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

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

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

Fired when the control is resized.

Fired when the active responsive profile is changed.

Fired when the property value changes.

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

Fired when the property value changes.

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

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

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

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

Fired when the control style changed.

Fired when a pointer swipes over the screen.

Fired when the property value has changed.

Fired when the value of the property changes.

Fired when a pointer taps on the screen.

Fired when the property value changes.

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

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

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

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

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

Fired when the control is finished validating.

Fired when the control is validating.

Fired when the property value changes.

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

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

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

Name

Description

Name

Description

v2.2

Welcome

Legend

Wisej.Web

General

Application.FormCollection

Application.PageCollection

HashChangedEventArgs

HashChangedEventHandler

ResponsiveProfileChangedEventArgs

ResponsiveProfileChangedEventHandler

ControlEventArgs

ControlEventHandler

DragEventHandler

HelpEventArgs

HelpEventHandler

KeyEventHandler

KeyPressEventArgs

KeyPressEventHandler

LayoutEventHandler

PaintEventHandler

PinchEventArgs

Properties

Scale

Used By

PinchEventHandler

PreviewKeyDownEventHandler

QueryContinueDragEventArgs

QueryContinueDragEventHandler

ResponsiveProfileChangedEventArgs

ResponsiveProfileChangedEventHandler

RotateEventHandler

SwipeEventArgs

SwipeEventHandler

TouchEventArgs

WidgetEventHandler

Screen

Properties

Bounds

DeviceName

WorkingArea

Buttons

MenuButtonItemClickedEventArgs

MenuButtonItemClickedEventHandler

Common Dialogs

FileDialogLoadPathEventHandler

Containers

General

Welcome

Legend

Application.FormCollection

Application.PageCollection

Common Dialogs

Buttons

Containers

Concepts & Reference

Skills

Properties

Count

Item(index)

Item(name)

Methods

GetEnumerator()

Properties

Count

Item(index)

Item(name)

Methods

GetEnumerator()

PinchEventArgs

Properties

Scale

Used By

Screen

Properties

Bounds

DeviceName

WorkingArea

HashChangedEventArgs

HashChangedEventHandler