1 of 68

General

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.

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

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

Manage cookies. Use to manage browser's cookies.
Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.
Read the application's URL. Use , , , and .
Read the applications's system information. Use , , , etc.
Listen to the application's global events. See , , , , , , and many more.
Retrieve browser related information. Use the to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The object is updated automatically when the user resizes the browser or the page is reloaded.
Control the client browser. Start a , execute JavaScript functions or scriptlets using or . Make the browser navigate to a different URL using or simply the page.
Manage the main page or current desktop. lets you change the object that fills the browser and "navigate" from page to page. lets you change the active object on the client browser.
Manage all live components in the session. Through the class you can find, iterate, inspect all live components of any type. See for all the currently created (visible or invisible) instances of . returns all the created objects. and provide an easy way to find any component in the session or to iterate the list of components that match a custom expression.
Start background tasks in context. provides a powerful way to start a background task on the server that can keep interacting with the client browser while running independently.
Manage the application's theme. Use to load a Wisej theme into the application. Or use the object to read all sorts of information from the current .
Terminate the application without waiting for the session to timeout. Use to terminate the current session and free all the related memory.

Properties

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

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

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

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

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

Methods

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

EXPERIMENTAL: Adds a scoped service to the service container.

Throws:

EXPERIMENTAL: Adds a scoped service to the service container.

Throws:

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

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

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

Executes the JavaScript function on the client.

Cancels the fullscreen mode.

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

Downloads the specified file on the client.

Downloads the specified image to the client.

Downloads the bytes in the stream to the client.

Downloads the specified file on the client.

Downloads the specified image to the client.

Downloads the bytes in the stream to the client.

Stops the polling requests from the client.

Executes the JavaScript script on the client.

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

Terminates the application and the corresponding session.

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

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

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

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

EXPERIMENTAL: Returns the requested service.

Throws:

Loads an assembly given the file name or path.

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

Creates an instance of the specified component from the assembly.

Changes the current theme.

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

Navigate to the specified URL.

Plays one of the built-in sounds

Plays a sound.

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

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

Prints the specified control.

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

Prints the entire browser window.

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

Causes the application to reload on the browser.

Removes the filter from the list of registered event filters.

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

Throws:

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

Sets the current session timeout in seconds.

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

Throws:

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

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

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

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

Events

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

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

Implements

Client

Wisej.Core.Client

Namespace: Wisej.Core

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

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

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

Configuration

Wisej.Core.Configuration

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Wisej configuration settings.

Constructors

Configuration(json)

Creates a new instance from the specified json string.

Name

Type

Description

Properties

AllowedRoutes

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

AutoReload

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

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

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.

Methods

Loads or retrieves the configuration file.

Events

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.

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.

Properties

Count

: Returns the total number of currently open pages.

Item(index)

: Returns the page at the specified index.

Item(name)

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

Methods

GetEnumerator()

Returns an enumerator that iterates through the open pages.

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

Constructors

HashChangedEventArgs(value)

Initializes a new instance of the class.

Name

Type

Description

Properties

Hash

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

Parameters

Name

Type

Description

Fired By

Name

Description

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.

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

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

Manage cookies. Use to manage browser's cookies.
Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.
Read the application's URL. Use , , , and .
Read the applications's system information. Use , , , etc.
Listen to the application's global events. See , , , , , , and many more.
Retrieve browser related information. Use the to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The object is updated automatically when the user resizes the browser or the page is reloaded.
Control the client browser. Start a , execute JavaScript functions or scriptlets using or . Make the browser navigate to a different URL using or simply the page.
Manage the main page or current desktop. lets you change the object that fills the browser and "navigate" from page to page. lets you change the active object on the client browser.
Manage all live components in the session. Through the class you can find, iterate, inspect all live components of any type. See for all the currently created (visible or invisible) instances of . returns all the created objects. and provide an easy way to find any component in the session or to iterate the list of components that match a custom expression.
Start background tasks in context. provides a powerful way to start a background task on the server that can keep interacting with the client browser while running independently.
Manage the application's theme. Use to load a Wisej theme into the application. Or use the object to read all sorts of information from the current .
Terminate the application without waiting for the session to timeout. Use to terminate the current session and free all the related memory.

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

Properties

ActiveProfile

: Returns or sets the current client responsive profile.

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

Browser

: Returns or sets the client browser information.

ClientId

: Returns the current unique client id.

Clients

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

CommonAppDataPath

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

CommonAppDataRegistry

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

CompanyName

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

Configuration

: Returns the current .

Cookies

: Collection of cookies.

Current

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

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

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

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

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

Methods

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

EXPERIMENTAL: Adds a scoped service to the service container.

Throws:

EXPERIMENTAL: Adds a scoped service to the service container.

Throws:

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

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

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

Executes the JavaScript function on the client.

Cancels the fullscreen mode.

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

Downloads the specified file on the client.

Downloads the specified image to the client.

Downloads the bytes in the stream to the client.

Downloads the specified file on the client.

Downloads the specified image to the client.

Downloads the bytes in the stream to the client.

Stops the polling requests from the client.

Executes the JavaScript script on the client.

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

Terminates the application and the corresponding session.

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

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

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

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

EXPERIMENTAL: Returns the requested service.

Throws:

Loads an assembly given the file name or path.

Creates an instance of the specified component from the assembly.

Changes the current theme.

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

Navigate to the specified URL.

Plays one of the built-in sounds

Plays a sound.

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

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

Prints the specified control.

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

Prints the entire browser window.

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

Causes the application to reload on the browser.

Removes the filter from the list of registered event filters.

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

Throws:

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

Sets the current session timeout in seconds.

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

Throws:

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

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

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

Events

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.

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

Implements

Control

Wisej.Web.Control

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Base class for all Wisej controls.

public class Control : IWisejControl, IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfiles

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

Constructors

Control()

Initializes a new instance of the Control class.

Properties

AccessibleDescription

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

AccessibleName

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

AccessibleRole

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

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

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

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

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

String: Sets the appearance key for the theme engine.

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

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

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

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

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

BindingContext: Returns or sets the BindingContext for the control.

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

Rectangle: Returns or sets the size and location of the control including its non-client area, in pixels and relative to the parent control.

Boolean: Determines whether the control can execute a command.

Boolean: Returns whether the control can receive focus.

Boolean: Returns whether the control can be selected.

Boolean: Returns or sets whether the control has captured the mouse.

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

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

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

AddClientEventListener
HasClientEventListener
RemoveClientEventListener
RemoveClientEventListener
GetClientEventListener

Rectangle: Returns the client rectangle of the control.

Size: Returns or sets the height and width of the client area.

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

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

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

Boolean: Returns a value indicating whether the control has been created.

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

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

AddCssClass
RemoveCssClass
HasCssClass

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

You can use any CSS style string.


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

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

ControlBindingsCollection: Returns the data bindings for the control.

Color: Returns the default background color of the control.

Font: Returns the default font of the control.

Color: Returns the default background color of the control.

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

Boolean: Returns whether the control is in the process of disposing itself and child controls.

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

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

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

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

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

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

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

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

Boolean: Returns whether the control contains any child control.

Boolean: Returns whether the control specifies data bindings.

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

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

Int32: Returns or sets the height of the control.

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

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

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

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

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

AddClientEventListener
HasClientEventListener
RemoveClientEventListener
RemoveClientEventListener
GetClientEventListener

Boolean: Returns whether the control has been disposed.

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

Boolean: Returns whether the control is mirrored.

LayoutEngine: Returns the control's layout engine.

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

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

Padding: Returns or sets the space between controls.

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

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

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

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

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

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

String: Gets or sets the name of the control.

Padding: Returns or sets padding within the control.

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

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

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

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

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

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

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

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

Boolean: Returns or sets whether the text in the control can be selected in the browser by the user by dragging the pointer. [Since 2.5.22]

Not to be confused with Selectable, which corresponds to the Focusable property. When Selectable is set to true, the text of the control (i.e. a label or a button) can be highlighted in the browser and copied to the clipboard. It will also make the widget "focusable" but only in the browser.

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

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

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

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

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

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

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

AddState
RemoveState
HasState

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

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

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

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

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

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

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

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

Control: Returns the parent control that is not parented by another Form. Typically, this is the outermost Form that the control is contained in.

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

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

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

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

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

Int32: Returns or sets the width of the control.

Methods

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

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

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

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

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

Adds the specified theme state to the widget.

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

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

Executes the specified delegate asynchronously.

Returns: IAsyncResult. An IAsyncResult that represents the result of the BeginInvoke operation.

Executes the specified delegate asynchronously.

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

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

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

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

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

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

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

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

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

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

Creates and register this control and all its children.

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

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

Returns: Object. The return value from the asynchronous operation.

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

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

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

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

Retrieves the form that the control is on.

Returns: Form.

Retrieves the page that the control is on.

Returns: Page.

Sets input focus to the control.

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

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

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

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

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

Returns the script associated to the listener identified by id .

Returns: String. JavaScript associated with the listener.

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

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

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

Returns: IContainerControl. The parent IContainerControl.

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

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

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

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

Checks whether the specified event name has any listener attached.

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

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

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

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

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

Conceals the control from the user.

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

Executes the specified delegate.

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

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

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

Determines whether the specified character is the mnemonic character.

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

Arranges all the child Control using the specified dock style, spaced by spacing pixels.

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

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

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

Throws:

ArgumentException One of the controls is not a child of this control.

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

Throws:

ArgumentException One of the controls is not a child of this control.

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

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

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

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

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

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

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

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

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

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

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

Detaches and removes the listener identified by id .

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

Removes all the listeners attached to the event name .

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

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

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

Removes the specified theme state from the widget.

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

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

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.

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

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

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

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

Displays the control to the user.

Suspends the layout logic for the control.

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

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

Returns: Boolean. true if all of the children validated successfully; otherwise, false. If called from the Validating or Validated event handlers, this method will always return false.

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

Returns: Boolean. true if all of the children validated successfully; otherwise, false. If called from the Validating or Validated event handlers, this method will always return false.

Events

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

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

EventHandler Fired when the AutoSize property value changes.

EventHandler Fired when the value of the BackColor property changes.

EventHandler Fired when the value of the BackgroundImage property changes.

EventHandler Fired when the BackgroundImageLayout property changes.

EventHandler Fired when the value of the BecomingActiveControl property changes.

EventHandler Occurs when the value of the BindingContext property changes.

EventHandler Fired when the value of the CausesValidation property changes.

EventHandler Fired when the control is clicked.

EventHandler Fired when the ClientSize property value changes.

EventHandler Fired when the value of the ContextMenu property changes.

ControlEventHandler Fired when a new control is added to the ControlCollection.

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

ControlEventHandler Fired when a control is removed from the ControlCollection.

EventHandler Fired when the value of the Cursor property changes.

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

EventHandler Fired when the component is disposed.

EventHandler Fired when the value of the Dock property changes.

EventHandler Fired when the control is double-clicked.

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

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

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

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

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

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

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

EventHandler Fired when the Enabled property value has changed.

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

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

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

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

EventHandler Fired when the control gains the input focus.

EventHandler Fired when the Font property value changes.

EventHandler Fired when the ForeColor property value changes.

EventHandler Fired when the control gains the focus.

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

EventHandler Fired when the ImeMode property has changed.

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

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

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

LayoutEventHandler Fired when a control should reposition its child controls.

EventHandler Fired when the control loses the input focus.

EventHandler Fired when the Location property value has changed.

EventHandler Fired when a pointer holds on the screen.

EventHandler Fired when the control loses focus.

EventHandler Fired when the control's margin changes.

EventHandler Fired when the control loses mouse capture.

MouseEventHandler Fired when the control is clicked by the mouse.

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

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

EventHandler Fired when the mouse pointer enters the control.

EventHandler Fired when the mouse pointer rests on the control.

EventHandler Fired when the mouse pointer leaves the control.

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

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

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

EventHandler Fired when the control's padding changes.

PaintEventHandler Fired when a UserPaint control needs to redraw itself.

EventHandler Fired when the Parent property value changes.

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

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

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

EventHandler Fired when the control is resized.

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

EventHandler Fired when the RightToLeft property value changes.

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

EventHandler Fired when the Size property value changes.

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

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

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

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

EventHandler Fired when the control style changed.

SwipeEventHandler Fired when a pointer swipes over the screen.

EventHandler Fired when the TabIndex property value has changed.

EventHandler Fired when the value of the TabStop property changes.

EventHandler Fired when a pointer taps on the screen.

EventHandler Fired when the Text property value changes.

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

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

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

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

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

EventHandler Fired when the control is finished validating.

CancelEventHandler Fired when the control is validating.

EventHandler Fired when the Visible property value changes.

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

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

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

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

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

Inherited By

Implements

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

DataObject(format, data)

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

Name

Type

Description

DataObject(format, data)

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

Methods

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

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

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

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

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

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

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

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

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

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

Retrieves an audio stream from the data object.

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

Returns the data associated with the specified class type format.

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

Returns the data associated with the specified data format.

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

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

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

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

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

Returns the data associated with the specified class type format.

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

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

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

Returns the list of file types from the data object.

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

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

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

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

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

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

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

Retrieves an image from the data object.

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

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

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

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

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

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

Throws:

ArgumentNullException audioBytes is null.

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

Throws:

ArgumentNullException audioStream is null.

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

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

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

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

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

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

Throws:

ArgumentNullException filePaths is null.

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

Throws:

ArgumentNullException filePaths is null.

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

Throws:

ArgumentNullException image is null.

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

Throws:

ArgumentNullException textData is null or Empty.

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

Throws:

ArgumentNullException textData is null or Empty.