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.

Static method or property or event.

Protected method or property or event.

Deprecated method or property or event.

Concepts & Reference

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

Skills

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

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

Wisej.Web

General

Application.FormCollection

Wisej.Web.Application FormCollection

Namespace: Wisej.Web

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

Returns: .

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.

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.

Returns: .

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

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

Represents the method that will handle the HashChanged event.

public delegate void HashChangedEventHandler(Object sender, HashChangedEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Constructors

ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the class.

Name

Type

Description

Properties

CurrentProfile

: The new active profile.

PreviousProfile

: The previously active profile.

Used By

Name

Description

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Parameters

Name

Type

Description

Fired By

Name

Description

ControlEventArgs

Wisej.Web.ControlEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the ControlAdded and ControlRemoved events.

public class ControlEventArgs : EventArgs

Public Class ControlEventArgs
    Inherits EventArgs

Constructors

ControlEventArgs(control)

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

Name

Type

Description

control

The to store in this event.

Properties

Control

Control: Returns the control object used by this event.

Used By

Name

Description

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

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.

Parameters

Name

Type

Description

Fired By

Name

Description

HelpEventArgs

Wisej.Web.HelpEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the HelpRequested event.

public class HelpEventArgs : EventArgs

Public Class HelpEventArgs
    Inherits EventArgs

Constructors

HelpEventArgs(target)

Initializes a new instance of the HelpEventArgs class.

Name

Type

Description

target

The that had the focus when the user pressed F1.

Properties

Handled

Boolean: Returns or sets a value indicating whether the help event was handled.

Target

Control: Returns the Control that had the focus when the user pressed F1.

Used By

Name

Description

Represents the method that will handle the event of a .

HelpEventHandler

Wisej.Web.HelpEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

Parameters

Name

Type

Description

Fired By

Name

Description

KeyEventHandler

Wisej.Web.KeyEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public delegate void KeyEventHandler(Object sender, KeyEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

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

KeyPressEventArgs

Wisej.Web.KeyPressEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Constructors

KeyPressEventArgs(keyChar)

Initializes a new instance of the class.

Name

Type

Description

Properties

Handled

: Returns or sets whether the event was handled.

KeyChar

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

Used By

Name

Description

KeyPressEventHandler

Wisej.Web.KeyPressEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public delegate void KeyPressEventHandler(Object sender, KeyPressEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

LayoutEventHandler

Wisej.Web.LayoutEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

Parameters

Name

Type

Description

Fired By

Name

Description

PaintEventArgs

Wisej.Web.PaintEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Constructors

PaintEventArgs(graphics, clipRect)

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

Name

Type

Description

Properties

ClipRectangle

: Returns the rectangle in which to paint.

Graphics

: Returns the graphics used to paint.

Used By

Name

Description

PaintEventHandler

Wisej.Web.PaintEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

Parameters

Name

Type

Description

Fired By

Name

Description

PinchEventArgs

Wisej.Web.PinchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for event.

Properties

Scale

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

Parameters

Name

Type

Description

Fired By

Name

Description

PreviewKeyDownEventHandler

Wisej.Web.PreviewKeyDownEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the PreviewKeyDown event.

public delegate void PreviewKeyDownEventHandler(Object sender, PreviewKeyDownEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

QueryContinueDragEventArgs

Wisej.Web.QueryContinueDragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Constructors

QueryContinueDragEventArgs(args)

Initializes a new instance of the class.

Name

Type

Description

Properties

Action

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

EscapePressed

: Returns if the user pressed the ESC key.

KeyState

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

Used By

Name

Description

QueryContinueDragEventHandler

Wisej.Web.QueryContinueDragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public delegate void QueryContinueDragEventHandler(Object sender, QueryContinueDragEventArgs e)

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

Parameters

Name

Type

Description

sender

The source of an event.

A that contains the event data.

Fired By

Name

Description

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

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Parameters

Name

Type

Description

Fired By

Name

Description

RotateEventArgs

Wisej.Web.RotateEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for Rotate event.

public class RotateEventArgs : EventArgs

Public Class RotateEventArgs
    Inherits EventArgs

Properties

Angle

Double: Returns a number with the current calculated angle between the primary and secondary active pointers.

Used By

Name

Description

Represents the method that will handle the event.

RotateEventHandler

Wisej.Web.RotateEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

SwipeEventArgs

Wisej.Web.SwipeEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for event.

Properties

Axis

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

Direction

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

Distance

: Returns the distance of the performed swipe.

Duration

: Returns the duration the performed swipe took.

StartTime

: Returns the start time of the performed swipe.

Velocity

: Returns the velocity of the performed swipe.

Used By

Name

Description

SwipeEventHandler

Wisej.Web.SwipeEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the Swipe event.

public delegate void SwipeEventHandler(Object sender, SwipeEventArgs e)

Public Delegate Sub SwipeEventHandler(ByVal sender As [Object], ByVal e As SwipeEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

Fired when a pointer swipes over the screen.

TouchEventArgs

Wisej.Web.TouchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for event.

Properties

Identifiers

: Returns the unique identifiers for the touch items.

IsMultiTouch

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

Locations

: Returns the location of the touch items in screen coordinates.

Rotation

: Returns the delta of the rotation since the start of the event, in degrees.

Scale

: Returns the distance between two fingers since the start of the event.

Used By

Name

Description

TouchEventHandler

Wisej.Web.TouchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the TouchStart, TouchEnd, TouchMove, TouchCancel events.

public delegate void TouchEventHandler(Object sender, TouchEventArgs e)

Public Delegate Sub TouchEventHandler(ByVal sender As [Object], ByVal e As TouchEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

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

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 moved along the touch surface.

TrackEventArgs

Wisej.Web.TrackEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for event.

Properties

Axis

: Returns the Axis of the track event.

Location

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

X

: Returns the X delta of the track event.

Y

: Returns Y delta of the track event.

Used By

Name

Description

TrackEventHandler

Wisej.Web.TrackEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

WidgetEventArgs

Wisej.Web.WidgetEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event of the control.

Constructors

WidgetEventArgs(type, data)

Initializes a new instance of the class.

Name

Type

Description

Properties

Data

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

Type

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

Used By

Name

Description

WidgetEventHandler

Wisej.Web.WidgetEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that handles a event.

Parameters

Name

Type

Description

Fired By

Name

Description

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

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

Buttons

MenuButtonItemClickedEventArgs

Wisej.Web.MenuButtonItemClickedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the ItemClicked event.

public class MenuButtonItemClickedEventArgs : EventArgs

Public Class MenuButtonItemClickedEventArgs
    Inherits EventArgs

Constructors

MenuButtonItemClickedEventArgs(item)

Initializes a new instance of the MenuButtonItemClickedEventArgs class.

Name

Type

Description

item

The that was clicked.

Properties

Item

MenuItem: Returns the clicked menu item.

Used By

Name

Description

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

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.

Parameters

Name

Type

Description

Fired By

Name

Description

Common Dialogs

ColorDialog

Wisej.Web.ColorDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

CommonDialog
- ColorDialog

Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors.

public class ColorDialog : CommonDialog

Public Class ColorDialog
    Inherits CommonDialog

Constructors

ColorDialog()

Initializes a new instance of ColorDialog.

ColorDialog(container)

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

Name

Type

Description

container

An that represents the container of the component.

Properties

Color

Color: Returns or sets the color selected by the user.

CustomColors

Color[]: Returns or sets the set of custom colors shown in the dialog box.

Methods

Reset()

Resets all properties to their default values.

FileDialogLoadPathEventHandler

Wisej.Web.FileDialogLoadPathEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the LoadPath and LoadPath events.

public delegate void FileDialogLoadPathEventHandler(Object sender, FileDialogLoadPathEventArgs e)

Public Delegate Sub FileDialogLoadPathEventHandler(ByVal sender As [Object], ByVal e As FileDialogLoadPathEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A that contains the event data.

Fired By

Name

Description

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

FileDialogRootCollection

Wisej.Web.FileDialogRootCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represent a collection of the root file systems shown by the implementation.

Methods

MapPath(filePath)

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

Parameter

Type

Description

Returns: . The physical path for the implementation.

Containers

AccordionAction

Wisej.Web.AccordionAction

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Defines values representing Accordion events.

public enum AccordionAction : Enum

Public Enum AccordionAction As [Enum]

Fields

Name

Description

Deselected

Represents the event.

Deselecting

Represents the event.

Selected

Represents the event.

Selecting

Represents the event.

Used By

Name

Description

Returns a value indicating which event is occurring.

AccordionCancelEventHandler

Wisej.Web.AccordionCancelEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Parameters

Name

Type

Description

Fired By

Name

Description

AcceleratorEventHandler

Wisej.Web.AcceleratorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterAddRemoveItemsCancelEventArgs

Wisej.Web.DataRepeaterAddRemoveItemsCancelEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the UserDeletingItems event.

public class DataRepeaterAddRemoveItemsCancelEventArgs : CancelEventArgs

Public Class DataRepeaterAddRemoveItemsCancelEventArgs
    Inherits CancelEventArgs

Constructors

DataRepeaterAddRemoveItemsCancelEventArgs(index, count)

Initializes a new instance of the DataRepeaterAddRemoveItemsCancelEventArgs class.

Name

Type

Description

index

The index of the that is being deleted.

count

The number of items being deleted.

Properties

ItemCount

Int32: Gets the number of items being deleted.

ItemIndex

Int32: Returns the index of the item that is being deleted.

Used By

Name

Description

Represents the method that handles the event.

DataRepeaterAddRemoveItemsCancelEventHandler

Wisej.Web.DataRepeaterAddRemoveItemsCancelEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that handles the event.

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterDataErrorEventHandler

Wisej.Web.DataRepeaterDataErrorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the DataError event.

public delegate void DataRepeaterDataErrorEventHandler(Object sender, DataRepeaterDataErrorEventArgs e)

Public Delegate Sub DataRepeaterDataErrorEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterDataErrorEventArgs)

Parameters

Name

Type

Description

sender

The source of the event.

A object that contains the event data.

Fired By

Name

Description

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

DataRepeaterItemCloneEventHandler

Wisej.Web.DataRepeaterItemCloneEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterItemEventArgs

Wisej.Web.DataRepeaterItemEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

Constructors

DataRepeaterItemEventArgs(item)

Initializes a new instance of the class.

Name

Type

Description

Properties

DataRepeaterItem

: Returns a instance that triggered the event.

Used By

Name

Description

DataRepeaterItemEventHandler

Wisej.Web.DataRepeaterItemEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterItemValueEventHandler

Wisej.Web.DataRepeaterItemValueEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the and events.

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterLayoutStyles

Wisej.Web.DataRepeaterLayoutStyles

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides an enumeration for specifying the orientation of items in a DataRepeater control.

public enum DataRepeaterLayoutStyles : Enum

Public Enum DataRepeaterLayoutStyles As [Enum]

Fields

Name

Description

Horizontal

Items are displayed in a horizontal format. A horizontal scroll bar will be displayed as necessary.

Vertical

Items are displayed in a vertical format. A vertical scroll bar will be displayed as necessary.

Used By

Name

Description

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

DesktopTaskBarItemClickEventHandler

Wisej.Web.DesktopTaskBarItemClickEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

Parameters

Name

Type

Description

Fired By

Name

Description

Clipboard

Wisej.Web.Clipboard

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public class Clipboard

Public Class Clipboard

Methods

Clear()

Removes all data from the Clipboard.

ContainsAudio()

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

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

ContainsData(format)

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

Parameter

Type

Description

format

The format of the data to look for. See for predefined formats.

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

ContainsFileDropList()

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

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

ContainsImage()

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

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

ContainsText()

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

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

ContainsText(format)

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

Parameter

Type

Description

format

One of the values.

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

GetAudioStream()

Retrieves an audio stream from the Clipboard.

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

GetData(format)

Retrieves data from the Clipboard in the specified format.

Parameter

Type

Description

format

The format of the data to retrieve. See for predefined formats.

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

GetDataObject()

Retrieves the data that is currently on the system Clipboard.

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

GetFileDropList()

Retrieves a collection of file names from the Clipboard.

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

GetImage()

Retrieves an image from the Clipboard.

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

GetText()

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

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

GetText(format)

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

Parameter

Type

Description

format

One of the values.

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

SetAudio(audioBytes)

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

Parameter

Type

Description

audioBytes

A array containing the audio data.

Throws:

ArgumentNullException audioBytes is null.

SetAudio(audioStream)

Saves the Stream in the WaveAudio format to the clipboard.

Parameter

Type

Description

audioStream

A containing the audio data.

Throws:

ArgumentNullException audioStream is null.

SetClientText(text)

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

Parameter

Type

Description

text

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

Throws:

ArgumentNullException text is null.

SetData(format, data)

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

Parameter

Type

Description

format

The format of the data to set. See for predefined formats.

data

An representing the data to add.

Throws:

ArgumentNullException data is null.

SetDataObject(data)

Saves the specified data to the clipboard.

Parameter

Type

Description

data

The data to place on the Clipboard.

Throws:

ArgumentNullException The value of data is null.

SetFileDropList(filePaths)

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

Parameter

Type

Description

filePaths

A containing the file names.

Throws:

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

SetImage(image)

Saves the Image in the Bitmap format to the clipboard

Parameter

Type

Description

image

The to add to the Clipboard.

Throws:

ArgumentNullException image is null.

SetText(text)

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

Parameter

Type

Description

text

The text to add to the Clipboard.

Throws:

ArgumentNullException text is null or Empty.

SetText(text, format)

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

Parameter

Type

Description

text

The text to add to the Clipboard.

format

One of the values.

Throws:

ArgumentNullException text is null.

DataRepeater

Wisej.Web.DataRepeater

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Control
- ScrollableControl
  - ContainerControl
    DataRepeater

Displays data in a customizable list format.

public class DataRepeater : ContainerControl, ISupportInitialize

Public Class DataRepeater
    Inherits ContainerControl
    Implements ISupportInitialize

Constructors

DataRepeater()

Initializes a new instance of the DataRepeater class.

Properties

AllowUserToAddItems

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

AllowUserToDeleteItems

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

BorderStyle

BorderStyle: Returns or sets the border style for the DataRepeater control.

CurrentItem

DataRepeaterItem: Returns the current DataRepeaterItem in the DataRepeater control.

CurrentItemIndex

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

DataMember

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

DataSource

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

DisplayedItems

DataRepeaterItem[]: Returns the list of DataRepeaterItem items currently displayed on the client.

FirstDisplayedItemIndex

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

IsCurrentItemModified

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

ItemBorderStyle

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

ItemCount

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

ItemHeaderSize

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

ItemHeaderVisible

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

ItemSelectedBackColor

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

ItemSize

Size: Returns or sets the size of the DataRepeaterItem child panels.

ItemTemplate

DataRepeaterItem: Returns the template that represents the DataRepeaterItem for the DataRepeater control.

LayoutStyle

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

PrefetchItems

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

RightToLeftLayout

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

ScrollBarVisible

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

VirtualMode

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

Methods

AddNew()

Adds a new DataRepeaterItem to the DataRepeater control.

Throws:

ReadOnlyException The AllowUserToAddItems property is set to False.

CancelEdit()

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

Refresh()

Forces a full reload of the data displayed by this DataRepeater.

Refresh(refreshChildren)

Forces a full reload of the data displayed by this DataRepeater.

Parameter

Type

Description

refreshChildren

True to also refresh all the children of this control.

RemoveAt(index)

Removes a DataRepeaterItem at the specified position from a DataRepeater control.

Parameter

Type

Description

index

The index of the .

Throws:

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

ResetItemBorderStyle()

Resets the value of ItemBorderStyle to the original value.

ResetItemHeaderSize()

Resets the value of ItemHeaderSize to the original value.

ResetItemHeaderVisible()

Resets the value of ItemHeaderVisible to the original value.

ScrollItemIntoView(index)

Scrolls the specified DataRepeaterItem into view.

Parameter

Type

Description

index

The index of the .

Throws:

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

ScrollItemIntoView(index, alignWithTop)

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

Parameter

Type

Description

index

The index of the .

alignWithTop

true to align the top of the with the top of the control; otherwise, false.

Throws:

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

Events

AllowUserToAddItemsChanged

EventHandler Fired when the AllowUserToAddItems property changes.

AllowUserToDeleteItemsChanged

EventHandler Fired when the AllowUserToDeleteItems property changes.

CurrentItemIndexChanged

EventHandler Fired when the property CurrentItemIndex changes.

DataError

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

DataMemberChanged

EventHandler Fired when the DataMember property changes.

DataSourceChanged

EventHandler Fired when the DataSource property changes.

ItemValueNeeded

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

ItemValuePushed

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

LayoutStyleChanged

EventHandler Fired when the LayoutStyle property changes.

NewItemNeeded

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

UserAddedItems

DataRepeaterAddRemoveItemsEventHandler Fired when the user adds a new DataRepeaterItem.

UserDeletedItems

DataRepeaterAddRemoveItemsEventHandler Fired after the user deletes a DataRepeaterItem.

UserDeletingItems

DataRepeaterAddRemoveItemsCancelEventHandler Fired when the user deletes a DataRepeaterItem.

VirtualModeChanged

EventHandler Fired when the VirtualMode property changes.

Implements

Name

Description

Bindable components implement this interface.

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

All wisej components implement this interface.

All wisej controls derived from the class must implement this interface.

Allows an object to serialize itself.

DataObject

Wisej.Web.DataObject

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Implements a basic data transfer mechanism.

public class DataObject : IDataObject

Public Class DataObject
    Inherits IDataObject

Constructors

DataObject()

Initializes a new instance of the DataObject class.

DataObject(data)

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

Name

Type

Description

data

The data to store.

DataObject(format, data)

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

Name

Type

Description

format

The format of the specified data. See for predefined formats.

data

The data to store.

Methods

ContainsAudio()

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

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

ContainsFileDropList()

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.

ContainsImage()

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.

ContainsText()

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

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

ContainsText(format)

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

Parameter

Type

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

Parameter

Type

Description

format

The format of the data to retrieve. See for predefined formats.

autoConvert

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

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

GetDataPresent(format)

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

Parameter

Type

Description

format

A representing the format to check for.

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

GetDataPresent(format)

Returns the data associated with the specified class type format.

Parameter

Type

Description

format

A representing the format of the data to retrieve.

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

GetDataPresent(format, autoConvert)

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

Parameter

Type

Description

format

Description

audioBytes

A array containing the audio data.

Throws:

ArgumentNullException audioBytes is null.

SetAudio(audioStream)

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

Parameter

Type

Description

audioStream

A containing the audio data.

Throws:

ArgumentNullException audioStream is null.

Parameter

Type

Description

format

The format associated with the data. See for predefined formats.

autoConvert

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

data

The data to store.

SetDownloadURL(url, fileName)

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

Parameter

Type

Description

url

The url to the file to download.

fileName

The name of the file to download from the url.

SetFileDropList(filePaths)

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

Parameter

Type

Description

filePaths

A containing the file names.

Throws:

ArgumentNullException filePaths is null.

SetImage(image)

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

Parameter

Type

Description

image

The to add to the data object.

Throws:

ArgumentNullException image is null.

SetText(textData)

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

Parameter

Type

Description

textData

The text to add to the data object.

Throws:

ArgumentNullException textData is null or Empty.

SetText(textData, format)

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

Parameter

Type

Description

textData

The text to add to the data object.

format

One of the values.

Throws:

ArgumentNullException textData is null or Empty.

Implements

Name

Description

Provides a format-independent mechanism for transferring data.

Application

Wisej.Web.Application

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public class Application : IWisejComponent, IDisposable, IWisejSynchronized

Public Class Application
    Inherits IWisejComponent
    Implements IDisposable, IWisejSynchronized

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

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

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

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

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

Properties

ActiveProfile

ClientProfile: Returns or sets the current client responsive profile.

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

Browser

ClientBrowser: Returns or sets the client browser information.

ClientFingerprint

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

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

CommonAppDataPath

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

CommonAppDataRegistry

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

CompanyName

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

Configuration

Configuration: Returns the current Configuration.

Cookies

CookieCollection: Collection of cookies.

Current

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

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

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

CurrentCulture

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

Desktop

Desktop: Returns or sets the current Desktop.

EnableUnloadConfirmation

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

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.

ExecutablePath

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

FavIcon

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

FavIconSource

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

Hash

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

IsAuthenticated

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

IsDisposed

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

IsExpired

Boolean: Returns true when the current session has expired.

IsSecure

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

IsTerminated

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

IsWebSocket

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

LicenseKey

String: Returns or sets the runtime server license key.

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

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

MainPage

Page: Returns or sets the current full page window.

OpenForms

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

OpenPages

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

Platform

ClientPlatform: The name of the currently loaded platform.

ProductName

String: Returns the product name associated with this application.

ProductVersion

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

QueryString

NameValueCollection: Returns the parameters used to launch the application.

RightToLeft

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

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

RuntimeMode

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

ServerName

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

ServerPort

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

ServerVariables

NameValueCollection: Returns the server variables.

Session

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

SessionCount

Int32: Returns the total number of currently active sessions.

SessionId

String: Returns the unique current session ID.

ShowConsole

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

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

ShowLoader

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

StartupPath

String: Returns the root path of the web application.

StartupUri

Uri: Returns the URI used to start the application.

StartupUrl

String: Returns the URL used to start the application.

Theme

ClientTheme: Returns or sets the current ClientTheme.

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

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

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

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

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


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

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

Title

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

Uri

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

Url

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

User

IPrincipal: Returns the security information for the current request.

UserAgent

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

UserHostAddress

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

UserHostName

String: Gets the DNS name of the remote client.

UserIdentity

WindowsIdentity: Returns the WindowsIdentity type for the current user.

UserLanguages

The name of the function to execute.

args

The arguments to pass to the function.

Call(function, callback, args)

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

Parameter

Type

Description

function

The name of the function to execute.

callback

Asynchronous callback method that receives the return value.

args

The arguments to pass to the function.

CallAsync(function, args)

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

Parameter

Type

Downloads the specified file on the client.

Parameter

Type

Description

target

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

filePath

The file to download.

fileName

The name of the file to save on the client.

DownloadAndOpen(target, image, fileName)

Downloads the specified image to the client.

Parameter

Type

Description

target

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

image

The image to download.

fileName

The name of the file to save on the client.

DownloadAndOpen(target, stream, fileName)

Downloads the bytes in the stream to the client.

Parameter

Type

Description

Type

Description

script

The script to evaluate.

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

Exit()

Terminates the application and the corresponding session.

FindComponent(match)

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

Parameter

Type

Description

match

A custom expression used to match the to find.

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

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

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

FindComponents(match)

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

Parameter

Type

Description

match

A custom expression used to match the list of objects to find.

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

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

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

LoadAssembly(filePath)

Loads an assembly given the file name or path.

Parameter

Type

Description

filePath

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

Returns: Assembly. The loaded Assembly.

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

LoadComponent(filePath, className)

Creates an instance of the specified component from the assembly.

Parameter

Type

Description

filePath

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

className

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

LoadPackages(packages, callback)

Parameter

Type

Description

packages

callback

LoadPackagesAsync(packages)

Parameter

Type

Description

packages

Returns: Task<Boolean>.

LoadTheme(name, mixins)

Changes the current theme.

Parameter

Type

Description

name

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

mixins

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

MapPath(path)

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

Parameter

Type

Description

path

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

Navigate(url, target)

Navigate to the specified URL.

Parameter

Type

Description

url

URL to navigate to.

target

The target browser window: _self, _blank, etc.

Play(type)

Plays one of the built-in sounds

Parameter

Type

Description

type

One of value that identifies the sound to play.

Play(soundUrl)

Plays a sound.

Parameter

Type

Description

soundUrl

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

Post(callback)

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

Parameter

Type

Description

callback

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

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


void Test() {

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

Print(window)

Prints the specified window.

Parameter

Type

Description

window

The window to print

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

Print()

Polling interval in milliseconds. The minimum is 1000ms.

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


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

Application.StartTask(() => {

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

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

});

Throws:

ArgumentOutOfRangeException The interval specified is less than 1.

StartTask(action)

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

Parameter

Type

Description

action

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

Returns: Task. An awaitable Task.

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

Application.StartTask(() => {

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

StartTask<T>(action)

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

Parameter

Type

Description

action

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

Returns: Task<T>.

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

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

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

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

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

StartTimer(dueTime, period, callback)

Starts a Timer bound to the current session context.

Parameter

Type

Description

dueTime

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

period

The time interval between invocations, in milliseconds.

callback

A callback method to invoke at the specified intervals.

Returns: Timer. An instance of Timer.

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

Update(context, action)

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

Parameter

Type

Description

context

The application context to update. It can be any Wisej component or the returned by the property .

action

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

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

Application.StartTask(() => {

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

});

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

Application.StartTask(() => {

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

});

Events

ActiveWindowChanged

EventHandler Fired when the active window changes.

ApplicationExit

EventHandler Fired when the application is about to shut down.

ApplicationRefresh

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

ApplicationStart

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

BeforeInstallPrompt

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

BeginRequest

EventHandler Fired at the beginning of every request.

BrowserSizeChanged

EventHandler Fired when the user resizes the browser.

BrowserTabActivated

EventHandler Fired when the user activates the browser tab.

BrowserTabDeactivated

EventHandler Fired when the user deactivates the browser tab.

CultureChanged

EventHandler Fired when the CurrentCulture changes.

EndRequest

EventHandler Fired at the end of every request.

FocusedControlChanged

EventHandler Fired when the focused control changes.

HashChanged

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

Idle

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

ResponsiveProfileChanged

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

RightToLeftChanged

EventHandler Fired when the RightToLeft value changes.

SessionTimeout

HandledEventHandler Fired when the session is about to time out.

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

ThemeChanged

EventHandler Fired when the current theme is changed.

ThreadException

ThreadExceptionEventHandler Fired when a thread exception is thrown.

Implements

Name

Description

All wisej components implement this interface.

Control

Wisej.Web.Control

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Base class for all Wisej controls.

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

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

Constructors

Control()

Initializes a new instance of the Control class.

Properties

AccessibleDescription

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

AccessibleName

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

AccessibleRole

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

AllowDrag

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

AllowDrop

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

Anchor

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.

Anonymous

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

BackColor

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

BackgroundImage

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

BackgroundImageLayout

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

BackgroundImageSource

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

BecomingActiveControl

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

CanExecute

Boolean: Determines whether the control can execute a command.

CanFocus

Boolean: Returns whether the control can receive focus.

CausesValidation

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

ClientEvents

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

ContainsFocus

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

ContextMenu

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

Controls

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

CssClass

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

CssStyle

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

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

DataBindings

ControlBindingsCollection: Returns the data bindings for the control.

DefaultBackColor

Color: Returns the default background color of the control.

DefaultFont

Font: Returns the default font of the control.

DefaultForeColor

Color: Returns the default background color of the control.

DisplayRectangle

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

Dock

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

Enabled

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

EnableNativeContextMenu

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

Focusable

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

Focused

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

Font

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

ForeColor

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

Handle

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

HasDataBindings

Boolean: Returns whether the control specifies data bindings.

HasResponsiveProfiles

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

HasUserData

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

Height

Int32: Returns or sets the height of the control.

InitScript

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

IsHandleCreated

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

IsMirrored

Boolean: Returns whether the control is mirrored.

LayoutEngine

LayoutEngine: Returns the control's layout engine.

Left

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.

Location

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

Margin

Padding: Returns or sets the space between controls.

MaximumSize

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

MinimumSize

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

ModifierKeys

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

MouseButtons

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

MousePosition

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

Movable

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

Name

String: Gets or sets the name of the control.

Padding

Padding: Returns or sets padding within the control.

Parent

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

PreferredSize

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

ResizableEdges

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

ResponsiveProfiles

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

RightToLeft

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.

ShowLoader

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

Size

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

States

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

TabIndex

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

TabStop

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.

Tag

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

Text

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

ToolTipText

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

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

Top

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.

UserData

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

UseWaitCursor

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

ValidationCancelled

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

Visible

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

WheelDelta

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

Width

Int32: Returns or sets the width of the control.

Methods

AddClientEventListener(name, script)

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

Parameter

Type

Description

name

Name of the client event to attach the listener to.

script

JavaScript code to execute when the event occurs.

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.

AddCssClass(name)

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

Parameter

Type

Description

name

Name of the css class to add.

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

AddState(state)

Adds the specified theme state to the widget.

Parameter

Type

Description

state

Name of the custom state to add 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.

BeginInvoke(method, args)

Executes the specified delegate asynchronously.

Type

Description

function

The name of the JavaScript function to execute.

args

The arguments to pass to the function.

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

CenterToParent()

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

CenterToParent(horizontal, vertical)

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

Parameter

Type

Description

horizontal

Center horizontally.

vertical

Center vertically.

Contains(control)

Type

Description

data

The data to drag.

allowedEffects

One of the values.

image

An to use as the drag cursor.

imageSize

The size of the drag image specified in image.

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

Eval(javaScript)

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

Parameter

Type

Description

javaScript

The JavaScript code to run on the client.

Eval(javaScript, callback)

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

Parameter

Type

Description

javaScript

The JavaScript code to evaluate on the client.

callback

Asynchronous callback method that receives the return value.

EvalAsync(javaScript)

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.

Parameter

Type

Description

javaScript

The JavaScript code to evaluate on the client.

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

FindForm()

Retrieves the form that the control is on.

Returns: Form.

FindPage()

Retrieves the page that the control is on.

Returns: Page.

Focus()

Sets input focus to the control.

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

GetChildAtPoint(pt, skipValue)

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

Parameter

Type

Description

A that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.

skipValue

One of the values of , determining whether to ignore child controls of a certain type.

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

GetChildAtPoint(pt)

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

Parameter

Type

Description

A that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.

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

GetClientEventListener(id)

Returns the script associated to the listener identified by id .

Parameter

Type

Description

Id of the listener to retrieve the script for.

Returns: String. JavaScript associated with the listener.

GetClientEventListener(name)

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

Parameter

Type

Description

name

Name of the event.

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

GetContainerControl()

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

Returns: IContainerControl. The parent IContainerControl.

GetNextControl(control, forward)

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

Parameter

Type

Description

control

The to start the search with.

forward

true to search forward in the tab order; false to search backward.

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

GetStyle(flag)

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

Parameter

Type

Description

flag

The bit to return the value from.

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

HasClientEventListener(name)

Checks whether the specified event name has any listener attached.

Parameter

Type

Description

name

Name of the client event to verify.

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

HasCssClass(name)

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

Parameter

Type

Description

name

Css class name to verify.

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

HasState(state)

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

Parameter

Type

Description

state

Name of the state to check.

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

Hide()

Conceals the control from the user.

Invalidate()

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.

Invalidate(invalidateChildren)

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

invalidateChildren

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

Parameter

Type

Description

point

The screen coordinate to convert.

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

PointToScreen(point)

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

Parameter

Type

Description

point

The client coordinate to convert.

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

RectangleToClient(rect)

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

Parameter

Type

Description

rect

The screen coordinate to convert.

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

RectangleToScreen(rect)

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

Parameter

Type

Removes all the listeners attached to the event name .

Parameter

Type

Description

name

Name of the event.

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

RemoveCssClass(name)

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

Parameter

Type

Description

name

The css class name to remove.

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

RemoveState(state)

Removes the specified theme state from the widget.

Parameter

Type

Description

state

Name of the state to remove.

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.

ResetBindings()

Description

control

The at which to start the search.

forward

true to move forward in the tab order; false to move backward in the tab order.

tabStopOnly

true to ignore the controls with the property set to false; otherwise, false.

nested

true to include nested (children of child controls) child controls; otherwise, false.

wrap

true to continue searching from the first control in the tab order after the last control has been reached; otherwise, false.

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

SendToBack()

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

SetBounds(x, y, width, height)

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

Parameter

Type

Description

The new property value of the control.

width

The new property value of the control.

height

The new property value of the control.

SetBounds(x, y, width, height, specified)

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

Parameter

Type

Description

The new property value of the control.

width

The new property value of the control.

height

The new property value of the control.

specified

A bitwise combination of the values. For any parameter not specified, the current value will be used.

Show()

Displays the control to the user.

SuspendLayout()

Suspends the layout logic for the control.

Update()

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.

ValidateChildren()

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.

ValidateChildren(flags)

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

flags

Returns: Boolean.

Events

Appear

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.

AutoSizeChanged

EventHandler Fired when the AutoSize property value changes.

BackColorChanged

EventHandler Fired when the value of the BackColor property changes.

BackgroundImageChanged

EventHandler Fired when the value of the BackgroundImage property changes.

BackgroundImageLayoutChanged

EventHandler Fired when the BackgroundImageLayout property changes.

BindingContextChanged

EventHandler Occurs when the value of the BindingContext property changes.

CausesValidationChanged

EventHandler Fired when the value of the CausesValidation property changes.

Click

EventHandler Fired when the control is clicked.

ClientSizeChanged

EventHandler Fired when the ClientSize property value changes.

ContextMenuChanged

EventHandler Fired when the value of the ContextMenu property changes.

ControlCreated

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

CursorChanged

EventHandler Fired when the value of the Cursor property changes.

Disappear

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

Disposed

EventHandler Fired when the component is disposed.

DockChanged

EventHandler Fired when the value of the Dock property changes.

DoubleClick

EventHandler Fired when the control is double-clicked.

DragDrop

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.

DragEnd

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

DragEnter

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

DragLeave

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

DragOver

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

DragStart

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

EnabledChanged

EventHandler Fired when the Enabled property value has changed.

EndMove

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.

EndResize

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.

Enter

EventHandler Fired when the control gains the input focus.

FontChanged

EventHandler Fired when the Font property value changes.

ForeColorChanged

EventHandler Fired when the ForeColor property value changes.

HelpRequested

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

ImeModeChanged

EventHandler Fired when the ImeMode property has changed.

KeyDown

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

KeyPress

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

KeyUp

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

Layout

LayoutEventHandler Fired when a control should reposition its child controls.

Leave

EventHandler Fired when the control loses the input focus.

LocationChanged

EventHandler Fired when the Location property value has changed.

LongTap

EventHandler Fired when a pointer holds on the screen.

MarginChanged

EventHandler Fired when the control's margin changes.

MouseCaptureChanged

EventHandler Fired when the control loses mouse capture.

MouseClick

MouseEventHandler Fired when the control is clicked by the mouse.

MouseDoubleClick

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

MouseDown

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

MouseEnter

EventHandler Fired when the mouse pointer enters the control.

MouseHover

EventHandler Fired when the mouse pointer rests on the control.

MouseLeave

EventHandler Fired when the mouse pointer leaves the control.

MouseMove

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

MouseUp

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

MouseWheel

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

PaddingChanged

EventHandler Fired when the control's padding changes.

Paint

PaintEventHandler Fired when a UserPaint control needs to redraw itself.

ParentChanged

EventHandler Fired when the Parent property value changes.

Pinch

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

PreviewKeyDown

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

QueryContinueDrag

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

Resize

EventHandler Fired when the control is resized.

ResponsiveProfileChanged

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

RightToLeftChanged

EventHandler Fired when the RightToLeft property value changes.

Rotate

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

SizeChanged

EventHandler Fired when the Size property value changes.

StartMove

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.

StartResize

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.

StyleChanged

EventHandler Fired when the control style changed.

Swipe

SwipeEventHandler Fired when a pointer swipes over the screen.

TabIndexChanged

EventHandler Fired when the TabIndex property value has changed.

TabStopChanged

EventHandler Fired when the value of the TabStop property changes.

Tap

EventHandler Fired when a pointer taps on the screen.

TextChanged

EventHandler Fired when the Text property value changes.

TouchCancel

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

TouchEnd

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

TouchMove

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

TouchStart

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

Track

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

Validated

EventHandler Fired when the control is finished validating.

Validating

CancelEventHandler Fired when the control is validating.

VisibleChanged

EventHandler Fired when the Visible property value changes.

WidgetEvent

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

Name

Description

UI implementation for the FileDialog class.

UI implementation for the FolderDialog class.

Displays data in a customizable list format.

Used by the control to display data at run time.

Represents a shape control. Displays an element a border in any of the four sides.

Represents a panel that dynamically arranges its child controls.

Represents a spinner control that displays values.

Represents a spacer control. It can be used to add a space between controls in a layout panel. It is not rendered on the client.

Represents a data field that displays a list of selectable and removable tags. The control recognizes tags as the user types and adds in front of the editable field.

Displays child controls vertically or horizontally in a scrollable container.

Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.

Represents a button control.

Implements the basic functionality common to button controls.

Represents a check box control.

Displays a in which a check box is displayed to the left of each item.

Represents a combo box control.

Provides focus-management functionality for controls that can function as a container for other controls.

Represents a control that allows the user to select or type a date and a time.

Represents a spinner control that displays string values.

Represents a panel that dynamically arranges its children horizontally or vertically in automatic rows or columns.

Represents a window or dialog box that makes up an application's user interface.

Represents a Wisej control that displays a frame around a group of controls with an optional caption.

Represents a label control.

Represents an hyper-link control.

Represents a control to display a list of items.

Provides a common implementation of members for the and classes.

Uses a mask to distinguish between proper and improper user input.

Represents the container for multiple-document interface (MDI) child forms.

Represents a control that enables the user to select a date using a visual monthly calendar display.

Represents a spinner control that displays numeric values.

Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.

Represents a collapsible panel with an optional header that contains a group of controls.

Represents an image control.

Represents a progress control that displays a value visually as a filled bar.

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

Defines a base class for controls that support auto-scrolling behavior.

Represents an horizontal scroll bar.

Represents a vertical scroll bar.

Implements the basic functionality of a scroll bar control.

Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.

Creates a panel that is associated with a .

Displays information to the user in a about the object being viewed, the object's components, or the object's operation.

Manages a related set of pages.

Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.

Represents a single tab page in a .

Represents a text box control that allows the user to enter any value.

Implements the basic functionality required by text controls.

Enables the user to choose between a range of values by sliding a small bar along another bar.

Implements the basic functionality required by a spin box (also known as an up-down control).

Provides an empty control that can be used to create other controls.

Represents a web browser control that enables the user to navigate web pages inside a form or a page.

Represents a control that can be hosted in a .

Represents a control that can be hosted in a cell.

Represents a control that can be hosted in a .

Represents a control that can be hosted in a cell when the cell's is set to .

Represents a data grid control.

Represents a desktop container that can host floating windows.

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

Represents a panel in a control.

Represents a control that can host ASP.NET or MVC pages within a Wisej application.

Represents the HTML5 canvas element.

Represents a control that can display flash applications.

Represents a control that displays any HTML file and a corresponding CSS style sheet as embedded HTML.

Represents a control that displays any HTML file in an IFrame element.

Represents a line control.

The TreeViewComboBox control represents a control with a as the drop down panel.

Base implementation for media controls.

Represents a control that displays a video file.

Represents a control that plays an audio file.

Represents a control that can display a pdf document in the browser either using the native pdf viewer, the pdf.js viewer, Google docs, or a custom viewer.

Represents a split button control.

The TreeViewComboBox control represents a control with a as the drop down panel.

Represent an upload widget. Allows users to selected one or more files and upload them to the server.

The UserComboBox control represents a control with a custom panel that drops down when the user clicks the down arrow.

Provides an popup container that can be attached to other controls.

Provides a generic widget that can use most third party javascript widgets.

Represents a list view control, which displays a collection of items that can be displayed using one of four different views.

Represents a menu bar component.

Provides a user interface for browsing the properties of an object.

Represents a toolbar component.

Displays a hierarchical collection of labeled items, each represented by a .

Implements

Name

Description

Bindable components implement this interface.

All wisej components implement this interface.

All wisej controls derived from the class must implement this interface.

Allows an object to serialize itself.