All pages
Powered by GitBook
1 of 53

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

General

Application.FormCollection

Wisej.Web.Application FormCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Holds the collection of all top-level application forms.

public class FormCollection : ICollection, IEnumerable
Public Class FormCollection
    Inherits ICollection
    Implements IEnumerable

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.5.0.0)

Holds the collection of all top-level application pages.

Properties

Int32
Form
Form
IEnumerator
Count

Int32: Returns the total number of currently open pages.

Item(index)

Page: Returns the page at the specified index.

Item(name)

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

Methods

GetEnumerator()

Returns an enumerator that iterates through the open pages.

Returns: IEnumerator.

Public Class PageCollection
    Inherits ICollection
    Implements IEnumerable
public class PageCollection : ICollection, IEnumerable

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

HashChangedEventArgs(value)

Initializes a new instance of the HashChangedEventArgs class.

Name
Type
Description

value

Initial hash value.

Properties

Hash

String: The hash string from the client.

Used By

Name
Description

Represents the method that will handle the event.

Represents the method that will handle the event.

HashChanged
Public Class HashChangedEventArgs
    Inherits EventArgs
public class HashChangedEventArgs : EventArgs
String
HashChangedEventHandler
HashChanged
LicenseErrorEventHandler
LicenseError

HelpEventHandler

Wisej.Web.HelpEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

public delegate void HelpEventHandler(Object sender, HelpEventArgs hlpevent)
Public Delegate Sub HelpEventHandler(ByVal sender As [Object], ByVal hlpevent As HelpEventArgs)

Parameters

Name
Type
Description

Fired By

Name
Description

ControlEventArgs

Wisej.Web.ControlEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.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 class for the specified control.

Name
Type
Description

Properties

Control

: Returns the control object used by this event.

Used By

Name
Description

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the ResponsiveProfileChanged event.

public class ResponsiveProfileChangedEventArgs : EventArgs
Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs

Constructors

ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the class.

Name
Type
Description

Properties

CurrentProfile

: The new active profile.

PreviousProfile

: The previously active profile.

Used By

Name
Description

PinchEventHandler

Wisej.Web.PinchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the Pinch event.

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

Parameters

Name
Type
Description

Fired By

Name
Description

LicenseErrorEventArgs

Wisej.Web.LicenseErrorEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the LicenseError event.

public class LicenseErrorEventArgs : EventArgs
Public Class LicenseErrorEventArgs
    Inherits EventArgs

Constructors

LicenseErrorEventArgs(error)

Initializes a new instance of the class.

Name
Type
Description

Properties

Error

: Indicates the type of license error that has occurred.

RotateEventArgs

Wisej.Web.RotateEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for Rotate event.

public class RotateEventArgs : EventArgs
Public Class RotateEventArgs
    Inherits EventArgs

Properties

Angle

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

Used By

Name
Description

TrackEventHandler

Wisej.Web.TrackEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the Track event.

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

Parameters

Name
Type
Description

Fired By

Name
Description

PinchEventArgs

Wisej.Web.PinchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for Pinch event.

public class PinchEventArgs : EventArgs
Public Class PinchEventArgs
    Inherits EventArgs

Properties

Scale

: Returns the calculated scale factor.

Used By

Name
Description

LicenseErrorEventHandler

Wisej.Web.LicenseErrorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the LicenseError event.

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

Parameters

Name
Type
Description

Fired By

Name
Description

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

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

Fired By

Name
Description

ControlEventHandler

Wisej.Web.ControlEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

KeyPressEventHandler

Wisej.Web.KeyPressEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the event of a .

DragEventHandler

Wisej.Web.DragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

LayoutEventHandler

Wisej.Web.LayoutEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the event of a .

KeyPressEventArgs

Wisej.Web.KeyPressEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

HelpEventArgs

Wisej.Web.HelpEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

PreviewKeyDownEventHandler

Wisej.Web.PreviewKeyDownEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the event.

Parameters

SwipeEventArgs

Wisej.Web.SwipeEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for event.

Properties

KeyEventHandler

Wisej.Web.KeyEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

TouchEventArgs

Wisej.Web.TouchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for event.

Properties

Screen

Wisej.Web.Screen

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the display on the client device.

Properties

sender

Object

The source of the event.

hlpevent

HelpEventArgs

A HelpEventArgs object that contains the event data.

Control.HelpRequested

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

sender

Object

The source of the event.

e

PinchEventArgs

A PinchEventArgs that contains the event data.

Control.Pinch

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

sender

Object

The source of the event.

e

TrackEventArgs

A TrackEventArgs that contains the event data.

Control.Track

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

sender

Object

The source of the event.

e

HashChangedEventArgs

A LicenseErrorEventArgs that contains the event data.

Application.LicenseError

Fired when a license error occurs.

sender

Object

The source of the event.

e

HashChangedEventArgs

A HashChangedEventArgs that contains the event data.

Application.HashChanged

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

control

Control

The Control to store in this event.

ControlEventHandler

Represents the method that will handle the ControlAdded and ControlRemoved events of the Control class.

ControlEventArgs
Control

oldValue

ClientProfile

Previous ClientProfile.

newValue

ClientProfile

New active ClientProfile.

ResponsiveProfileChangedEventHandler

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

ResponsiveProfileChangedEventArgs
ClientProfile
ClientProfile

error

String

License error.

LicenseErrorEventArgs
String

RotateEventHandler

Represents the method that will handle the Rotate event.

Double

PinchEventHandler

Represents the method that will handle the Pinch event.

Double
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

Fired when a new control is added to the .

Fired when a control is removed from the .

Fired when a multiple-document interface (MDI) child form is added to the mdi parent.

Fired when a multiple-document interface (MDI) child form is removed from the mdi parent.

ControlAdded
ControlRemoved
Control
Public Delegate Sub ControlEventHandler(ByVal sender As [Object], ByVal e As ControlEventArgs)
public delegate void ControlEventHandler(Object sender, ControlEventArgs e)
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

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

KeyPress
Control
Public Delegate Sub KeyPressEventHandler(ByVal sender As [Object], ByVal e As KeyPressEventArgs)
public delegate void KeyPressEventHandler(Object sender, KeyPressEventArgs e)
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

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

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

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

DragDrop
DragEnter
DragOver
Control
Public Delegate Sub DragEventHandler(ByVal sender As [Object], ByVal e As DragEventArgs)
public delegate void DragEventHandler(Object sender, DragEventArgs e)
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

Fired when a control should reposition its child controls.

Layout
Control
Public Delegate Sub LayoutEventHandler(ByVal sender As [Object], ByVal e As LayoutEventArgs)
public delegate void LayoutEventHandler(Object sender, LayoutEventArgs e)
KeyPressEventArgs(keyChar)

Initializes a new instance of the KeyPressEventArgs class.

Name
Type
Description

keyChar

The ASCII character corresponding to the key the user pressed.

Properties

Handled

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

KeyChar

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

Used By

Name
Description

Represents the method that will handle the event of a .

KeyPress
Public Class KeyPressEventArgs
    Inherits EventArgs
public class KeyPressEventArgs : EventArgs
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 .

HelpRequested
Public Class HelpEventArgs
    Inherits EventArgs
public class HelpEventArgs : EventArgs
Name
Type
Description

sender

The source of the event.

e

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.

PreviewKeyDown
Public Delegate Sub PreviewKeyDownEventHandler(ByVal sender As [Object], ByVal e As PreviewKeyDownEventArgs)
public delegate void PreviewKeyDownEventHandler(Object sender, PreviewKeyDownEventArgs e)
Axis

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

Direction

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

Distance

Int32: Returns the distance of the performed swipe.

Duration

Int32: Returns the duration the performed swipe took.

StartTime

Int64: Returns the start time of the performed swipe.

Velocity

Double: Returns the velocity of the performed swipe.

Used By

Name
Description

Represents the method that will handle the event.

Swipe
Public Class SwipeEventArgs
    Inherits EventArgs
public class SwipeEventArgs : EventArgs
Parameters
Name
Type
Description

sender

The source of the event.

e

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.

KeyUp
KeyDown
Control
Public Delegate Sub KeyEventHandler(ByVal sender As [Object], ByVal e As KeyEventArgs)
public delegate void KeyEventHandler(Object sender, KeyEventArgs e)
Identifiers

Int64[]: Returns the unique identifiers for the touch items.

IsMultiTouch

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

Locations

Point[]: Returns the location of the touch items in screen coordinates.

Rotation

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

Scale

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

Used By

Name
Description

Represents the method that will handle the , , , events.

Swipe
Public Class TouchEventArgs
    Inherits EventArgs
public class TouchEventArgs : EventArgs
Bounds

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

DeviceName

String: Returns the device name associated with a display.

WorkingArea

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

Public Class Screen
public class Screen

PreviewKeyDownEventArgs

Wisej.Web.PreviewKeyDownEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the PreviewKeyDown event.

public class PreviewKeyDownEventArgs : EventArgs
Public Class PreviewKeyDownEventArgs
    Inherits EventArgs

Constructors

PreviewKeyDownEventArgs(keyData)

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

Name
Type
Description

Properties

Alt

: Returns whether the ALT key was pressed.

Control

: Returns whether the CTRL key was pressed.

IsInputKey

: Returns whether a key is a regular input key.

KeyCode

: Returns the keyboard code.

KeyData

: Returns the key data.

KeyValue

: Returns the keyboard value.

Modifiers

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

Shift

: Returns whether the SHIFT key was pressed.

Used By

Name
Description

PaintEventHandler

Wisej.Web.PaintEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

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

Parameters

Name
Type
Description

Fired By

Name
Description

QueryContinueDragEventHandler

Wisej.Web.QueryContinueDragEventHandler

Namespace: Wisej.Web

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

Fired By

Name
Description

TrackEventArgs

Wisej.Web.TrackEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for Track event.

public class TrackEventArgs : EventArgs
Public Class TrackEventArgs
    Inherits EventArgs

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

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

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

Parameters

Name
Type
Description

Fired By

Name
Description

RotateEventHandler

Wisej.Web.RotateEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the Rotate event.

public delegate void RotateEventHandler(Object sender, RotateEventArgs e)
Public Delegate Sub RotateEventHandler(ByVal sender As [Object], ByVal e As RotateEventArgs)

Parameters

Name
Type
Description

Fired By

Name
Description

QueryContinueDragEventArgs

Wisej.Web.QueryContinueDragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the QueryContinueDrag event.

public class QueryContinueDragEventArgs : EventArgs
Public Class QueryContinueDragEventArgs
    Inherits EventArgs

Constructors

QueryContinueDragEventArgs(args)

Initializes a new instance of the 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

SwipeEventHandler

Wisej.Web.SwipeEventHandler

Namespace: Wisej.Web

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

Fired By

Name
Description

PaintEventArgs

Wisej.Web.PaintEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

LayoutEventArgs

Wisej.Web.LayoutEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

TouchEventHandler

Wisej.Web.TouchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the , , , events.

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

Parameters

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

WidgetEventHandler

Wisej.Web.WidgetEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that handles the event.

Parameters

sender

Object

The source of the event.

e

PaintEventArgs

A PaintEventArgs that contains the event data.

Control.Paint

Fired when a UserPaint control needs to redraw itself.

sender

Object

The source of an event.

e

QueryContinueDragEventArgs

A QueryContinueDragEventArgs that contains the event data.

Control.QueryContinueDrag

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

sender

Object

The source of the event.

e

ResponsiveProfileChangedEventArgs

A ResponsiveProfileChangedEventArgs that contains the event data.

Control.ResponsiveProfileChanged

Fired when the active responsive profile is changed.

Application.ResponsiveProfileChanged

Fired when the active responsive profile is changed.

sender

Object

The source of the event.

e

RotateEventArgs

A RotateEventArgs that contains the event data.

Control.Rotate

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

sender

Object

The source of the event.

e

SwipeEventArgs

A SwipeEventArgs that contains the event data.

Control.Swipe

Fired when a pointer swipes over the screen.

Object
ControlEventArgs
ControlEventArgs
Control.ControlAdded
ControlCollection
Control.ControlRemoved
ControlCollection
Form.MdiChildAdded
Form.MdiChildRemoved
Object
KeyPressEventArgs
KeyPressEventArgs
Control.KeyPress
Object
DragEventArgs
DragEventArgs
Control.DragDrop
Control.DragEnter
Control.DragOver
Object
LayoutEventArgs
LayoutEventArgs
Control.Layout
Object
PreviewKeyDownEventArgs
PreviewKeyDownEventArgs
Control.PreviewKeyDown
KeyDown
Object
KeyEventArgs
KeyEventArgs
Control.KeyDown
Control.KeyUp

keyData

Keys

One of the Keys values.

PreviewKeyDownEventHandler

Represents the method that will handle the PreviewKeyDown event.

PreviewKeyDownEventArgs
Boolean
Boolean
Boolean
Keys
Keys
Int32
Keys
Boolean

TrackEventHandler

Represents the method that will handle the Track event.

SwipeAxis
Point
Int32
Int32

args

WisejEventArgs

The arguments received from the client.

QueryContinueDragEventHandler

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

QueryContinueDragEventArgs
DragAction
Boolean
Int32
Char
KeyPressEventHandler
KeyPress
Control
Control
Control
HelpEventHandler
HelpRequested
Control
SwipeEventHandler
Swipe
TouchEventHandler
TouchStart
TouchEnd
TouchMove
TouchCancel
PaintEventArgs(graphics, clipRect)

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

Name
Type
Description

graphics

The used to paint the item.

clipRect

The that represents the rectangle in which to paint.

Properties

ClipRectangle

Rectangle: Returns the rectangle in which to paint.

Graphics

Graphics: Returns the graphics used to paint.

Used By

Name
Description

Represents the method that will handle the event of a .

Paint
Public Class PaintEventArgs
    Inherits EventArgs
public class PaintEventArgs : EventArgs
LayoutEventArgs(affectedComponent, affectedProperty)

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

Name
Type
Description

affectedComponent

The affected by the layout change.

affectedProperty

The property affected by the layout change.

LayoutEventArgs(affectedControl, affectedProperty)

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

Name
Type
Description

affectedControl

The affected by the layout change.

affectedProperty

The property affected by the layout change.

Properties

AffectedComponent

IComponent: Returns the IComponent affected by the layout change.

AffectedControl

Control: Returns the child control affected by the change.

AffectedProperty

String: Returns the property affected by the change.

Used By

Name
Description

Represents the method that will handle the event of a .

Layout
Public Class LayoutEventArgs
    Inherits EventArgs
public class LayoutEventArgs : EventArgs
Parameters
Name
Type
Description

sender

The source of the event.

e

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.

TouchStart
TouchEnd
TouchMove
TouchCancel
Public Delegate Sub TouchEventHandler(ByVal sender As [Object], ByVal e As TouchEventArgs)
public delegate void TouchEventHandler(Object sender, TouchEventArgs e)
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

Fired when the active responsive profile is changed.

Fired when the active responsive profile is changed.

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

ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the ResponsiveProfileChangedEventArgs class.

Name
Type
Description

oldValue

Previous .

newValue

New active .

Properties

CurrentProfile

ClientProfile: The new active profile.

PreviousProfile

ClientProfile: The previously active profile.

Used By

Name
Description

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

ResponsiveProfileChanged
Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs
public class ResponsiveProfileChangedEventArgs : EventArgs
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

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

WidgetEvent
Public Delegate Sub WidgetEventHandler(ByVal sender As [Object], ByVal e As WidgetEventArgs)
public delegate void WidgetEventHandler(Object sender, WidgetEventArgs e)

KeyEventArgs

Wisej.Web.KeyEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the KeyDown or KeyUp event.

public class KeyEventArgs : EventArgs
Public Class KeyEventArgs
    Inherits EventArgs

Constructors

KeyEventArgs(keyData)

Initializes a new instance of the class.

Name
Type
Description

Properties

Alt

: Returns whether the ALT key was pressed.

Control

: Returns whether the CTRL key was pressed.

Handled

: Returns or sets whether the event was handled.

KeyCode

: Returns the keyboard code..

KeyData

: Returns the key data.

KeyValue

: Returns the keyboard value.

Modifiers

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

Shift

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

Methods

IsAltPressed()

Returns whether the Alt key is pressed.

Returns: .

IsCtrlPressed()

Returns whether the Control key is pressed.

Returns: .

IsShiftPressed()

Returns whether the Shift key is pressed.

Returns: .

Used By

Name
Description

MouseEventHandler

Wisej.Web.MouseEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

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

Parameters

Name
Type
Description

Fired By

Name
Description
Object
TouchEventArgs
TouchEventArgs
Control.TouchStart
Control.TouchEnd
Control.TouchCancel
Control.TouchMove
Object
ResponsiveProfileChangedEventArgs
ResponsiveProfileChangedEventArgs
Control.ResponsiveProfileChanged
Application.ResponsiveProfileChanged
Object
WidgetEventArgs
WidgetEventArgs
Control.WidgetEvent

keyData

Keys

A Keys representing the key that was pressed, combined with any modifier flags that indicate which CTRL, SHIFT, and ALT keys were pressed at the same time. Possible values are obtained be applying the bitwise OR (|) operator to constants from the Keys enumeration.

KeyEventHandler

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

KeyEventArgs
Boolean
Boolean
Boolean
Keys
Keys
Int32
Keys
Boolean
Boolean
Boolean
Boolean
Graphics
Graphics
Rectangle
Rectangle
PaintEventHandler
Paint
Control
IComponent
IComponent
String
Control
Control
String
LayoutEventHandler
Layout
Control
ClientProfile
ClientProfile
ClientProfile
ClientProfile
ResponsiveProfileChangedEventHandler

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

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

sender

Object

The source of the event.

e

MouseEventArgs

A MouseEventArgs that contains the event data.

CheckedListBox.MouseClick

Fired when the user clicks the CheckedListBox control with the mouse.

Control.MouseClick

Fired when the control is clicked by the mouse.

Control.MouseDoubleClick

Fired when the control is double clicked by the mouse.

Control.MouseDown

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

Control.MouseMove

Fired when the mouse pointer is moved over the control.

Cursor

Wisej.Web.Cursor

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the mouse pointer.

public class Cursor
Public Class Cursor

Constructors

Cursor(image)

Creates a new cursor using the .

Name
Type
Description

Cursor(source)

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

Name
Type
Description

Cursor(stream)

Creates a new cursor using the .

Name
Type
Description

Cursor(image, x, y)

Creates a new cursor using the .

Name
Type
Description

Cursor(stream, x, y)

Creates a new cursor using the .

Name
Type
Description

Cursor(source, x, y)

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

Name
Type
Description

Properties

Name

: Returns the name of the cursor.

Position

: Returns or sets the pointer's position.

MouseEventArgs

Wisej.Web.MouseEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the , , and events.

Control.MouseUp
Control.MouseWheel

image

Image

An Image to use for the cursor.

source

String

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

stream

Stream

A Stream to use for the cursor.

image

Image

An Image to use for the cursor.

x

Int32

x-coordinate of the hotspot location.

y

Int32

y-coordinate of the hotspot location.

stream

Stream

A Stream to use for the cursor.

x

Int32

x-coordinate of the hotspot location.

y

Int32

y-coordinate of the hotspot location.

source

String

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

x

Int32

x-coordinate of the hotspot location.

y

Int32

y-coordinate of the hotspot location.

Image
Image
Image
Image
String
Point
Constructors

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

Initializes a new instance of the MouseEventArgs class.

Name
Type
Description

button

One of the values that indicate which mouse button was pressed.

clicks

The number of times a mouse button was pressed.

x

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

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

Initializes a new instance of the MouseEventArgs class.

Name
Type
Description

button

One of the values that indicate which mouse button was pressed.

clicks

The number of times a mouse button was pressed.

x

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

Properties

Button

MouseButtons: Returns which mouse button was pressed.

Clicks

Int32: Returns the number of clicks or taps.

Delta

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

Location

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

OriginalTarget

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

Role

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

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

X

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

Y

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

Used By

Name
Description

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

MouseUp
MouseDown
MouseMove
Public Class MouseEventArgs
    Inherits EventArgs
public class MouseEventArgs : EventArgs

Cursors

Wisej.Web.Cursors

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Defines a collection of predefined Cursor objects.

public class Cursors
Public Class Cursors

Properties

Alias

: Returns the "shortcut" cursor.

Arrow

: Returns the "arrow" cursor.

Cell

: Returns "cell" cursor.

Copy

: Returns the clipboard "copy" cursor.

Cross

: Returns the "crosshair" cursor.

Default

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

Grab

: Returns the "grab" cursor.

Hand

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

Help

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

HSplit

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

IBeam

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

Move

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

No

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

None

: Returns the "none" cursor.

NotAllowed

: Returns the "not-allowed" cursor.

SizeAll

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

SizeNE

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

SizeNESW

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

SizeNS

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

SizeNW

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

SizeNWSE

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

SizeSE

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

SizeSW

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

SizeWE

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

Text

: Returns the "text" cursor.

VSplit

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

WaitCursor

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

ZoomIn

: Returns the "zoom-in" cursor.

ZoomOut

: Returns the "zoom-out" cursor.

WidgetEventArgs

Wisej.Web.WidgetEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the WidgetEvent event.

public class WidgetEventArgs : EventArgs
Public Class WidgetEventArgs
    Inherits EventArgs

Constructors

WidgetEventArgs(type, data)

Initializes a new instance of the 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

DragEventArgs

Wisej.Web.DragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the , , or event.

Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor
Cursor

type

String

The type (name) of event.

data

Object

The data object received with the event.

WidgetEventHandler

Represents the method that handles the WidgetEvent event.

WidgetEventArgs
Object
String

y

Int32

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

delta

Int32

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

y

Int32

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

delta

Int32

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

role

String

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

MouseButtons
MouseButtons
Int32
Int32
MouseButtons
MouseButtons
Int32
Int32
MouseEventHandler
Constructors

DragEventArgs(allowedEffect, effect, data, location)

Initializes a new instance of the DragEventArgs class.

Name
Type
Description

allowedEffect

One of the values.

effect

One of the values.

data

The data associated with this event.

Properties

AllowedEffect

DragDropEffects: Returns which drag-and-drop operations are allowed by the originator (or source) of the drag event.

AllowedFileTypes

String: Specify the types of files that the server accepts (that can be submitted through a file upload).

The allowed files string follows the HTML 4.01 and HTML5 specifications. You can configure only one entry in the browser's file dialog. The syntax is "file_extension|audio/|video/|image/*|media_type". Look at IANA Media Types for a complete list of standard media types.

Data

IDataObject: Returns the IDataObject that contains the data associated with this event.

DragSource

Control: Returns the component that started the drag operation by calling DoDragDrop. [Since 2.5.32]

DropTarget

Object: Returns the original target of the drag operation.

Effect

DragDropEffects: Returns or sets the target drop effect in a drag-and-drop operation.

Files

HttpFileCollection: Returns the HttpFileCollection containing the files that have been dropped on the target, or null.

Image

Image: Returns or sets the custom image displayed on the client to represent the drag action.

ImageSize

Size: Returns or sets the size in pixels of the custom image displayed on the client to represent the drag action.

ImageSource

String: Returns or sets the custom image source displayed on the client to represent the drag action.

KeyState

Int32: Returns the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons.

Location

Point: Returns the location of the mouse or pointer event, in screen coordinates.

X

Int32: Returns the x-coordinate of the mouse or pointer, in screen coordinates.

Y

Int32: Returns the y-coordinate of the mouse or pointer, in screen coordinates.

Used By

Name
Description

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

DragDrop
DragEnter
DragOver
Public Class DragEventArgs
    Inherits EventArgs
public class DragEventArgs : EventArgs

Component

Wisej.Web.Component

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

  • Component

    • Component

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

Constructors

Component()

Default constructor

Methods

Update()

Updates the component on the client.

Inherited By

Name
Description

Implements

Name
Description

location

Point

The Point that indicates the location of the drag event.

DragDropEffects
DragDropEffects
DragDropEffects
DragDropEffects
Object
DragEventHandler
DragDrop
DragEnter
DragOver
Control

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

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

Allows controls to execute javascript code.

Add rotation capabilities along the X,Y,Z axis to controls.

Adds CSS styling to controls.

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

Provides methods to manage a collection of objects. This class cannot be inherited.

Displays a standard column header in a control.

Displays an image column header in a control.

Represents an individual menu item that is displayed within a or and always shows a checkbox next to the label.

Represents a context menu associated to a .

Represents an individual menu item that is displayed within a or rendered using the link element to let the browser process the specified URL.

Represents the main menu in a .

Represents the base functionality for all menus.

Represents an individual item that is displayed within a or .

Represents a panel in a control that can host any .

Represents a panel in a control.

Represents an item in the .

Timer

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

DesktopTaskBarItem

Represents a component in the Desktop control's taskbar.

DesktopTaskBarItemControl

Represents a component in the Desktop control's taskbar that can host any Control.

DesktopTaskBarItemDateTime

Represents a DateTime component in the Desktop control's taskbar.

Animation

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

IWisejComponent

All wisej components implement this interface.

IWisejSerializable

Allows an object to serialize itself.

Public Class Component
    Inherits Component
    Implements IComponent
public class Component : Component, IComponent

Padding

Wisej.Web.Padding

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

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

public struct Padding : ValueType, IWisejSerializable
Public Structure Padding
    Implements ValueType, IWisejSerializable

Constructors

Padding(left, top, right, bottom)

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

Name
Type
Description

Padding(all)

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

Name
Type
Description

Properties

All

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

Bottom

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

Horizontal

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

IsEmpty

: Returns if the padding is empty.

Left

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

Right

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

Size

: Returns the padding information in the form of a .

Top

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

Vertical

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

Methods

Add(p1, p2)

Computes the sum of the two specified values.

Parameter
Type
Description

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

Subtract(p1, p2)

Subtracts one specified value from another.

Parameter
Type
Description

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

Used By

Name
Description
ErrorProvider
HelpTip
JavaScript
Rotation
Control
StyleSheet
ToolTip
ImageList
Image
ColumnHeader
ListView
ImageColumnHeader
ListView
CheckedMenuItem
MainMenu
ContextMenu
ContextMenu
Control
LinkMenuItem
MainMenu
ContextMenu
HRef
MainMenu
Form
Menu
MenuItem
MainMenu
ContextMenu
StatusBarControl
StatusBar
Control
StatusBarPanel
StatusBar
ToolBarButton
ToolBar

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

Returns or sets the padding inside objects in any mode.

Returns or sets padding within the statusbar panel.

Returns or sets padding within the toolbar button.

Returns or sets the space between toolbar buttons.

Computes the sum of the two specified values.

Returns the size of the inset border and padding.

left

Int32

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

top

Int32

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

right

Int32

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

all

Int32

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

p1

Padding

A Padding.

p2

Padding

A Padding.

p1

Padding

A Padding.

p2

Padding

A Padding.

Control.Padding

Returns or sets padding within the control.

Control.Margin

Returns or sets the space between controls.

DataGridViewCellStyle.Padding

Returns or sets the space between the edge of a DataGridViewCell and its content.

LabelWrapper.Padding

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

UserPopup.Offset

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

Padding
Padding
Int32
Int32
Int32
Boolean
Int32
Int32
Size
Size
Int32
Int32
Padding
Padding
Padding
Padding
Padding
Padding
Padding
Padding

bottom

Int32
ListView.ItemPadding
ListViewItem
View
StatusBarPanel.Padding
ToolBarButton.Padding
ToolBarButton.Margin
Padding.Add
Padding
ClientTheme.GetInsets

Control.ControlCollection

Wisej.Web.Control ControlCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents a collection of Control objects.

public class ControlCollection : ControlCollection, IList<Control>, ICollection<Control>, IEnumerable<Control>, IWisejSynchronized
Public Class ControlCollection
    Inherits ControlCollection
    Implements IList(Of Control), ICollection(Of Control), IEnumerable(Of Control), IWisejSynchronized

Constructors

ControlCollection(owner)

Initializes a new instance of the class.

Name
Type
Description

Properties

IsDisposed

: Returns whether the owner control has already been disposed.

Item(index)

: Returns the at the specified indexed location.

Item(key)

: Returns the with the specified key in the collection.

Owner

: Returns the control that owns this .

Methods

Add(child)

Adds the specified control to the control collection.

Parameter
Type
Description

AddRange(controls)

Adds an array of control objects to the collection.

Parameter
Type
Description

Clear()

Removes all controls from the collection.

Clear(dispose)

Removes and disposes all controls from the collection.

Parameter
Type
Description

Contains(control)

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

Parameter
Type
Description

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

ContainsKey(key)

Determines whether the contains an item with the specified key.

Parameter
Type
Description

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

Find(type, searchAllChildren)

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

Parameter
Type
Description

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

Throws:

  • type is null.

Find(key, searchAllChildren)

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

Parameter
Type
Description

Returns: . Array of controls with the specified name.

Throws:

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

GetChildIndex(child, throwException)

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

Parameter
Type
Description

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

Throws:

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

GetEnumerator()

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

Returns: . An .

IndexOf(control)

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

Parameter
Type
Description

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

IndexOfKey(key)

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

Parameter
Type
Description

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

Remove(child)

Removes the specified control from the control collection.

Parameter
Type
Description

RemoveByKey(key)

Removes the child control with the specified key.

Parameter
Type
Description

SetChildIndex(child, newIndex)

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

Parameter
Type
Description

owner

Control

The Control that owns this collection.

child

Control

The Control to add.

controls

Control[]

An array of Control objects to add to the collection.

dispose

Boolean

Indicates whether the controls removed from the collection should be disposed.

control

Control

The Control to locate in the collection.

key

String

The key to locate in the ControlCollection.

type

Type

The type of the controls to locate in the ControlCollection.

searchAllChildren

Boolean

true to search all child controls; otherwise, false.

key

String

The key to located in the ControlCollection.

searchAllChildren

Boolean

true to search all child controls; otherwise, false.

child

Control

The Control to search for in the control collection.

throwException

Boolean

true to throw an exception if the Control specified in the child parameter is not a control in the ControlCollection; otherwise, false.

control

Control

The Control to locate in the collection.

key

String

The name of the control to search for.

child

Control

The Control to remove.

key

String

The name of the child control to remove.

child

Control

The child control to search for.

newIndex

Int32

The new index value of the control.

ControlCollection
Boolean
Control
Control
Control
Control
Control
ControlCollection
Boolean
Control
ControlCollection
Boolean
ControlCollection
Control[]
ArgumentNullException
Control[]
ArgumentNullException
Int32
Control
ControlCollection
ArgumentException
Control
ControlCollection
ControlCollection
IEnumerator
IEnumerator
Int32
Control
ControlCollection
Int32

Clipboard

Wisej.Web.Clipboard

Namespace: Wisej.Web

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

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

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

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

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

ContainsText()

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

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

ContainsText(format)

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

Parameter
Type
Description

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

GetAudioStream()

Retrieves an audio stream from the Clipboard.

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

GetData(format)

Retrieves data from the Clipboard in the specified format.

Parameter
Type
Description

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

GetDataObject()

Retrieves the data that is currently on the system Clipboard.

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

GetFileDropList()

Retrieves a collection of file names from the Clipboard.

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

GetImage()

Retrieves an image from the Clipboard.

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

GetText()

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

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

GetText(format)

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

Parameter
Type
Description

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

SetAudio(audioBytes)

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

Parameter
Type
Description

Throws:

  • audioBytes is null.

SetAudio(audioStream)

Saves the in the format to the clipboard.

Parameter
Type
Description

Throws:

  • 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

Throws:

  • text is null.

SetData(format, data)

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

Parameter
Type
Description

Throws:

  • data is null.

SetDataObject(data)

Saves the specified data to the clipboard.

Parameter
Type
Description

Throws:

  • The value of data is null.

SetFileDropList(filePaths)

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

Parameter
Type
Description

Throws:

  • filePaths is null.

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

SetImage(image)

Saves the in the format to the clipboard

Parameter
Type
Description

Throws:

  • image is null.

SetText(text)

Saves the text data in the format to the clipboard.

Parameter
Type
Description

Throws:

  • text is null or .

SetText(text, format)

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

Parameter
Type
Description

Throws:

  • text is null.

format

String

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

format

TextDataFormat

One of the TextDataFormat values.

format

String

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

format

TextDataFormat

One of the TextDataFormat values.

audioBytes

Byte[]

A Byte array containing the audio data.

audioStream

Stream

A Stream containing the audio data.

text

String

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

format

String

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

data

Object

An Object representing the data to add.

data

Object

The data to place on the Clipboard.

filePaths

StringCollection

A StringCollection containing the file names.

image

Image

The Image to add to the Clipboard.

text

String

The text to add to the Clipboard.

text

String

The text to add to the Clipboard.

format

TextDataFormat

One of the TextDataFormat values.

WaveAudio
Boolean
Boolean
FileDrop
Boolean
Bitmap
Boolean
Text
UnicodeText
Boolean
TextDataFormat
Boolean
Stream
Stream
WaveAudio
Object
Object
IDataObject
IDataObject
StringCollection
StringCollection
FileDrop
Image
Image
Bitmap
Text
UnicodeText
String
Empty
Text
UnicodeText
TextDataFormat
String
Empty
Byte
WaveAudio
Stream
ArgumentNullException
Stream
WaveAudio
ArgumentNullException
ArgumentNullException
ArgumentNullException
ArgumentNullException
FileDrop
ArgumentNullException
ArgumentException
InvalidPathChars
InnerException
ArgumentException
Image
Bitmap
ArgumentNullException
UnicodeText
ArgumentNullException
Empty
TextDataFormat
ArgumentNullException

Application

Wisej.Web.Application

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.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 to store and retrieve session variable. The property is a dynamic object and a , therefore you can access its properties directly or through the indexer.

  • Manage cookies. Use to manage browser's cookies.

  • Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.

  • Read the application's URL. Use , , , and .

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

Properties

ActiveProfile

: Returns or sets the current client responsive profile.

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

Browser

: Returns or sets the client browser information.

ClientFingerprint

Deprecated: Deprecated, please use Application.ClientId instead. : 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.

ClientId

: Returns the current unique client id.

Clients

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

CommonAppDataPath

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

CommonAppDataRegistry

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

CompanyName

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

Configuration

: Returns the current .

Cookies

: Collection of cookies.

Current

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

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

CurrentCulture

: Returns or sets the current for the session.

Desktop

: Returns or sets the current Desktop.

EnableUnloadConfirmation

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

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

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

FavIcon

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

FavIconSource

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

Hash

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

IsAuthenticated

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

IsDisposed

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

IsExpired

: Returns true when the current session has expired.

IsSecure

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

IsTerminated

: Returns true when the current session has been terminated.

IsWebSocket

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

LicenseKey

: Returns or sets the runtime server license key.

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

MainPage

: Returns or sets the current full page window.

OpenForms

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

OpenPages

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

Platform

: The name of the currently loaded platform.

ProductName

: Returns the product name associated with this application.

ProductVersion

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

QueryString

: Returns the parameters used to launch the application.

RightToLeft

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

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

RuntimeMode

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

ServerName

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

ServerPort

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

ServerVariables

: Returns the server variables.

Session

: Provides a generic storage for session-based objects.

SessionCount

: Returns the total number of currently active sessions.

SessionId

: Returns the unique current session ID.

ShowConsole

: Shows or hides the debug console on the browser.

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

ShowLoader

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

StartupPath

: Returns the root path of the web application.

StartupUri

: Returns the URI used to start the application.

StartupUrl

: Returns the URL used to start the application.

Theme

: Returns or sets the current .

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

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

Title

: Returns or sets the page title in the browser.

Uri

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

Url

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

User

: Returns the security information for the current request.

UserAgent

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

UserHostAddress

: Returns the IP host address of the remote client.

UserHostName

: Returns the DNS name of the remote client.

UserIdentity

: Returns the type for the current user.

UserLanguages

: Gets a sorted string array of client language preferences.

Methods

AddEventFilter(filter)

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

Parameter
Type
Description

AddTranslation(text, translation)

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

Parameter
Type
Description

AlertAsync(message)

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

Parameter
Type
Description

Returns: . An awaitable that represents the asynchronous operation.

Call(function, args)

Executes the JavaScript function on the client.

Parameter
Type
Description

Call(function, callback, args)

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

Parameter
Type
Description

CallAsync(function, args)

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

Parameter
Type
Description

Returns: . An awaitable that represents the asynchronous operation.

CancelFullScreen()

Cancels the fullscreen mode.

ConfirmAsync(message)

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

Parameter
Type
Description

Returns: . An awaitable that represents the asynchronous operation.

Download(filePath, fileName)

Downloads the specified file on the client.

Parameter
Type
Description

Download(image, fileName)

Downloads the specified image to the client.

Parameter
Type
Description

Download(stream, fileName)

Downloads the bytes in the stream to the client.

Parameter
Type
Description

DownloadAndOpen(target, filePath, fileName)

Downloads the specified file on the client.

Parameter
Type
Description

DownloadAndOpen(target, image, fileName)

Downloads the specified image to the client.

Parameter
Type
Description

DownloadAndOpen(target, stream, fileName)

Downloads the bytes in the stream to the client.

Parameter
Type
Description

EndPolling()

Stops the polling requests from the client.

Eval(script)

Executes the JavaScript script on the client.

Parameter
Type
Description

Eval(script, callback)

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

Parameter
Type
Description

EvalAsync(script)

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

Parameter
Type
Description

Returns: . An awaitable that represents the asynchronous operation.

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

Returns: . The first qualified by the match expression.

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

FindComponents(match)

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

Parameter
Type
Description

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

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

LoadAssembly(filePath)

Loads an assembly given the file name or path.

Parameter
Type
Description

Returns: . The loaded .

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

LoadComponent(filePath, className)

Creates an instance of the specified component from the assembly.

Parameter
Type
Description

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

LoadPackages(packages, callback)

Parameter
Type
Description

LoadPackagesAsync(packages)

Parameter
Type
Description

Returns: .

LoadTheme(name, mixins)

Changes the current theme.

Parameter
Type
Description

MapPath(path)

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

Parameter
Type
Description

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

Navigate(url, target)

Navigate to the specified URL.

Parameter
Type
Description

Play(type)

Plays one of the built-in sounds

Parameter
Type
Description

Play(soundUrl)

Plays a sound.

Parameter
Type
Description

Post(callback)

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

Parameter
Type
Description

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

Print(window)

Prints the specified window.

Parameter
Type
Description

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

Print()

Prints the entire browser window.

PromptAsync(message, defaultValue)

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

Parameter
Type
Description

Returns: . An awaitable that represents the asynchronous operation.

Reload()

Causes the application to reload on the browser.

RemoveEventFilter(filter)

Removes the filter from the list of registered event filters.

Parameter
Type
Description

RequestFullScreen()

Requests the browser to enable fullscreen mode if supported.

RunInContext(context, action)

Executes the callback in context.

Parameter
Type
Description

SetSessionTimeout(seconds)

Sets the current session timeout in seconds.

Parameter
Type
Description

StartPolling(interval)

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

Parameter
Type
Description

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

Throws:

  • The interval specified is less than 1.

StartTask(action)

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

Parameter
Type
Description

Returns: . An awaitable .

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

StartTask<T>(action)

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

Parameter
Type
Description

Returns: .

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

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

StartTimer(dueTime, period, callback)

Starts a bound to the current session context.

Parameter
Type
Description

Returns: . An instance of .

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

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

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

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

Events

ActiveWindowChanged

Fired when the active window changes.

ApplicationExit

Fired when the application is about to shut down.

ApplicationRefresh

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

ApplicationStart

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

BeforeInstallPrompt

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

BeginRequest

Fired at the beginning of every request.

BrowserSizeChanged

Fired when the user resizes the browser.

BrowserTabActivated

Fired when the user activates the browser tab.

BrowserTabDeactivated

Fired when the user deactivates the browser tab.

CultureChanged

Fired when the changes.

EndRequest

Fired at the end of every request.

FocusedControlChanged

Fired when the focused control changes.

HashChanged

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

Idle

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

LicenseError

Fired when a license error occurs.

ResponsiveProfileChanged

Fired when the active responsive profile is changed.

RightToLeftChanged

Fired when the value changes.

SessionTimeout

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

Fired when the current theme is changed.

ThreadException

Fired when a thread exception is thrown.

Implements

Name
Description

Read the applications's system information. Use StartupPath, ProductName, ProductVersion, etc.

  • Listen to the application's global events. See SessionTimeout , BeginRequest, ApplicationStart, ApplicationExitApplicationRefresh, BrowserSizeChangedResponsiveProfileChanged, 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.

  • filter

    IEventFilter

    An object that implements the IEventFilter interface to add to the filter list.

    text

    String

    The text to translate.

    translation

    String

    The translation override.

    message

    String

    A string you want to display in the alert dialog.

    function

    String

    The name of the function to execute.

    args

    Object[]

    The arguments to pass to the function.

    function

    String

    The name of the function to execute.

    callback

    Action<Object>

    Asynchronous callback method that receives the return value.

    args

    Object[]

    The arguments to pass to the function.

    function

    String

    The name of the function to execute.

    args

    Object[]

    The arguments to pass to the function.

    message

    String

    A string you want to display in the confirm dialog.

    filePath

    String

    The file to download.

    fileName

    String

    The name of the file to save on the client.

    image

    Image

    The image to download.

    fileName

    String

    The name of the file to save on the client.

    stream

    Stream

    The stream to send to the client.

    fileName

    String

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

    target

    String

    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

    String

    The file to download.

    fileName

    String

    The name of the file to save on the client.

    target

    String

    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

    Image

    The image to download.

    fileName

    String

    The name of the file to save on the client.

    target

    String

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

    stream

    Stream

    The stream to send to the client.

    fileName

    String

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

    script

    String

    The script to evaluate.

    script

    String

    The script to evaluate.

    callback

    Action<Object>

    Asynchronous callback method that receives the return value.

    script

    String

    The script to evaluate.

    match

    Predicate<IWisejComponent>

    A custom Predicate expression used to match the IWisejComponent to find.

    match

    Predicate<IWisejComponent>

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

    filePath

    String

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

    filePath

    String

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

    className

    String

    packages

    IEnumerable<Package>

    callback

    Action<Boolean>

    packages

    IEnumerable<Package>

    name

    String

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

    mixins

    String[]

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

    path

    String

    url

    String

    URL to navigate to.

    target

    String

    The target browser window: _self, _blank, etc.

    type

    MessageBoxIcon

    One of MessageBoxIcon value that identifies the sound to play.

    soundUrl

    String

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

    callback

    Action

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

    window

    IWisejWindow

    The window to print

    message

    String

    A string of text to display to the user.

    defaultValue

    String

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

    filter

    IEventFilter

    An object that implements the IEventFilter interface to remove from the filter list.

    context

    IWisejComponent

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

    action

    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.

    seconds

    Int32

    interval

    Int32

    Polling interval in milliseconds. The minimum is 1000ms.

    action

    Action

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

    T

    action

    Func<T>

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

    dueTime

    Int32

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

    period

    Int32

    The time interval between invocations, in milliseconds.

    callback

    Action

    A callback method to invoke at the specified intervals.

    context

    IWisejComponent

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

    action

    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.

    IWisejComponent

    All wisej components implement this interface.

    Session
    Dictionary
    Cookies
    ServerVariables
    ServerPort
    ServerName
    UserAgent
    Uri
    Url
    StartupUri
    StartupUrl
    Application
    docs.wisej
    ClientProfile
    ClientBrowser
    UInt32
    String
    ClientCollection
    String
    RegistryKey
    String
    AssemblyCompanyAttribute
    Configuration
    Configuration
    CookieCollection
    IWisejComponent
    Update
    StartTask
    Current
    Application
    Update
    RunInContext
    Current
    CultureInfo
    CultureInfo
    Desktop
    Boolean
    String
    Image
    String
    String
    Boolean
    Boolean
    Boolean
    Boolean
    Boolean
    Boolean
    String
    LicenseKey
    Page
    FormCollection
    PageCollection
    ClientPlatform
    String
    String
    AssemblyInformationalVersionAttribute
    AssemblyFileVersionAttribute
    NameValueCollection
    Boolean
    Boolean
    String
    Int32
    NameValueCollection
    Object
    Int32
    String
    Boolean
    Boolean
    String
    Uri
    String
    ClientTheme
    ClientTheme
    ClientTheme
    String
    Uri
    Uri
    StartupUri
    String
    StartupUrl
    IPrincipal
    String
    String
    String
    WindowsIdentity
    WindowsIdentity
    String[]
    Task
    Task
    Task
    Task<Object>
    Task
    Task<Boolean>
    Task
    Task
    Task<Object>
    Task
    IWisejComponent
    IWisejComponent
    IList<IWisejComponent>
    IWisejComponent
    Assembly
    Assembly
    IWisejComponent
    IWisejComponent
    Task<Boolean>
    String
    Task<String>
    Task
    IsWebSocket
    EndPolling
    ArgumentOutOfRangeException
    background-tasks
    Task
    Task
    Update
    Timer
    StartPolling
    EndPolling
    background-tasks
    Task<T>
    Update
    StartTask
    Timer
    StartPolling
    EndPolling
    Timer
    Timer
    Timer
    Timer
    system.threading
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    BeforeInstallPromptEvent
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    CurrentCulture
    EventHandler
    EventHandler
    HashChangedEventHandler
    EventHandler
    LicenseErrorEventHandler
    ResponsiveProfileChangedEventHandler
    EventHandler
    RightToLeft
    HandledEventHandler
    EventHandler
    ThreadExceptionEventHandler
        Application.Session.myValue = 12;
        Application.Session["myValue"] = 12;
      
    var current = Application.Current;
    var thread = new Thread(() => {
      Application.Update(current, () => {
      
        // code here is running in context.
        
      });
    });
    static class Program
    {
      static Program()
      {
        Application.LicenseKey = "...";
      }
    }
    // 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;
    
    // 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";
    
      // Find the first component that is a Button with Text = "OK"
      var button = Application.FindComponent(c => c is Button && ((Button)c).Text == "OK");
      // List all text boxes that are read only in all forms.
      var list = Application.FindComponents(c => c is TextBox && ((TextBox)c).ReadOnly);
    
    void Test() {
    
      Application.Post(() => {
        this.listBox.Items.Add("1");
      });
      
      this.listBox.Items.Add("2");
      
      // The items will be added in this order: "2", "1".
    }
    
    
    // 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();
    
    });
    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);
      }
    });
    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);
    
    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);
    
    });
    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);
          }
        });
    
    });

    DataObject

    Wisej.Web.DataObject

    Namespace: Wisej.Web

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

    DataObject(data)

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

    Name
    Type
    Description

    DataObject(format, data)

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

    Name
    Type
    Description

    DataObject(format, data)

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

    Name
    Type
    Description

    Methods

    ContainsAudio()

    Indicates whether the data object contains data in the format.

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

    ContainsFileDropList()

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

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

    ContainsImage()

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

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

    ContainsText()

    Indicates whether the data object contains data in the format.

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

    Parameter
    Type
    Description

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

    GetAudioStream()

    Retrieves an audio stream from the data object.

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

    GetData(format)

    Returns the data associated with the specified class type format.

    Parameter
    Type
    Description

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

    GetData(format)

    Returns the data associated with the specified data format.

    Parameter
    Type
    Description

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

    GetData(format, autoConvert)

    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

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

    GetDataPresent(format)

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

    Parameter
    Type
    Description

    Returns: . true if data stored in this 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

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

    GetDataPresent(format, autoConvert)

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

    Parameter
    Type
    Description

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

    GetFileDropList()

    Returns the list of file types from the data object.

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

    GetFiles()

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

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

    GetFormats()

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

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

    GetFormats(autoConvert)

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

    Parameter
    Type
    Description

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

    GetImage()

    Retrieves an image from the data object.

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

    GetText()

    Retrieves text data from the data object in the format.

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

    GetText(format)

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

    Parameter
    Type
    Description

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

    SetAudio(audioBytes)

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

    Parameter
    Type
    Description

    Throws:

    • audioBytes is null.

    SetAudio(audioStream)

    Adds a to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • audioStream is null.

    SetData(data)

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

    Parameter
    Type
    Description

    SetData(format, data)

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

    Parameter
    Type
    Description

    SetData(format, data)

    Adds the specified object to the using the specified format.

    Parameter
    Type
    Description

    SetData(format, autoConvert, data)

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

    Parameter
    Type
    Description

    SetDownloadURL(url, fileName)

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

    Parameter
    Type
    Description

    SetFileDropList(filePaths)

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

    Parameter
    Type
    Description

    Throws:

    • filePaths is null.

    SetFileDropList(filePaths)

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

    Parameter
    Type
    Description

    Throws:

    • filePaths is null.

    SetImage(image)

    Adds an to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • image is null.

    SetText(textData)

    Adds text data to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • textData is null or .

    SetText(textData, format)

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

    Parameter
    Type
    Description

    Throws:

    • textData is null or .

    Implements

    Name
    Description

    data

    Object

    The data to store.

    format

    String

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

    data

    Object

    The data to store.

    format

    Type

    A Type representing the format of the data.

    data

    Object

    The data to store.

    format

    TextDataFormat

    One of the TextDataFormat values.

    format

    Type

    A Type representing the format of the data to retrieve.

    format

    String

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

    format

    String

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

    autoConvert

    Boolean

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

    format

    Type

    A Type representing the format to check for.

    format

    String

    A Type representing the format of the data to retrieve.

    format

    String

    The format to check for. See DataFormats for predefined formats.

    autoConvert

    Boolean

    true to determine whether data stored in this DataObject can be converted to the specified format; false to check whether the data is in the specified format.

    autoConvert

    Boolean

    true to retrieve all formats that data stored in this DataObject is associated with, or can be converted to; false to retrieve only native data formats.

    format

    TextDataFormat

    One of the TextDataFormat values.

    audioBytes

    Byte[]

    A Byte array containing the audio data.

    audioStream

    Stream

    A Stream containing the audio data.

    data

    Object

    The data to store.

    format

    Type

    A Type representing the format associated with the data.

    data

    Object

    The data to store.

    format

    String

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

    data

    Object

    The data to store.

    format

    String

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

    autoConvert

    Boolean

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

    data

    Object

    The data to store.

    url

    String

    The url to the file to download.

    fileName

    String

    The name of the file to download from the url.

    filePaths

    StringCollection

    A StringCollection containing the file names.

    filePaths

    String[]

    A StringCollection containing the file names.

    image

    Image

    The Image to add to the data object.

    textData

    String

    The text to add to the data object.

    textData

    String

    The text to add to the data object.

    format

    TextDataFormat

    One of the TextDataFormat values.

    IDataObject

    Provides a format-independent mechanism for transferring data.

    DataObject
    DataObject
    DataObject
    DataObject
    WaveAudio
    Boolean
    FileDrop
    Boolean
    Bitmap
    Boolean
    UnicodeText
    Boolean
    TextDataFormat
    Boolean
    Stream
    Stream
    WaveAudio
    Object
    Object
    Object
    DataObject
    Boolean
    DataObject
    Boolean
    DataObject
    Boolean
    String[]
    HttpFileCollection
    HttpFileCollection
    DataObject
    String[]
    String
    DataObject
    String[]
    String
    Image
    Image
    Bitmap
    UnicodeText
    String
    Empty
    UnicodeText
    TextDataFormat
    String
    Empty
    Byte
    WaveAudio
    Stream
    ArgumentNullException
    Stream
    WaveAudio
    ArgumentNullException
    DataObject
    DataObject
    DataObject
    DataObject
    DownloadURL
    FileDrop
    ArgumentNullException
    FileDrop
    ArgumentNullException
    Image
    Bitmap
    ArgumentNullException
    UnicodeText
    ArgumentNullException
    Empty
    TextDataFormat
    ArgumentNullException
    Empty

    Control

    Wisej.Web.Control

    Namespace: Wisej.Web

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

    Properties

    AccessibleDescription

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

    AccessibleName

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

    AccessibleRole

    : 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

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

    AllowDrop

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

    Anchor

    : 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

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

    AppearanceKey

    : Sets the appearance key for the theme engine.

    BackColor

    : Returns or sets the background color for the control.

    BackgroundImage

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

    BackgroundImageLayout

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

    BackgroundImageSource

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

    BecomingActiveControl

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

    BindingContext

    : Returns or sets the for the control.

    Bottom

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

    Bounds

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

    CanExecute

    : Determines whether the control can execute a command.

    CanFocus

    : Returns whether the control can receive focus.

    CanSelect

    : Returns whether the control can be selected.

    Capture

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

    CausesValidation

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

    ClientEvents

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

    ClientRectangle

    : Returns the client rectangle of the control.

    ClientSize

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

    ContainsFocus

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

    ContextMenu

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

    Controls

    : Returns the collection of controls contained within the control.

    Created

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

    CssClass

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

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

    CssStyle

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

    You can use any CSS style string.

    Cursor

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

    DataBindings

    : Returns the data bindings for the control.

    DefaultBackColor

    : Returns the default background color of the control.

    DefaultFont

    : Returns the default font of the control.

    DefaultForeColor

    : Returns the default background color of the control.

    DisplayRectangle

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

    Disposing

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

    Dock

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

    Enabled

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

    EnableNativeContextMenu

    : Enables or disables the browser's context menu.

    Focusable

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

    Focused

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

    Font

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

    ForeColor

    : Returns or sets the text color of the control.

    Handle

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

    HasChildren

    : Returns whether the control contains any child control.

    HasDataBindings

    : Returns whether the control specifies data bindings.

    HasResponsiveProfiles

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

    HasUserData

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

    Height

    : Returns or sets the height of the control.

    InitScript

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

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

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

    IsDisposed

    : Returns whether the control has been disposed.

    IsHandleCreated

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

    IsMirrored

    : Returns whether the control is mirrored.

    LayoutEngine

    : Returns the control's layout engine.

    Left

    : 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

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

    Margin

    : Returns or sets the space between controls.

    MaximumSize

    : Returns or sets the maximum size for the control.

    MinimumSize

    : Returns or sets the minimum size for the control.

    ModifierKeys

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

    MouseButtons

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

    MousePosition

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

    Movable

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

    Name

    : Gets or sets the name of the control.

    Padding

    : Returns or sets padding within the control.

    Parent

    : Returns or sets the parent container of the control.

    PreferredSize

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

    ResizableEdges

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

    ResponsiveProfiles

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

    Right

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

    RightToLeft

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

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

    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.

    Selectable

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

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

    ShowLoader

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

    Size

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

    States

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

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

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

    TabIndex

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

    TabStop

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

    Tag

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

    Text

    : 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

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

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

    Top

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

    TopLevelControl

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

    UserData

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

    UseWaitCursor

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

    ValidationCancelled

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

    Visible

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

    WheelDelta

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

    Width

    : 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

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

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

    AddCssClass(name)

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

    Parameter
    Type
    Description

    Returns: . The new value of the property.

    AddState(state)

    Adds the specified theme state to the widget.

    Parameter
    Type
    Description

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

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

    BeginInvoke(method)

    Executes the specified delegate asynchronously.

    Parameter
    Type
    Description

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

    BeginInvoke(method, args)

    Executes the specified delegate asynchronously.

    Parameter
    Type
    Description

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

    BringToFront()

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

    Call(function, args)

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

    Parameter
    Type
    Description

    Call(function, callback, args)

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

    Parameter
    Type
    Description

    CallAsync(function, args)

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

    Parameter
    Type
    Description

    Returns: . An awaitable that represents the asynchronous operation.

    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

    Contains(control)

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

    Parameter
    Type
    Description

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

    CreateControl()

    Creates and register this control and all its children.

    DoDragDrop(data, allowedEffects)

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

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

    DoDragDrop(data, allowedEffects, imageSource)

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

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

    DoDragDrop(data, allowedEffects, imageSource, imageSize)

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

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

    DoDragDrop(data, allowedEffects, image)

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

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

    DoDragDrop(data, allowedEffects, image, imageSize)

    Begins a drag-and-drop operation.

    Parameter
    Type
    Description

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

    EndInvoke(asyncResult)

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

    Parameter
    Type
    Description

    Returns: . The return value from the asynchronous operation.

    Eval(javaScript)

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

    Parameter
    Type
    Description

    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

    EvalAsync(javaScript)

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

    Parameter
    Type
    Description

    Returns: . An awaitable that represents the asynchronous operation.

    FindForm()

    Retrieves the form that the control is on.

    Returns: .

    FindPage()

    Retrieves the page that the control is on.

    Returns: .

    Focus()

    Sets input focus to the control.

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

    Returns: . The child at the specified coordinates.

    GetChildAtPoint(pt)

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

    Parameter
    Type
    Description

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

    GetClientEventListener(id)

    Returns the script associated to the listener identified by id .

    Parameter
    Type
    Description

    Returns: . JavaScript associated with the listener.

    GetClientEventListener(name)

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

    Parameter
    Type
    Description

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

    GetContainerControl()

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

    Returns: . The parent .

    GetNextControl(control, forward)

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

    Parameter
    Type
    Description

    Returns: . The next in the tab order.

    GetStyle(flag)

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

    Parameter
    Type
    Description

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

    HasClientEventListener(name)

    Checks whether the specified event name has any listener attached.

    Parameter
    Type
    Description

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

    HasCssClass(name)

    Returns true if the property contains the specified class name .

    Parameter
    Type
    Description

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

    HasState(state)

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

    Parameter
    Type
    Description

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

    Invoke(method)

    Executes the specified delegate.

    Parameter
    Type
    Description

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

    Invoke(method, args)

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

    Parameter
    Type
    Description

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

    IsMnemonic(charCode, text)

    Determines whether the specified character is the mnemonic character.

    Parameter
    Type
    Description

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

    PerformLayout()

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

    PerformLayout(affectedControl, affectedProperty)

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

    Parameter
    Type
    Description

    PointToClient(point)

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

    Parameter
    Type
    Description

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

    PointToScreen(point)

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

    Parameter
    Type
    Description

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

    RectangleToClient(rect)

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

    Parameter
    Type
    Description

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

    RectangleToScreen(rect)

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

    Parameter
    Type
    Description

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

    Refresh()

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

    Refresh(refreshChildren)

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

    Parameter
    Type
    Description

    RemoveClientEventListener(id)

    Detaches and removes the listener identified by id .

    Parameter
    Type
    Description

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

    RemoveClientEventListener(name)

    Removes all the listeners attached to the event name .

    Parameter
    Type
    Description

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

    RemoveCssClass(name)

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

    Parameter
    Type
    Description

    Returns: . The new value of the property.

    RemoveState(state)

    Removes the specified theme state from the widget.

    Parameter
    Type
    Description

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

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

    ResetBindings()

    Removes all the data bindings from the control.

    ResumeLayout()

    Resumes layout logic.

    ResumeLayout(performLayout)

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

    Parameter
    Type
    Description

    ScrollControlIntoView(alignX, alignY)

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

    Parameter
    Type
    Description

    ScrollControlIntoView()

    Scrolls the child control into view.

    Select()

    Activates a control.

    SelectNextControl(control, forward, tabStopOnly, nested, wrap)

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

    Parameter
    Type
    Description

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

    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

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

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

    Parameter
    Type
    Description

    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 for details of exactly which child controls will be validated.

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

    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

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

    Events

    Appear

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

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

    AutoSizeChanged

    Fired when the property value changes.

    BackColorChanged

    Fired when the value of the property changes.

    BackgroundImageChanged

    Fired when the value of the property changes.

    BackgroundImageLayoutChanged

    Fired when the property changes.

    BecomingActiveControlChanged

    Fired when the value of the property changes.

    BindingContextChanged

    Occurs when the value of the property changes.

    CausesValidationChanged

    Fired when the value of the property changes.

    Click

    Fired when the control is clicked.

    ClientSizeChanged

    Fired when the property value changes.

    ContextMenuChanged

    Fired when the value of the property changes.

    ControlAdded

    Fired when a new control is added to the .

    ControlCreated

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

    ControlRemoved

    Fired when a control is removed from the .

    CursorChanged

    Fired when the value of the property changes.

    Disappear

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

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

    Disposed

    Fired when the component is disposed.

    DockChanged

    Fired when the value of the property changes.

    DoubleClick

    Fired when the control is double-clicked.

    DragDrop

    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

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

    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.

    DragEnter

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

    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.

    DragLeave

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

    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.

    DragOver

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

    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.

    DragStart

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

    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.

    EnabledChanged

    Fired when the property value has changed.

    EndMove

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

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

    EndResize

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

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

    Enter

    Fired when the control gains the input focus.

    FontChanged

    Fired when the property value changes.

    ForeColorChanged

    Fired when the property value changes.

    GotFocus

    Fired when the control gains the focus.

    HelpRequested

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

    ImeModeChanged

    Fired when the ImeMode property has changed.

    KeyDown

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

    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.

    KeyPress

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

    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.

    KeyUp

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

    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.

    Layout

    Fired when a control should reposition its child controls.

    Leave

    Fired when the control loses the input focus.

    LocationChanged

    Fired when the property value has changed.

    LongTap

    Fired when a pointer holds on the screen.

    LostFocus

    Fired when the control loses focus.

    MarginChanged

    Fired when the control's margin changes.

    MouseCaptureChanged

    Fired when the control loses mouse capture.

    MouseClick

    Fired when the control is clicked by the mouse.

    MouseDoubleClick

    Fired when the control is double clicked by the mouse.

    MouseDown

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

    MouseEnter

    Fired when the mouse pointer enters the control.

    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.

    MouseHover

    Fired when the mouse pointer rests on the control.

    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.

    MouseLeave

    Fired when the mouse pointer leaves the control.

    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.

    MouseMove

    Fired when the mouse pointer is moved over the control.

    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.

    MouseUp

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

    MouseWheel

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

    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.

    PaddingChanged

    Fired when the control's padding changes.

    Paint

    Fired when a UserPaint control needs to redraw itself.

    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.

    ParentChanged

    Fired when the property value changes.

    Pinch

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

    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.

    PreviewKeyDown

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

    QueryContinueDrag

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

    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.

    Resize

    Fired when the control is resized.

    ResponsiveProfileChanged

    Fired when the active responsive profile is changed.

    RightToLeftChanged

    Fired when the property value changes.

    Rotate

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

    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.

    SizeChanged

    Fired when the property value changes.

    StartMove

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

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

    StartResize

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

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

    StyleChanged

    Fired when the control style changed.

    Swipe

    Fired when a pointer swipes over the screen.

    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.

    TabIndexChanged

    Fired when the property value has changed.

    TabStopChanged

    Fired when the value of the property changes.

    Tap

    Fired when a pointer taps on the screen.

    TextChanged

    Fired when the property value changes.

    TouchCancel

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

    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.

    TouchEnd

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

    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.

    TouchMove

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

    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.

    TouchStart

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

    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.

    Track

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

    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.

    Validated

    Fired when the control is finished validating.

    Validating

    Fired when the control is validating.

    VisibleChanged

    Fired when the property value changes.

    WidgetEvent

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

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

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

    Inherited By

    Name
    Description

    Implements

    Name
    Description

    GetClientEventListener

    GetClientEventListener

    The size of the drag image specified in imageSource.

    The size of the drag image specified in image.

    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.

    The new property value of the control.

    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.

    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 .

    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 .

    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.

    Displays data in a customizable list format.

    Used by the control to display data at run time.

    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 panel that dynamically arranges its child controls.

    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 shape control. Displays an element a border in any of the four sides.

    Displays child controls vertically or horizontally in a scrollable container.

    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 split button control.

    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.

    Represents a spinner control that displays values.

    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.

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

    Represents a toolbar component.

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

    name

    String

    Name of the client event to attach the listener to.

    script

    String

    JavaScript code to execute when the event occurs.

    name

    String

    Name of the css class to add.

    state

    String

    Name of the custom state to add to the widget.

    method

    Delegate

    A delegate to a method that takes no parameters.

    method

    Delegate

    A delegate to a method that takes no parameters.

    args

    Object[]

    An optional array of objects to pass as arguments to the specified method.

    function

    String

    The name of the JavaScript function to execute.

    args

    Object[]

    The arguments to pass to the function.

    function

    String

    The name of the JavaScript function to execute.

    callback

    Action<Object>

    Asynchronous callback method that receives the return value.

    args

    Object[]

    The arguments to pass to the function.

    function

    String

    The name of the JavaScript function to execute.

    args

    Object[]

    The arguments to pass to the function.

    horizontal

    Boolean

    Center horizontally.

    vertical

    Boolean

    Center vertically.

    control

    Control

    The child Control to find.

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    imageSource

    String

    The name or URL for an image to use as the drag cursor.

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    imageSource

    String

    The name or URL for an image to use as the drag cursor.

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    image

    Image

    An Image to use as the drag cursor.

    data

    Object

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    image

    Image

    An Image to use as the drag cursor.

    asyncResult

    IAsyncResult

    An IAsyncResult that represents a BeginInvoke operation started on a control.

    javaScript

    String

    The JavaScript code to run on the client.

    javaScript

    String

    The JavaScript code to evaluate on the client.

    callback

    Action<Object>

    Asynchronous callback method that receives the return value.

    javaScript

    String

    The JavaScript code to evaluate on the client.

    pt

    Point

    A Point 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

    GetChildAtPointSkip

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

    pt

    Point

    A Point 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.

    id

    Int32

    Id of the listener to retrieve the script for.

    name

    String

    Name of the event.

    control

    Control

    The Control to start the search with.

    forward

    Boolean

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

    flag

    ControlStyles

    The ControlStyles bit to return the value from.

    name

    String

    Name of the client event to verify.

    name

    String

    Css class name to verify.

    state

    String

    Name of the state to check.

    invalidateChildren

    Boolean

    When true, invalidates all the children of the control.

    method

    Delegate

    A delegate that contains a method to be called in the control's thread context.

    method

    Delegate

    A delegate to a method that takes parameters of the same number and type that are contained in the args parameter.

    args

    Object[]

    An array of objects to pass as arguments to the specified method. This parameter can be null if the method takes no arguments.

    charCode

    Char

    The character to test.

    text

    String

    The string to search.

    affectedControl

    Control

    A Control that represents the recently changed control.

    affectedProperty

    String

    The name of the recently changed property on the control that caused the layout to change.

    point

    Point

    The screen coordinate Point to convert.

    point

    Point

    The client coordinate Point to convert.

    rect

    Rectangle

    The screen coordinate Rectangle to convert.

    rect

    Rectangle

    The client coordinate Rectangle to convert.

    refreshChildren

    Boolean

    True to also refresh all the children of this control.

    id

    Int32

    Id of the listener to remove.

    name

    String

    Name of the event.

    name

    String

    The css class name to remove.

    state

    String

    Name of the state to remove.

    performLayout

    Boolean

    true to apply all pending layout requests; otherwise, false.

    alignX

    HorizontalAlignment

    Indicates the HorizontalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Center will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement.

    alignY

    VerticalAlignment

    Indicates the VerticalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Middle will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement.

    control

    Control

    The Control at which to start the search.

    forward

    Boolean

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

    tabStopOnly

    Boolean

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

    x

    Int32

    The new Left property value of the control.

    y

    Int32

    The new Top property value of the control.

    width

    Int32

    The new Width property value of the control.

    x

    Int32

    The new Left property value of the control.

    y

    Int32

    The new Top property value of the control.

    width

    Int32

    The new Width property value of the control.

    flags

    ValidationConstraints

    FileDialogUI

    UI implementation for the FileDialog class.

    FolderBrowserDialogUI

    UI implementation for the FolderDialog class.

    BindingNavigator

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

    Button

    Represents a button control.

    ButtonBase

    Implements the basic functionality common to button controls.

    IBindableComponent

    Bindable components implement this interface.

    IWisejComponent

    All wisej components implement this interface.

    IWisejControl

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

    IWisejSerializable

    Allows an object to serialize itself.

    Control
    String
    String
    AccessibleRole
    Boolean
    Boolean
    AnchorStyles
    Boolean
    String
    Color
    Image
    ImageLayout
    ImageLayout
    String
    Boolean
    BindingContext
    BindingContext
    Int32
    Rectangle
    Boolean
    Boolean
    Boolean
    Boolean
    Boolean
    ClientEventCollection
    AddClientEventListener
    HasClientEventListener
    RemoveClientEventListener
    RemoveClientEventListener
    Rectangle
    Size
    Boolean
    ContextMenu
    ControlCollection
    Boolean
    String
    StyleSheet
    AddCssClass
    RemoveCssClass
    HasCssClass
    String
    Cursor
    ControlBindingsCollection
    Color
    Font
    Color
    Rectangle
    Boolean
    DockStyle
    Boolean
    Boolean
    Boolean
    Boolean
    Font
    Color
    IntPtr
    Boolean
    Boolean
    Boolean
    Boolean
    UserData
    Int32
    String
    #qx
    wisej-js
    ClientEvents
    AddClientEventListener
    HasClientEventListener
    RemoveClientEventListener
    RemoveClientEventListener
    Boolean
    Boolean
    Boolean
    LayoutEngine
    Int32
    Point
    Padding
    Size
    Size
    Keys
    MouseButtons
    Point
    Boolean
    String
    Padding
    Control
    Size
    AnchorStyles
    ResponsiveProfileCollection
    Int32
    RightToLeft
    Inherit
    Inherit
    Boolean
    Selectable
    Focusable
    Selectable
    Boolean
    Size
    String[]
    AddState
    RemoveState
    HasState
    Int32
    Boolean
    Focusable
    Object
    String
    String
    ToolTipText
    ToolTip
    ToolTip
    ForeColor
    AutomaticDelay
    InitialDelay
    AutoPopDelay
    ToolTipText
    ToolTip
    ToolTip
    Int32
    Control
    Form
    Form
    Object
    Boolean
    Boolean
    Boolean
    Int32
    Int32
    Int32
    RemoveClientEventListener
    GetClientEventListener
    CssClass
    String
    CssClass
    String[]
    States
    States
    IAsyncResult
    IAsyncResult
    BeginInvoke
    IAsyncResult
    IAsyncResult
    Task
    Task<Object>
    Task
    Boolean
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    Object
    Task
    Task<Object>
    Task
    Form
    Page
    Boolean
    Control
    Control
    Control
    Control
    String
    String[]
    IContainerControl
    IContainerControl
    IContainerControl
    Control
    Control
    Boolean
    Boolean
    CssClass
    Boolean
    CssClass
    States
    Boolean
    Object
    Object
    Object
    Boolean
    Point
    Point
    Point
    Point
    Point
    Point
    Rectangle
    Rectangle
    Rectangle
    Rectangle
    Rectangle
    Rectangle
    Boolean
    Boolean
    CssClass
    String
    CssClass
    String[]
    States
    States
    Boolean
    Selectable
    Boolean
    Validating
    Validated
    Boolean
    Validating
    Validated
    EventHandler
    Appear
    Disappear
    EventHandler
    AutoSize
    EventHandler
    BackColor
    EventHandler
    BackgroundImage
    EventHandler
    BackgroundImageLayout
    EventHandler
    BecomingActiveControl
    EventHandler
    BindingContext
    EventHandler
    CausesValidation
    EventHandler
    EventHandler
    ClientSize
    EventHandler
    ContextMenu
    ControlEventHandler
    ControlCollection
    EventHandler
    ControlEventHandler
    ControlCollection
    EventHandler
    Cursor
    EventHandler
    Appear
    Disappear
    EventHandler
    EventHandler
    Dock
    EventHandler
    DragEventHandler
    EventHandler
    DragEventHandler
    EventHandler
    DragEventHandler
    EventHandler
    EventHandler
    Enabled
    EventHandler
    Movable
    Movable
    Location
    EventHandler
    ResizableEdges
    ResizableEdges
    None
    Size
    EventHandler
    EventHandler
    Font
    EventHandler
    ForeColor
    EventHandler
    HelpEventHandler
    EventHandler
    KeyEventHandler
    KeyPressEventHandler
    KeyEventHandler
    LayoutEventHandler
    EventHandler
    EventHandler
    Location
    EventHandler
    EventHandler
    EventHandler
    EventHandler
    MouseEventHandler
    MouseEventHandler
    MouseEventHandler
    EventHandler
    EventHandler
    EventHandler
    MouseEventHandler
    MouseEventHandler
    MouseEventHandler
    EventHandler
    PaintEventHandler
    EventHandler
    Parent
    PinchEventHandler
    PreviewKeyDownEventHandler
    KeyDown
    QueryContinueDragEventHandler
    EventHandler
    ResponsiveProfileChangedEventHandler
    EventHandler
    RightToLeft
    RotateEventHandler
    EventHandler
    Size
    EventHandler
    Movable
    Movable
    EventHandler
    ResizableEdges
    ResizableEdges
    None
    EventHandler
    SwipeEventHandler
    EventHandler
    TabIndex
    EventHandler
    TabStop
    EventHandler
    EventHandler
    Text
    TouchEventHandler
    TouchEventHandler
    TouchEventHandler
    TouchEventHandler
    TrackEventHandler
    EventHandler
    CancelEventHandler
    EventHandler
    Visible
    WidgetEventHandler

    imageSize

    imageSize

    nested

    height

    height

    
      // set the border radius to 100% and make the control round.
      this.button1.CssStyle = "border-radius:100%";
    
      // change the background color of the internal label of the button widget.
      this.button1.InitScript = "this.getChildControl('label').setBackgroundColor('red')";
    
      // attach a JavaScript event handler.
      this.textBox1.InitScript = @"this.addListener('keydown', function(e) {
        if (e.getKeyIdentifier() == "PageDown") {
          alert('You pressed PageDown.');
        }
      });
    
      // force the widget to update the UI as if it was hovered and focused.
      this.button1.States = new [] { "hovered", "focused" };
    
      // apply a custom state defined in a custom theme or theme mixing.
      this.panel1.States = new [] { "alert" };
      this.fireWidgetEvent("myevent", {x:1, y:2, name:'test'});
      
      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;
        }
      }
    Size
    Size
    Boolean
    Boolean
    Int32
    Height
    Int32
    Height
    BoundsSpecified
    BoundsSpecified
    CheckBox
    CheckedListBox
    ListBox
    ComboBox
    ContainerControl
    DateTimePicker
    DomainUpDown
    FlowLayoutPanel
    Form
    GroupBox
    Label
    LinkLabel
    ListBox
    ListControl
    ListBox
    ComboBox
    MaskedTextBox
    MdiClient
    MonthCalendar
    NumericUpDown
    Page
    Panel
    PictureBox
    ProgressBar
    RadioButton
    RadioButton
    ScrollableControl
    HScrollBar
    VScrollBar
    ScrollBar
    SplitContainer
    SplitterPanel
    SplitContainer
    TabControl
    TabPage
    TableLayoutPanel
    TabPage
    TabControl
    TextBox
    TextBoxBase
    TrackBar
    UpDownBase
    UserControl
    WebBrowser
    DataGridViewComboBoxEditingControl
    ComboBox
    DataGridViewComboBoxCell
    DataGridViewDateTimePickerEditingControl
    DateTimePicker
    DataGridViewDateTimePickerCell
    DataGridViewMaskedTextBoxEditingControl
    MaskedTextBox
    DataGridViewMaskedTextBoxCell
    DataGridViewNumericUpDownEditingControl
    NumericUpDown
    DataGridViewNumericUpDownCell
    DataGridViewTextBoxEditingControl
    TextBox
    DataGridViewTextBoxCell
    WrapMode
    False
    DataGridView
    DataRepeater
    DataRepeaterItem
    DataRepeater
    Desktop
    Accordion
    AccordionPanel
    AccordionPanel
    Accordion
    AspNetPanel
    Canvas
    FlashPlayer
    FlashPlayer
    FlexLayoutPanel
    HtmlPanel
    IFramePanel
    Line
    ListViewComboBox
    UserComboBox
    ListView
    Media
    Video
    Video
    Audio
    Audio
    PdfViewer
    PdfViewer
    Shape
    SlideBar
    Spacer
    SplitButton
    TagTextBox
    TimeUpDown
    TimeSpan
    TreeViewComboBox
    UserComboBox
    TreeView
    Upload
    UserComboBox
    ComboBox
    UserPopup
    Widget
    ListView
    MenuBar
    PropertyGrid
    StatusBar
    ToolBar
    TreeView
    TreeNode