arrow-left

Only this pageAll pages
gitbookPowered by GitBook
triangle-exclamation
Couldn't generate the PDF for 725 pages, generation stopped at 100.
Extend with 50 more pages.
1 of 100

v3.0

Loading...

Wisej.Web

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

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

Welcome

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

hashtag
Legend

Icon
Description

hashtag
Concepts & Reference

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

hashtag
Skills

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

  • C# or VB.NET

  • .NET in general

  • Visual Studio

Client

Wisej.Core.Client

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents a unique client using the application.

public class Client
Public Class Client

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

hashtag
Properties

hashtag
Browsers

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

hashtag
ID

: Unique client ID.

hashtag
IPAddress

: IP Address of the client computer.

hashtag
SessionCount

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

JavaScript

Instance method, or property, or event.

Static method or property or event.

Protected method or property or event.

Deprecated method or property or event.

ClientBrowser[]
Stringarrow-up-right
Stringarrow-up-right
Int32arrow-up-right

Buttons

Common Dialogs

ClientPlatform

Wisej.Core.ClientPlatform

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents the client platform used to render the widgets.

public class ClientPlatform
Public Class ClientPlatform

hashtag
Properties

hashtag
JavaScripts

: List of javascript files associated with the platform.

hashtag
Name

: The name of this platform configuration.

hashtag
Provider

: The platform provider.

hashtag
StyleSheets

: List of style sheets associated with the platform.

hashtag
Version

: Returns the file version of the

PlatformProvider

Wisej.Core.PlatformProvider

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Platforms supported by Wisej.

hashtag

PinchEventArgs

Wisej.Web.PinchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for event.

ClientCollection

Wisej.Core.ClientCollection

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

List of s using the application.

String[]arrow-up-right
Stringarrow-up-right
PlatformProvider
String[]arrow-up-right
Versionarrow-up-right
Fields
Name
Description

QXDesktop

Desktop platform by qooxdoo.

hashtag
Used By

Name
Description

The platform provider.

Public Enum PlatformProvider As [Enum]
public enum PlatformProvider : Enum
hashtag
Properties

hashtag
Scale

Doublearrow-up-right: Returns the calculated scale factor.

hashtag
Used By

Name
Description

Represents the method that will handle the event.

Public Class PinchEventArgs
    Inherits EventArgs
Pinch
public class PinchEventArgs : EventArgs
hashtag
Constructors

hashtag
ClientCollection()

hashtag
Properties

hashtag
Count

Int32arrow-up-right: Returns the total number of Client items in the collection.

hashtag
Item(index)

Client: Returns the Client at the specified index .

Public Class ClientCollection
    Inherits IList(Of Client)
    Implements ICollection(Of Client), IEnumerable(Of Client), IEnumerable
Client
public class ClientCollection : IList<Client>, ICollection<Client>, IEnumerable<Client>, IEnumerable

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the HashChanged event.

public class HashChangedEventArgs : EventArgs
Public Class HashChangedEventArgs
    Inherits EventArgs

hashtag
Constructors

hashtag
HashChangedEventArgs(value)

Initializes a new instance of the class.

Name
Type
Description

hashtag
Properties

hashtag
Hash

: The hash string from the client.

hashtag
Used By

Name
Description

WidgetEventArgs

Wisej.Web.WidgetEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the WidgetEvent event.

public class WidgetEventArgs : EventArgs
Public Class WidgetEventArgs
    Inherits EventArgs

hashtag
Constructors

hashtag
WidgetEventArgs(type, data)

Initializes a new instance of the class.

Name
Type
Description

hashtag
Properties

hashtag
Data

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

hashtag
Type

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

hashtag
Used By

Name
Description

KeyEventHandler

Wisej.Web.KeyEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

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

hashtag
Parameters

Name
Type
Description

hashtag
Fired By

Name
Description

PinchEventHandler

Wisej.Web.PinchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Pinch event.

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

hashtag
Parameters

Name
Type
Description

hashtag
Fired By

Name
Description

PaintEventArgs

Wisej.Web.PaintEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the Paint event.

public class PaintEventArgs : EventArgs
Public Class PaintEventArgs
    Inherits EventArgs

hashtag
Constructors

hashtag
PaintEventArgs(graphics, clipRect)

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

Name
Type
Description

hashtag
Properties

hashtag
ClipRectangle

: Returns the rectangle in which to paint.

hashtag
Graphics

: Returns the graphics used to paint.

hashtag
Used By

Name
Description

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the HashChanged event.

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

hashtag
Parameters

Name
Type
Description

hashtag
Fired By

Name
Description

LicenseErrorEventArgs

Wisej.Web.LicenseErrorEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the LicenseError event.

public class LicenseErrorEventArgs : EventArgs
Public Class LicenseErrorEventArgs
    Inherits EventArgs

hashtag
Constructors

hashtag
LicenseErrorEventArgs(error)

Initializes a new instance of the class.

Name
Type
Description

hashtag
Properties

hashtag
Error

: Indicates the type of license error that has occurred.

LoadConfigurationEventHandler

Wisej.Core.LoadConfigurationEventHandler

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Represents a method that handles the LoadConfiguration event.

public delegate void LoadConfigurationEventHandler(Object sender, 
Public Delegate Sub LoadConfigurationEventHandler(ByVal sender As [Object], ByVal args As LoadConfigurationEventArgs)

hashtag
Parameters

Name
Type
Description

hashtag
Fired By

Name
Description

SwipeEventHandler

Wisej.Web.SwipeEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the Swipe event.

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

hashtag
Parameters

Name
Type
Description

hashtag
Fired By

Name
Description

JavaScript.ClientEvent

Wisej.Web.JavaScript ClientEvent

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represent a JavaScript event and the corresponding code to execute on the client when the event is fired.

public class ClientEvent
Public Class ClientEvent

hashtag
Constructors

hashtag
ClientEvent()

hashtag
Properties

hashtag
Event

: Returns or sets the name of the event. Not all events are available to all controls, which events are fired depends on the widget that corresponds to the control.

hashtag
JavaScript

: Returns or sets the JavaScript handler for the event.

Application.FormCollection

Wisej.Web.Application FormCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Holds the collection of all top-level application forms.

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

hashtag
Properties

hashtag
Count

: Returns the total number of currently open forms.

hashtag
Item(index)

: Returns the form at the specified index.

hashtag
Item(name)

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

hashtag
Methods

hashtag
GetEnumerator()

Returns an enumerator that iterates through the open forms.

Returns: .

RotateEventArgs

Wisej.Web.RotateEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for Rotate event.

public class RotateEventArgs : EventArgs
Public Class RotateEventArgs
    Inherits EventArgs

hashtag
Properties

hashtag
Angle

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

hashtag
Used By

Name
Description

Screen

Wisej.Web.Screen

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the display on the client device.

public class Screen
Public Class Screen

hashtag
Properties

hashtag
Bounds

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

hashtag
DeviceName

: Returns the device name associated with a display.

hashtag
WorkingArea

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

ServiceScope

Wisej.Web.ServiceScope

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

EXPERIMENTAL: Specifies the scope of services added using AddService.

public enum ServiceScope : Enum
Public Enum ServiceScope As [Enum]

hashtag
Fields

Name
Description

hashtag
Used By

Name
Description

SwipeDirection

Wisej.Web.SwipeDirection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Indicates the direction of the swipe gesture.

public enum SwipeDirection : Enum
Public Enum SwipeDirection As [Enum]

hashtag
Fields

Name
Description

hashtag
Used By

Name
Description

FileDialogRootCollection

Wisej.Web.FileDialogRootCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

public class FileDialogRootCollection : List<>
Public Class FileDialogRootCollection
    Inherits List(Of )

hashtag
Methods

hashtag
MapPath(filePath)

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

Parameter
Type
Description

Returns: . The physical path for the implementation.

SwipeAxis

Wisej.Web.SwipeAxis

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Indicates the axis of the swipe gesture.

public enum SwipeAxis : Enum
Public Enum SwipeAxis As [Enum]

hashtag
Fields

Name
Description

hashtag
Used By

Name
Description

Application.PageCollection

Wisej.Web.Application PageCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Holds the collection of all top-level application pages.

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

hashtag
Properties

hashtag
Count

: Returns the total number of currently open pages.

hashtag
Item(index)

: Returns the page at the specified index.

hashtag
Item(name)

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

hashtag
Methods

hashtag
GetEnumerator()

Returns an enumerator that iterates through the open pages.

Returns: .

LoadConfigurationEventArgs

Wisej.Core.LoadConfigurationEventArgs

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Specifies the event arguments for the LoadConfiguration event.

public class LoadConfigurationEventArgs : EventArgs
Public Class LoadConfigurationEventArgs
    Inherits EventArgs

hashtag
Properties

hashtag
FilePath

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

hashtag
SuppressCache

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

hashtag
Used By

Name
Description

ClientBrowser

Wisej.Core.ClientBrowser

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Properties of the client browser currently interacting with the application.

hashtag

DragEventHandler

Wisej.Web.DragEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

HelpEventArgs

Wisej.Web.HelpEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

ClientProfile

Wisej.Core.ClientProfile

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.0.0.0)

Definition of the client device.

hashtag

SwipeEventArgs

Wisej.Web.SwipeEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for event.

HelpEventHandler

Wisej.Web.HelpEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

ControlEventArgs

Wisej.Web.ControlEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the and events.

TrackEventArgs

Wisej.Web.TrackEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for event.

MenuButtonItemClickedEventHandler

Wisej.Web.MenuButtonItemClickedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

FileDialogLoadPathEventHandler

Wisej.Web.FileDialogLoadPathEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the and events.

PaintEventHandler

Wisej.Web.PaintEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

TouchEventArgs

Wisej.Web.TouchEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for event.

TouchEventHandler

Wisej.Web.TouchEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

LayoutEventHandler

Wisej.Web.LayoutEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

WidgetEventHandler

Wisej.Web.WidgetEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that handles the event.

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

KeyPressEventArgs

Wisej.Web.KeyPressEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

AccordionAction

Wisej.Web.AccordionAction

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Defines values representing events.

MenuButtonItemClickedEventArgs

Wisej.Web.MenuButtonItemClickedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

KeyPressEventHandler

Wisej.Web.KeyPressEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

AccordionEventHandler

Wisej.Web.AccordionEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

TrackEventHandler

Wisej.Web.TrackEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

ControlEventHandler

Wisej.Web.ControlEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

RotateEventHandler

Wisej.Web.RotateEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

QueryContinueDragEventArgs

Wisej.Web.QueryContinueDragEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

PreviewKeyDownEventHandler

Wisej.Web.PreviewKeyDownEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event.

ColorDialog

Wisej.Web.ColorDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

KeyEventArgs
e
)

sender

Objectarrow-up-right

The source of the event.

e

KeyEventArgs

A KeyEventArgs that contains the event data.

Control.KeyDown

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

Control.KeyUp

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

PinchEventArgs
e
)

sender

Objectarrow-up-right

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.

HashChangedEventArgs
e
)

sender

Objectarrow-up-right

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.

LoadConfigurationEventArgs
args
)

sender

Objectarrow-up-right

The source of the event. Always null.

args

LoadConfigurationEventArgs

The event data.

Configuration.LoadConfiguration

Fired when the system needs to load a Wisej configuration file.

SwipeEventArgs
e
)

sender

Objectarrow-up-right

The source of the event.

e

SwipeEventArgs

A SwipeEventArgs that contains the event data.

Control.Swipe

Fired when a pointer swipes over the screen.

Global

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

Session

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

Transient

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

Application.AddService

EXPERIMENTAL: Adds a scoped service to the service container.

X

X-axis.

Y

Y-axis

SwipeEventArgs.Axis

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

TrackEventArgs.Axis

Returns the Axis of the track event.

ClientPlatform.Provider

value

Stringarrow-up-right

Initial hash value.

HashChangedEventHandler

Represents the method that will handle the HashChanged event.

LicenseErrorEventHandler

Represents the method that will handle the LicenseError event.

HashChangedEventArgs
Stringarrow-up-right

type

Stringarrow-up-right

The type (name) of event.

data

Objectarrow-up-right

The data object received with the event.

WidgetEventHandler

Represents the method that handles the WidgetEvent event.

WidgetEventArgs
Objectarrow-up-right
Stringarrow-up-right

graphics

Graphicsarrow-up-right

The Graphicsarrow-up-right used to paint the item.

clipRect

Rectanglearrow-up-right

The Rectanglearrow-up-right that represents the rectangle in which to paint.

PaintEventHandler

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

PaintEventArgs
Rectanglearrow-up-right
Graphicsarrow-up-right

error

Stringarrow-up-right

License error.

LicenseErrorEventArgs
Stringarrow-up-right
Stringarrow-up-right
Stringarrow-up-right
Int32arrow-up-right
Form
Form
IEnumeratorarrow-up-right

RotateEventHandler

Represents the method that will handle the Rotate event.

Doublearrow-up-right
Rectanglearrow-up-right
Stringarrow-up-right
Rectanglearrow-up-right

filePath

Stringarrow-up-right

Virtual path to map to the corresponding physical path.

IFileSystemProvider
Stringarrow-up-right
IFileSystemProvider
Int32arrow-up-right
Page
Page
IEnumeratorarrow-up-right

LoadConfigurationEventHandler

Represents a method that handles the LoadConfiguration event.

Stringarrow-up-right
Booleanarrow-up-right
Configuration
LoadConfiguration
PinchEventHandler
Pinch

Direction up.

Down

Direction down.

Left

Direction left.

Right

Direction right.

SwipeEventArgs.Direction

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

Up

Fields
Name
Type
Description

CookieStorage

Returns an instance of the class that represents the "cookies" storage in the browser.

LocalStorage

Returns an instance of the class that represents the "localStorage" object in the browser.

hashtag
Properties

hashtag
CultureInfo

CultureInfoarrow-up-right: Returns the locale declared in the application configuration file or detected from the client browser.

hashtag
Device

Stringarrow-up-right: Device type. Can be one of "Mobile", "Tablet" or "Desktop".

hashtag
Features

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

hashtag
IPAddress

Stringarrow-up-right: IP Address of the client computer.

hashtag
IsDarkMode

Booleanarrow-up-right: Returns true if the browser is using dark mode. [Since 3.0.10]

hashtag
IsFullScreen

Booleanarrow-up-right: Returns true if the browser is in full screen mode.

hashtag
IsSecure

Booleanarrow-up-right: Returns true if the connection is secure.

hashtag
Language

Stringarrow-up-right: Client language.

hashtag
OS

Stringarrow-up-right: Client OS. Can be one of "iOS", "Android", "WebOS", "BlackBerry", "MacOS", "Linux", "Windows", "Unix", "Other".

hashtag
PixelRatio

Doublearrow-up-right: Returns the ratio of the resolution in physical pixels to the resolution in CSS pixels for the current display device.

hashtag
Profiles

ClientProfile[]:

hashtag
ScreenSize

Sizearrow-up-right: Screen size.

hashtag
SessionId

Stringarrow-up-right: Returns the session ID associated with this ClientBrowser.

hashtag
Size

Sizearrow-up-right: Browser size. This is the window size, which can be different from the device (or screen) size.

hashtag
TabId

Stringarrow-up-right: Identifies the browser tab associated with with this ClientBrowser instance.

hashtag
TimezoneOffset

Int32arrow-up-right: Returns the time difference between UTC time and local time, in minutes.

hashtag
Type

Stringarrow-up-right: Browser type. Can be one of "IE", "Edge", "Chrome", "Opera", "Firefox", "Safari", "Other".

hashtag
UserAgent

Stringarrow-up-right: Returns the raw user agent string of the client browser.

hashtag
UserData

Objectarrow-up-right: Returns a value or map set by the client when loading the application's first HTML page.

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

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

When used in conjunction with an aspx startup page (Default.aspx) it allows the application to retrieve data passed as a POST request and pass it to the Wisej application.

hashtag
Version

Int32arrow-up-right: Browser version.

Public Class ClientBrowser
public class ClientBrowser
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

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

Public Delegate Sub DragEventHandler(ByVal sender As [Object], ByVal e As DragEventArgs)
DragDrop
DragEnter
DragOver
Control
public delegate void DragEventHandler(Object sender, DragEventArgs e)
hashtag
Constructors

hashtag
ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the ResponsiveProfileChangedEventArgs class.

Name
Type
Description

oldValue

Previous .

newValue

New active .

hashtag
Properties

hashtag
CurrentProfile

ClientProfile: The new active profile.

hashtag
PreviousProfile

ClientProfile: The previously active profile.

hashtag
Used By

Name
Description

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

Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs
ResponsiveProfileChanged
public class ResponsiveProfileChangedEventArgs : EventArgs
hashtag
Constructors

hashtag
HelpEventArgs(target)

Initializes a new instance of the HelpEventArgs class.

Name
Type
Description

target

The that had the focus when the user pressed F1.

hashtag
Properties

hashtag
Handled

Booleanarrow-up-right: Returns or sets a value indicating whether the help event was handled.

hashtag
Target

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

hashtag
Used By

Name
Description

Represents the method that will handle the event of a .

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

Default

Returns the default singleton.

hashtag
Properties

hashtag
Device

Stringarrow-up-right: Device type.

hashtag
Landscape

Nullable<Boolean>arrow-up-right: Device landscape mode.

hashtag
MaxScreenWidth

Int32arrow-up-right: Maximum screen width.

hashtag
MaxWidth

Int32arrow-up-right: Maximum browser width.

hashtag
MinScreenWidth

Int32arrow-up-right: Minimum screen width.

hashtag
MinWidth

Int32arrow-up-right: Minimum browser width.

hashtag
Name

Stringarrow-up-right: Name of the profile.

hashtag
UserAgent

Stringarrow-up-right: User agent string.

Public Class ClientProfile
public class ClientProfile
hashtag
Properties

hashtag
Axis

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

hashtag
Direction

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

hashtag
Distance

Int32arrow-up-right: Returns the distance of the performed swipe.

hashtag
Duration

Int32arrow-up-right: Returns the duration the performed swipe took.

hashtag
StartTime

Int64arrow-up-right: Returns the start time of the performed swipe.

hashtag
Velocity

Doublearrow-up-right: Returns the velocity of the performed swipe.

hashtag
Used By

Name
Description

Represents the method that will handle the event.

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

sender

The source of the event.

hlpevent

A object that contains the event data.

hashtag
Fired By

Name
Description

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

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

hashtag
ControlEventArgs(control)

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

Name
Type
Description

control

The to store in this event.

hashtag
Properties

hashtag
Control

Control: Returns the control object used by this event.

hashtag
Used By

Name
Description

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

Public Class ControlEventArgs
    Inherits EventArgs
ControlAdded
ControlRemoved
public class ControlEventArgs : EventArgs
hashtag
Properties

hashtag
Axis

SwipeAxis: Returns the Axis of the track event.

hashtag
Location

Pointarrow-up-right: Returns the X, Y delta for the track event.

hashtag
X

Int32arrow-up-right: Returns the X delta of the track event.

hashtag
Y

Int32arrow-up-right: Returns Y delta of the track event.

hashtag
Used By

Name
Description

Represents the method that will handle the event.

Public Class TrackEventArgs
    Inherits EventArgs
Track
public class TrackEventArgs : EventArgs
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

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

Public Delegate Sub MenuButtonItemClickedEventHandler(ByVal sender As [Object], ByVal e As MenuButtonItemClickedEventArgs)
ItemClicked
Button
public delegate void MenuButtonItemClickedEventHandler(Object sender, MenuButtonItemClickedEventArgs e)
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

hashtag
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)
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

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

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

Public Delegate Sub FileDialogLoadPathEventHandler(ByVal sender As [Object], ByVal e As FileDialogLoadPathEventArgs)
LoadPath
LoadPath
public delegate void FileDialogLoadPathEventHandler(Object sender, FileDialogLoadPathEventArgs e)
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

Fired when a UserPaint control needs to redraw itself.

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

hashtag
Identifiers

Int64[]arrow-up-right: Returns the unique identifiers for the touch items.

hashtag
IsMultiTouch

Booleanarrow-up-right: Returns whether more than one touch is associated with the event target element.

hashtag
Locations

Point[]arrow-up-right: Returns the location of the touch items in screen coordinates.

hashtag
Rotation

Doublearrow-up-right: Returns the delta of the rotation since the start of the event, in degrees.

hashtag
Scale

Doublearrow-up-right: Returns the distance between two fingers since the start of the event.

hashtag
Used By

Name
Description

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

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

sender

The source of the event.

e

A that contains the event data.

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

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

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

Fired when a control should reposition its child controls.

Public Delegate Sub LayoutEventHandler(ByVal sender As [Object], ByVal e As LayoutEventArgs)
Layout
Control
public delegate void LayoutEventHandler(Object sender, LayoutEventArgs e)
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

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

Public Delegate Sub WidgetEventHandler(ByVal sender As [Object], ByVal e As WidgetEventArgs)
WidgetEvent
public delegate void WidgetEventHandler(Object sender, WidgetEventArgs e)
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

hashtag
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)
hashtag
Constructors

hashtag
KeyPressEventArgs(keyChar)

Initializes a new instance of the KeyPressEventArgs class.

Name
Type
Description

keyChar

The ASCII character corresponding to the key the user pressed.

hashtag
Properties

hashtag
Handled

Booleanarrow-up-right: Returns or sets whether the KeyPress event was handled.

hashtag
KeyChar

Chararrow-up-right: Returns or sets the character corresponding to the key pressed.

hashtag
Used By

Name
Description

Represents the method that will handle the event of a .

Public Class KeyPressEventArgs
    Inherits EventArgs
KeyPress
public class KeyPressEventArgs : EventArgs
hashtag
Fields
Name
Description

Deselected

Represents the event.

Deselecting

Represents the event.

Selected

Represents the event.

hashtag
Used By

Name
Description

Returns a value indicating which event is occurring.

Returns a value indicating which event is occurring.

Public Enum AccordionAction As [Enum]
Accordion
public enum AccordionAction : Enum
hashtag
Constructors

hashtag
MenuButtonItemClickedEventArgs(item)

Initializes a new instance of the MenuButtonItemClickedEventArgs class.

Name
Type
Description

item

The that was clicked.

hashtag
Properties

hashtag
Item

MenuItem: Returns the clicked menu item.

hashtag
Used By

Name
Description

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

Public Class MenuButtonItemClickedEventArgs
    Inherits EventArgs
ItemClicked
public class MenuButtonItemClickedEventArgs : EventArgs
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

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

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

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

Fired when a panel is selected.

Fired when a panel is deselected.

Public Delegate Sub AccordionEventHandler(ByVal sender As [Object], ByVal e As AccordionEventArgs)
Selected
Deselected
Accordion
public delegate void AccordionEventHandler(Object sender, AccordionEventArgs e)
hashtag
Constructors

hashtag
ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the ResponsiveProfileChangedEventArgs class.

Name
Type
Description

oldValue

Previous .

newValue

New active .

hashtag
Properties

hashtag
CurrentProfile

ClientProfile: The new active profile.

hashtag
PreviousProfile

ClientProfile: The previously active profile.

hashtag
Used By

Name
Description

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

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

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

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

Public Delegate Sub TrackEventHandler(ByVal sender As [Object], ByVal e As TrackEventArgs)
Track
public delegate void TrackEventHandler(Object sender, TrackEventArgs e)
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

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

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

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

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

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

hashtag
QueryContinueDragEventArgs(args)

Initializes a new instance of the QueryContinueDragEventArgs class.

Name
Type
Description

args

The arguments received from the client.

hashtag
Properties

hashtag
Action

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

hashtag
EscapePressed

Booleanarrow-up-right: Returns if the user pressed the ESC key.

hashtag
KeyState

Int32arrow-up-right: Returns the current state of the SHIFT, CTRL, and ALT keys.

hashtag
Used By

Name
Description

Represents the method that will handle the event of a .

Public Class QueryContinueDragEventArgs
    Inherits EventArgs
QueryContinueDrag
public class QueryContinueDragEventArgs : EventArgs
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

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

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

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

public class ColorDialog : CommonDialog
Public Class ColorDialog
    Inherits CommonDialog

hashtag
Constructors

hashtag
ColorDialog()

Initializes a new instance of ColorDialog.

hashtag
ColorDialog(container)

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

Name
Type
Description

container

An that represents the container of the component.

hashtag
Properties

hashtag
Color

Colorarrow-up-right: Returns or sets the color selected by the user.

hashtag
CustomColors

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

hashtag
Methods

hashtag
Reset()

Resets all properties to their default values.

CommonDialog

AccordionCancelEventHandler

Wisej.Web.AccordionCancelEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

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

hashtag
Parameters

Name
Type
Description

hashtag
Fired By

Name
Description

LicenseErrorEventHandler

Wisej.Web.LicenseErrorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the LicenseError event.

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

hashtag
Parameters

Name
Type
Description

hashtag
Fired By

Name
Description

MouseEventHandler

Wisej.Web.MouseEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

FolderBrowserDialogUI

Wisej.Web.FolderBrowserDialogUI

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

PreviewKeyDownEventArgs

Wisej.Web.PreviewKeyDownEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

FileDialogLoadPathEventArgs

Wisej.Web.FileDialogLoadPathEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the LoadPath event.

Allows an application to filter the files and folders loaded by the and components and to set the icon, creation date and modified date. To skip a file or folder, set e.Cancel = true. To set a file's icon, or date, set the , or properties.

AccordionEventArgs

Wisej.Web.AccordionEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the and events of a control.

LayoutEventArgs

Wisej.Web.LayoutEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event.

AccordionCancelEventArgs

Wisej.Web.AccordionCancelEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the and events of a control.

SplitButton

Wisej.Web.SplitButton

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

int value1 = Application.Browser.UserData.value1;
string value2 = Application.Browser.UserData.someName;
AccordionCancelEventArgs
e
)

sender

Objectarrow-up-right

The source of the event.

e

AccordionCancelEventArgs

A AccordionCancelEventArgs that contains the event data.

Accordion.Selecting

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

Accordion.Deselecting

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

HashChangedEventArgs
e
)

sender

Objectarrow-up-right

The source of the event.

e

HashChangedEventArgs

A LicenseErrorEventArgs that contains the event data.

Application.LicenseError

Fired when a license error occurs.

Objectarrow-up-right
DragEventArgs
DragEventArgs
Control.DragDrop
Control.DragEnter
Control.DragOver
Objectarrow-up-right
HelpEventArgs
HelpEventArgs
Control.HelpRequested
Objectarrow-up-right
MenuButtonItemClickedEventArgs
MenuButtonItemClickedEventArgs
Button.ItemClicked
Objectarrow-up-right
ResponsiveProfileChangedEventArgs
ResponsiveProfileChangedEventArgs
Control.ResponsiveProfileChanged
Application.ResponsiveProfileChanged
Objectarrow-up-right
FileDialogLoadPathEventArgs
FileDialogLoadPathEventArgs
FileDialog.LoadPath
FolderBrowserDialog.LoadPath
Objectarrow-up-right
PaintEventArgs
PaintEventArgs
Control.Paint

Control.TouchMove

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

Objectarrow-up-right
TouchEventArgs
TouchEventArgs
Control.TouchStart
Control.TouchEnd
Control.TouchCancel
Objectarrow-up-right
LayoutEventArgs
LayoutEventArgs
Control.Layout
Objectarrow-up-right
WidgetEventArgs
WidgetEventArgs
Control.WidgetEvent
Objectarrow-up-right
ResponsiveProfileChangedEventArgs
ResponsiveProfileChangedEventArgs
Control.ResponsiveProfileChanged
Application.ResponsiveProfileChanged

Selecting

Represents the Selecting event.

Deselected
Deselecting
Selected
AccordionCancelEventArgs.Action
AccordionEventArgs.Action
Objectarrow-up-right
KeyPressEventArgs
KeyPressEventArgs
Control.KeyPress
Objectarrow-up-right
AccordionEventArgs
AccordionEventArgs
Accordion.Selected
Accordion.Deselected
Objectarrow-up-right
TrackEventArgs
TrackEventArgs
Control.Track

Form.MdiChildRemoved

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

Objectarrow-up-right
ControlEventArgs
ControlEventArgs
Control.ControlAdded
ControlCollection
Control.ControlRemoved
ControlCollection
Form.MdiChildAdded
Objectarrow-up-right
RotateEventArgs
RotateEventArgs
Control.Rotate
Objectarrow-up-right
PreviewKeyDownEventArgs
PreviewKeyDownEventArgs
Control.PreviewKeyDown
KeyDown

SessionStorage

SessionStorage

Returns an instance of the SessionStorage class that represents the "sessionStorage" object in the browser.

CookieStorage
CookieStorage
LocalStorage
LocalStorage
ClientProfile
ClientProfile
ClientProfile
ClientProfile
ResponsiveProfileChangedEventHandler
Control
Control
HelpEventHandler
HelpRequested
Control
ClientProfile
ClientProfile
SwipeEventHandler
Swipe
Control
Control
ControlEventHandler
ControlAdded
ControlRemoved
Control
TrackEventHandler
Track
TouchEventHandler
TouchStart
TouchEnd
TouchMove
TouchCancel
Chararrow-up-right
KeyPressEventHandler
KeyPress
Control
MenuItem
MenuItem
MenuButtonItemClickedEventHandler
ItemClicked
Button
ClientProfile
ClientProfile
ClientProfile
ClientProfile
ResponsiveProfileChangedEventHandler
WisejEventArgs
QueryContinueDragEventHandler
QueryContinueDrag
Control
IContainerarrow-up-right
IContainerarrow-up-right
ColorDialog
hashtag
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

hashtag
Fired By

Name
Description

Fired when the user clicks the control with the mouse.

Fired when the control is clicked by the mouse.

Fired when the control is double clicked by the mouse.

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

    • Form

      • FolderBrowserDialogUI

UI implementation for the FolderDialog class.

public class FolderBrowserDialogUI : Form
Public Class FolderBrowserDialogUI
    Inherits Form

hashtag
Constructors

hashtag
FolderBrowserDialogUI()

hashtag
FolderBrowserDialogUI(folderDialog)

Name
Type
Description

folderDialog

hashtag
Implements

Name
Description

Bindable components implement this interface.

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

All wisej components implement this interface.

Control
hashtag
Constructors

hashtag
PreviewKeyDownEventArgs(keyData)

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

Name
Type
Description

keyData

One of the values.

hashtag
Properties

hashtag
Alt

Booleanarrow-up-right: Returns whether the ALT key was pressed.

hashtag
Control

Booleanarrow-up-right: Returns whether the CTRL key was pressed.

hashtag
IsInputKey

Booleanarrow-up-right: Returns whether a key is a regular input key.

hashtag
KeyCode

Keys: Returns the keyboard code.

hashtag
KeyData

Keys: Returns the key data.

hashtag
KeyValue

Int32arrow-up-right: Returns the keyboard value.

hashtag
Modifiers

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

hashtag
Shift

Booleanarrow-up-right: Returns whether the SHIFT key was pressed.

hashtag
Used By

Name
Description

Represents the method that will handle the event.

Public Class PreviewKeyDownEventArgs
    Inherits EventArgs
PreviewKeyDown
public class PreviewKeyDownEventArgs : EventArgs
hashtag
Constructors

hashtag
FileDialogLoadPathEventArgs(path, isDirectory)

Constructs a new instance of FileDialogLoadPathEventArgs.

Name
Type
Description

path

Path of the file or directory.

isDirectory

Indicates that the path is for a directory.

hashtag
Properties

hashtag
CreationTime

DateTimearrow-up-right: Sets the creation DateTime of the file.

hashtag
FileSize

Int64arrow-up-right: Sets the file size in bytes.

hashtag
ImageSource

Stringarrow-up-right: Sets the name or path of the icon to display next to the file.

hashtag
IsDirectory

Booleanarrow-up-right: Returns true when the Path refers to a directory.

hashtag
LastWriteTime

DateTimearrow-up-right: Sets the last modified DateTime of the file.

hashtag
Path

Stringarrow-up-right: Returns the full path of the file or folder being loaded.

hashtag
Used By

Name
Description

Represents the method that will handle the and events.

Public Class FileDialogLoadPathEventArgs
    Inherits CancelEventArgs
FileDialog
FolderBrowserDialog
ImageSource
CreationTime
LastWriteTime
public class FileDialogLoadPathEventArgs : CancelEventArgs
hashtag
Constructors

hashtag
AccordionEventArgs(panel, panelIndex, action)

Initializes a new instance of the AccordionEventArgs class.

Name
Type
Description

panel

The the event is occurring for.

panelIndex

The zero-based index of panel in the collection.

hashtag
Properties

hashtag
Action

AccordionAction: Returns a value indicating which event is occurring.

hashtag
Panel

AccordionPanel: Returns the AccordionPanel the event is occurring for.

hashtag
PanelIndex

Int32arrow-up-right: Returns the zero-based index of the Panel in the Panels collection.

hashtag
Used By

Name
Description

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

Public Class AccordionEventArgs
    Inherits EventArgs
Selected
Deselected
Accordion
public class AccordionEventArgs : EventArgs
hashtag
Constructors

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

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

hashtag
Properties

hashtag
AffectedComponent

IComponentarrow-up-right: Returns the IComponentarrow-up-right affected by the layout change.

hashtag
AffectedControl

Control: Returns the child control affected by the change.

hashtag
AffectedProperty

Stringarrow-up-right: Returns the property affected by the change.

hashtag
Used By

Name
Description

Represents the method that will handle the event of a .

Public Class LayoutEventArgs
    Inherits EventArgs
Layout
public class LayoutEventArgs : EventArgs
hashtag
Constructors

hashtag
AccordionCancelEventArgs(panel, panelIndex, cancel, action)

Initializes a new instance of the AccordionCancelEventArgs class.

Name
Type
Description

panel

The the event is occurring for.

panelIndex

The zero-based index of panel in the collection.

hashtag
Properties

hashtag
Action

AccordionAction: Returns a value indicating which event is occurring.

hashtag
Panel

AccordionPanel: Returns the AccordionPanel the event is occurring for.

hashtag
PanelIndex

Int32arrow-up-right: Returns the zero-based index of the Panel in the Panels collection.

hashtag
Used By

Name
Description

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

Public Class AccordionCancelEventArgs
    Inherits CancelEventArgs
Selecting
Deselecting
Accordion
public class AccordionCancelEventArgs : CancelEventArgs
ButtonBase
  • Button

    • SplitButton

Represents a split button control.

public class SplitButton : Button
Public Class SplitButton
    Inherits Button

hashtag
Constructors

hashtag
SplitButton()

hashtag
Properties

hashtag
Orientation

Orientation: Returns or sets a value indicating the layout of the SplitButton. When the value is set to Vertical the down arrow is places below the text, otherwise it's to the right of the text.

hashtag
Implements

Name
Description

Bindable components implement this interface.

Allows a control to act like a button on a .

Defines an object that can invoke a .

Control

KeyEventArgs

Wisej.Web.KeyEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the KeyDown or KeyUp event.

public class KeyEventArgs : EventArgs
Public Class KeyEventArgs
    Inherits EventArgs

hashtag
Constructors

hashtag
KeyEventArgs(keyData)

Initializes a new instance of the class.

Name
Type
Description

hashtag
Properties

hashtag
Alt

: Returns whether the ALT key was pressed.

hashtag
Control

: Returns whether the CTRL key was pressed.

hashtag
Handled

: Returns or sets whether the event was handled.

hashtag
KeyCode

: Returns the keyboard code..

hashtag
KeyData

: Returns the key data.

hashtag
KeyValue

: Returns the keyboard value.

hashtag
Modifiers

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

hashtag
Shift

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

hashtag
Methods

hashtag
IsAltPressed()

Returns whether the Alt key is pressed.

Returns: .

hashtag
IsCtrlPressed()

Returns whether the Control key is pressed.

Returns: .

hashtag
IsShiftPressed()

Returns whether the Shift key is pressed.

Returns: .

hashtag
Used By

Name
Description

OpenFileDialog

Wisej.Web.OpenFileDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

  • CommonDialog

Prompts the user to open a file from the server.

You can:

  • Override . It's called when the specified file doesn't exist and the property is true.

  • Override to create your custom when the method is called.

  • Set the to a class that has a constructor that accepts

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

hashtag
Constructors

hashtag
OpenFileDialog()

Initializes a new instance of .

hashtag
OpenFileDialog(container)

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

Name
Type
Description

hashtag
Properties

hashtag
CheckFileExists

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

hashtag
Multiselect

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

hashtag
SafeFileName

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

hashtag
SafeFileNames

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

hashtag
Methods

hashtag
OpenFile()

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

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

Throws:

  • is empty or null.

hashtag
Reset()

Resets all properties to their default values.

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.

Control.MouseUp

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

Control.MouseWheel

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

Objectarrow-up-right
MouseEventArgs
MouseEventArgs
CheckedListBox.MouseClick
CheckedListBox
Control.MouseClick
Control.MouseDoubleClick

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
Booleanarrow-up-right
Booleanarrow-up-right
Booleanarrow-up-right
Keys
Keys
Int32arrow-up-right
Keys
Booleanarrow-up-right
Booleanarrow-up-right
Booleanarrow-up-right
Booleanarrow-up-right

IWisejControl

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

IWisejWindow

All wisej top-level windows implement this interface.

IWisejSerializable

Allows an object to serialize itself.

FolderBrowserDialog
IBindableComponent
IContainerControl
IWisejComponent
Keys
Keys
PreviewKeyDownEventHandler
PreviewKeyDown
Stringarrow-up-right
Booleanarrow-up-right
FileDialogLoadPathEventHandler
LoadPath
LoadPath

action

AccordionAction

One of the AccordionAction values.

AccordionPanel
AccordionPanel
Int32arrow-up-right
Panels
AccordionEventHandler
Selected
Deselected
Accordion
IComponentarrow-up-right
IComponentarrow-up-right
Stringarrow-up-right
Control
Control
Stringarrow-up-right
LayoutEventHandler
Layout
Control

cancel

Booleanarrow-up-right

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

action

AccordionAction

One of the AccordionAction values.

AccordionPanel
AccordionPanel
Int32arrow-up-right
Panels
AccordionCancelEventHandler
Selecting
Deselecting
Accordion

IImage

Provides access to common image properties across the controls that 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.

IBindableComponent
IButtonControl
Form
ICommandSource
Command
as the single argument to change the User Interface (UI) of the file dialog.
  • Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.

  • container

    IContainerarrow-up-right

    An IContainerarrow-up-right that represents the container of the OpenFileDialog component.

    Public Class OpenFileDialog
        Inherits FileDialog
    FileDialog
    OpenFileDialog
    PromptFileNotFound
    CheckFileExists
    CreateUI
    Form
    ShowDialog
    DialogTemplate
    Form
    FileDialog
    IFileSystemProvider
    Roots
    OpenFileDialog
    OpenFileDialog
    Booleanarrow-up-right
    Booleanarrow-up-right
    Stringarrow-up-right
    String[]arrow-up-right
    FileName
    Streamarrow-up-right
    Streamarrow-up-right
    ArgumentNullExceptionarrow-up-right
    FileName
    public class OpenFileDialog : FileDialog

    DragEventArgs

    Wisej.Web.DragEventArgs

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Provides data for the DragDrop, DragEnter, or DragOver event.

    public class DragEventArgs : EventArgs
    Public Class DragEventArgs
        Inherits EventArgs

    hashtag
    Constructors

    hashtag
    DragEventArgs(allowedEffect, effect, data, location)

    Initializes a new instance of the class.

    Name
    Type
    Description

    hashtag
    Properties

    hashtag
    AllowedEffect

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

    hashtag
    AllowedFileTypes

    : 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 for a complete list of standard media types.

    hashtag
    Data

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

    hashtag
    DragSource

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

    hashtag
    DropTarget

    : Returns the original target of the drag operation.

    hashtag
    Effect

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

    hashtag
    Files

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

    hashtag
    Image

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

    hashtag
    ImageSize

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

    hashtag
    ImageSource

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

    hashtag
    KeyState

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

    hashtag
    Location

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

    hashtag
    X

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

    hashtag
    Y

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

    hashtag
    Used By

    Name
    Description

    Cursor

    Wisej.Web.Cursor

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Represents the mouse pointer.

    public class Cursor
    Public Class Cursor

    hashtag
    Constructors

    hashtag
    Cursor(image)

    Creates a new cursor using the .

    Name
    Type
    Description

    hashtag
    Cursor(source)

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

    Name
    Type
    Description

    hashtag
    Cursor(stream)

    Creates a new cursor using the .

    Name
    Type
    Description

    hashtag
    Cursor(image, x, y)

    Creates a new cursor using the .

    Name
    Type
    Description

    hashtag
    Cursor(stream, x, y)

    Creates a new cursor using the .

    Name
    Type
    Description

    hashtag
    Cursor(source, x, y)

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

    Name
    Type
    Description

    hashtag
    Properties

    hashtag
    Name

    : Returns the name of the cursor.

    hashtag
    Position

    : Returns or sets the pointer's position.

    AccordionPanel

    Wisej.Web.AccordionPanel

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

    Represents a panel in a control.

    hashtag
    Constructors

    hashtag
    AccordionPanel()

    Initializes a new instance of the class.

    hashtag
    AccordionPanel(text)

    Initializes a new instance of the class and specifies the text to display as the title of the panel.

    Name
    Type
    Description

    hashtag
    Properties

    hashtag
    Accordion

    : Returns the parent control.

    hashtag
    Collapsed

    : Returns whether the is collapsed.

    hashtag
    ShowExpandButton

    : Returns or sets a value indicating that the panel can show the expand button on the title bar.

    hashtag
    Text

    : Returns or sets the text to display as the title of the .

    hashtag
    Tools

    : Returns the instance of associated with this control.

    hashtag
    Methods

    hashtag
    GetAccordionPanelOfComponent(control)

    Retrieves the panel that contains the specified .

    Parameter
    Type
    Description

    Returns: . The that contains the specified , or null if it cannot be found.

    hashtag
    Update()

    Overridden to update the parent Accordion when in design mode.

    hashtag
    Implements

    Name
    Description

    SaveFileDialog

    Wisej.Web.SaveFileDialog

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • CommonDialog

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

    You can:

    • Override . It's called when the specified file doesn't exist and the property is true.

    • Override . It's called when the specified file doesn't exist and the property is true.

    • Override . It's called when the specified file doesn't exist and the property is true.

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

    hashtag
    Constructors

    hashtag
    SaveFileDialog()

    Initializes a new instance of .

    hashtag
    SaveFileDialog(container)

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

    Name
    Type
    Description

    hashtag
    Properties

    hashtag
    CreatePrompt

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

    hashtag
    OverwritePrompt

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

    hashtag
    Methods

    hashtag
    OpenFile()

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

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

    Throws:

    • is empty or null.

    hashtag
    ProcessFileNames(fileNames)

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

    Parameter
    Type
    Description

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

    hashtag
    Reset()

    Resets all dialog box options to their default values.

    Cursors

    Wisej.Web.Cursors

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Defines a collection of predefined Cursor objects.

    public class Cursors
    Public Class Cursors

    hashtag
    Properties

    hashtag
    Alias

    : Returns the "shortcut" cursor.

    hashtag
    Arrow

    : Returns the "arrow" cursor.

    hashtag
    Cell

    : Returns "cell" cursor.

    hashtag
    Copy

    : Returns the clipboard "copy" cursor.

    hashtag
    Cross

    : Returns the "crosshair" cursor.

    hashtag
    Default

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

    hashtag
    Grab

    : Returns the "grab" cursor.

    hashtag
    Hand

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

    hashtag
    Help

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

    hashtag
    HSplit

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

    hashtag
    IBeam

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

    hashtag
    Move

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

    hashtag
    No

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

    hashtag
    None

    : Returns the "none" cursor.

    hashtag
    NotAllowed

    : Returns the "not-allowed" cursor.

    hashtag
    SizeAll

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

    hashtag
    SizeNE

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

    hashtag
    SizeNESW

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

    hashtag
    SizeNS

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

    hashtag
    SizeNW

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

    hashtag
    SizeNWSE

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

    hashtag
    SizeSE

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

    hashtag
    SizeSW

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

    hashtag
    SizeWE

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

    hashtag
    Text

    : Returns the "text" cursor.

    hashtag
    VSplit

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

    hashtag
    WaitCursor

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

    hashtag
    ZoomIn

    : Returns the "zoom-in" cursor.

    hashtag
    ZoomOut

    : Returns the "zoom-out" cursor.

    JavaScript.ClientEventCollection

    Wisej.Web.JavaScript ClientEventCollection

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

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

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

    hashtag
    Constructors

    hashtag
    ClientEventCollection()

    hashtag
    Properties

    hashtag
    Count

    : Returns the number of items in the collection.

    hashtag
    Item(index)

    : Returns the element at the specified index .

    hashtag
    Methods

    hashtag
    Add(item)

    Adds the instance to the collection.

    Parameter
    Type
    Description

    hashtag
    Clear()

    Removes all the items from the collection.

    hashtag
    Contains(item)

    Checks whether the specified item exists in the collection.

    Parameter
    Type
    Description

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

    hashtag
    IndexOf(item)

    Returns the position of the specified item in the collection.

    Parameter
    Type
    Description

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

    hashtag
    Insert(index, item)

    Inserts the item into the collection at the specified index .

    Parameter
    Type
    Description

    hashtag
    Remove(item)

    Removes the item from the collection.

    Parameter
    Type
    Description

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

    hashtag
    RemoveAt(index)

    Removes the item at the location index .

    Parameter
    Type
    Description

    hashtag
    Events

    hashtag
    CollectionChanged

    Fired when the collection has changed.

    FolderBrowserDialog

    Wisej.Web.FolderBrowserDialog

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • CommonDialog

    Allows the user to select a folder from one of the .

    hashtag
    Constructors

    hashtag
    FolderBrowserDialog()

    Initializes a new instance of .

    hashtag
    FolderBrowserDialog(roots)

    Initializes a new instance of using the initial roots .

    Name
    Type
    Description

    hashtag
    FolderBrowserDialog(container)

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

    Name
    Type
    Description

    hashtag
    Properties

    hashtag
    Description

    : Returns or sets the description splayed above the tree view control in the dialog box.

    hashtag
    Roots

    : List of root file systems displayed by the FolderBrowserDialog.

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

    hashtag
    SelectedPath

    : Returns sets the path selected by the user.

    hashtag
    ShowHelp

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

    hashtag
    Title

    : Returns or sets the file dialog box title.

    hashtag
    Methods

    hashtag
    GetRoot(path)

    Returns the that contains the specified path .

    Parameter
    Type
    Description

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

    hashtag
    MapPath(folderPath)

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

    Parameter
    Type
    Description

    Returns: . The physical path for the implementation.

    hashtag
    Reset()

    Resets all properties to their default values.

    hashtag
    Events

    hashtag
    LoadPath

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

    MouseEventArgs

    Wisej.Web.MouseEventArgs

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Provides data for the , , and events.

    RadioButton

    Wisej.Web.RadioButton

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Button

    Wisej.Web.Button

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    QueryContinueDragEventHandler

    Wisej.Web.QueryContinueDragEventHandler

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Represents the method that will handle the event of a .

    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
    IEnumerable
    ,
    IList
    <
    ClientEvent
    >,
    ICollection
    <
    ClientEvent
    >,
    IEnumerable
    <
    ClientEvent
    >

    item

    ClientEvent

    ClientEvent item to add to the collection.

    item

    ClientEvent

    ClientEvent items to find in the collection.

    item

    ClientEvent

    ClientEvent item to locate in the collection.

    index

    Int32arrow-up-right

    Position where to insert the item .

    item

    ClientEvent

    ClientEvent item to insert into the collection.

    item

    ClientEvent

    ClientEvent instance to remove from the collection.

    index

    Int32arrow-up-right

    Position of the item to remove from the collection.

    Int32arrow-up-right
    ClientEvent
    ClientEvent
    ClientEvent
    ClientEvent
    Booleanarrow-up-right
    Int32arrow-up-right
    Booleanarrow-up-right
    ClientEvent
    CollectionChangeEventHandlerarrow-up-right

    Override CreateUI to create your custom Form when the method ShowDialog is called.

  • Set the DialogTemplate to a Form class that has a constructor that accepts FileDialog as the single argument to change the User Interface (UI) of the file dialog.

  • Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.

  • container

    IContainerarrow-up-right

    An IContainerarrow-up-right that represents the container of the SaveFileDialog component.

    fileNames

    String[]arrow-up-right

    Array containing the selected file paths.

    Public Class SaveFileDialog
        Inherits FileDialog
    FileDialog
    SaveFileDialog
    PromptFileNotFound
    CheckFileExists
    PromptFileCreate
    CreatePrompt
    PromptFileOverwrite
    OverwritePrompt
    IFileSystemProvider
    Roots
    SaveFileDialog
    SaveFileDialog
    Booleanarrow-up-right
    Booleanarrow-up-right
    Streamarrow-up-right
    Streamarrow-up-right
    ArgumentNullExceptionarrow-up-right
    FileName
    FileDialog
    Booleanarrow-up-right
    public class SaveFileDialog : FileDialog

    roots

    IFileSystemProvider[]

    Initial file systems to load in the FolderBrowserDialog.

    container

    IContainerarrow-up-right

    An IContainerarrow-up-right that represents the container of the FolderBrowserDialog component.

    path

    Stringarrow-up-right

    Full path of the file to locate in on of the Roots.

    folderPath

    Stringarrow-up-right

    Virtual path to map to the corresponding physical path.

    Public Class FolderBrowserDialog
        Inherits CommonDialog
    FolderBrowserDialog
    Roots
    FolderBrowserDialog
    FolderBrowserDialog
    FolderBrowserDialog
    Stringarrow-up-right
    FileDialogRootCollection
    IFileSystemProvider
    IFileSystemProvider
    Stringarrow-up-right
    Booleanarrow-up-right
    Stringarrow-up-right
    IFileSystemProvider
    IFileSystemProvider
    IFileSystemProvider
    IFileSystemProvider
    Stringarrow-up-right
    IFileSystemProvider
    FileDialogLoadPathEventHandler
    public class FolderBrowserDialog : CommonDialog

    data

    The data associated with this event.

    location

    The that indicates the location of the drag event.

    allowedEffect

    DragDropEffects

    One of the DragDropEffects values.

    effect

    DragDropEffects

    One of the DragDropEffects values.

    DragEventHandler

    Represents the method that will handle the DragDrop, DragEnter, or DragOver event of a Control.

    DragEventArgs
    DragDropEffects
    Stringarrow-up-right
    IANA Media Typesarrow-up-right
    IDataObject
    IDataObject
    Control
    DoDragDrop
    Objectarrow-up-right
    DragDropEffects
    HttpFileCollection
    HttpFileCollection
    Imagearrow-up-right
    Sizearrow-up-right
    Stringarrow-up-right
    Int32arrow-up-right
    Pointarrow-up-right
    Int32arrow-up-right
    Int32arrow-up-right

    y

    y-coordinate of the hotspot location.

    y

    y-coordinate of the hotspot location.

    y

    y-coordinate of the hotspot location.

    image

    Imagearrow-up-right

    An Imagearrow-up-right to use for the cursor.

    source

    Stringarrow-up-right

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

    stream

    Streamarrow-up-right

    A Streamarrow-up-right to use for the cursor.

    image

    Imagearrow-up-right

    An Imagearrow-up-right to use for the cursor.

    x

    Int32arrow-up-right

    x-coordinate of the hotspot location.

    stream

    Streamarrow-up-right

    A Streamarrow-up-right to use for the cursor.

    x

    Int32arrow-up-right

    x-coordinate of the hotspot location.

    source

    Stringarrow-up-right

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

    x

    Int32arrow-up-right

    x-coordinate of the hotspot location.

    Imagearrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Stringarrow-up-right
    Pointarrow-up-right

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

    Allows an object to serialize itself.

    text

    Stringarrow-up-right

    The text for the tab.

    control

    Control

    The Control to look for.

    IBindableComponent

    Bindable components implement this interface.

    IImage

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

    IWisejComponent

    All wisej components implement this interface.

    Public Class AccordionPanel
        Inherits Panel
    ScrollableControl
    Panel
    AccordionPanel
    Accordion
    AccordionPanel
    AccordionPanel
    Accordion
    Accordion
    Booleanarrow-up-right
    AccordionPanel
    Booleanarrow-up-right
    Stringarrow-up-right
    AccordionPanel
    ComponentToolCollection
    ComponentToolCollection
    Control
    AccordionPanel
    AccordionPanel
    Control
    public class AccordionPanel : Panel

    hashtag
    Constructors

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

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

    hashtag
    Properties

    hashtag
    Button

    MouseButtons: Returns which mouse button was pressed.

    hashtag
    Clicks

    Int32arrow-up-right: Returns the number of clicks or taps.

    hashtag
    Delta

    Int32arrow-up-right: Returns the number of times the mouse wheel has rotated.

    hashtag
    Location

    Pointarrow-up-right: Returns the location of the mouse or pointer event.

    hashtag
    OriginalTarget

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

    hashtag
    Role

    Stringarrow-up-right: 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.

    hashtag
    X

    Int32arrow-up-right: Returns the x-coordinate of the mouse or touch event.

    hashtag
    Y

    Int32arrow-up-right: Returns the y-coordinate of the mouse or touch event.

    hashtag
    Used By

    Name
    Description

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

    Public Class MouseEventArgs
        Inherits EventArgs
    MouseUp
    MouseDown
    MouseMove
    public class MouseEventArgs : EventArgs
    ButtonBase
    • RadioButton

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

    public class RadioButton : ButtonBase, IReadOnly
    Public Class RadioButton
        Inherits ButtonBase
        Implements IReadOnly

    hashtag
    Constructors

    hashtag
    RadioButton()

    Initializes a new instance of the RadioButton class.

    hashtag
    Properties

    hashtag
    Appearance

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

    hashtag
    AutoCheck

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

    hashtag
    AutoSize

    Booleanarrow-up-right: Returns or sets a value that indicates whether the control resizes based on its contents.

    hashtag
    CheckAlign

    ContentAlignmentarrow-up-right: Returns or sets the horizontal and vertical alignment of the check mark on a CheckBox control.

    hashtag
    Checked

    Booleanarrow-up-right: Gets or sets whether the control is checked.

    hashtag
    CheckedForeColor

    Colorarrow-up-right: Returns or sets the text color used when the RadioButton is checked.

    hashtag
    Invalid

    Booleanarrow-up-right: Returns or sets a value that indicates that the control is invalid.

    hashtag
    InvalidMessage

    Stringarrow-up-right: Returns or sets the invalid message that is shown in the invalid tooltip.

    hashtag
    ReadOnly

    Booleanarrow-up-right: Returns or sets whether the control is read-only.

    hashtag
    TabStop

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

    hashtag
    TextAlign

    ContentAlignmentarrow-up-right: Returns or sets the alignment of the text on the CheckBox control.

    hashtag
    Methods

    hashtag
    PerformClick()

    Generates a Click event for a RadioButton.

    hashtag
    Events

    hashtag
    AppearanceChanged

    EventHandlerarrow-up-right Fired when the value of the Appearance property changes.

    hashtag
    CheckedChanged

    EventHandlerarrow-up-right Fired when the value of the Checked property changes.

    hashtag
    ReadOnlyChanged

    EventHandlerarrow-up-right Fired when the value of the ReadOnly property has changed.

    hashtag
    Implements

    Name
    Description

    Bindable components implement this interface.

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

    Provides access to the property for coontrols that support the read-only mode.

    Control
    ButtonBase
    • Button

    Represents a button control.

    public class Button : ButtonBase, IButtonControl,
    Public Class Button
        Inherits ButtonBase
        Implements IButtonControl, ICommandSource

    hashtag
    Constructors

    hashtag
    Button()

    Initializes a new instance of the Button class.

    hashtag
    Properties

    hashtag
    AutoSizeMode

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

    hashtag
    BorderStyle

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

    hashtag
    Command

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

    hashtag
    DialogResult

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

    hashtag
    Display

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

    hashtag
    ImageSpacing

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

    hashtag
    MenuItems

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

    hashtag
    Repeat

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

    hashtag
    Shortcut

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

    hashtag
    Methods

    hashtag
    PerformClick()

    Generates a Click event for a button.

    hashtag
    Events

    hashtag
    CommandChanged

    EventHandlerarrow-up-right Fired when the Command property value changes.

    hashtag
    ItemClicked

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

    hashtag
    Inherited By

    Name
    Description

    Represents a split button control.

    hashtag
    Implements

    Name
    Description

    Bindable components implement this interface.

    Allows a control to act like a button on a .

    Defines an object that can invoke a .

    Control
    hashtag
    Parameters
    Name
    Type
    Description

    sender

    The source of an event.

    e

    A that contains the event data.

    hashtag
    Fired By

    Name
    Description

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

    Public Delegate Sub QueryContinueDragEventHandler(ByVal sender As [Object], ByVal e As QueryContinueDragEventArgs)
    QueryContinueDrag
    Control
    public delegate void QueryContinueDragEventHandler(Object sender, QueryContinueDragEventArgs e)

    ButtonBase

    Wisej.Web.ButtonBase

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

    Implements the basic functionality common to button controls.

    hashtag
    Constructors

    hashtag
    ButtonBase()

    Initializes a new instance of the class.

    hashtag
    Properties

    hashtag
    AllowHtml

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

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

    hashtag
    AutoEllipsis

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

    hashtag
    AutoShowLoader

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

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

    hashtag
    AutoSize

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

    hashtag
    CharacterCasing

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

    hashtag
    Image

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

    hashtag
    ImageAlign

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

    hashtag
    ImageIndex

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

    Throws:

    • The specified index is less than -1.

    hashtag
    ImageKey

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

    hashtag
    ImageList

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

    hashtag
    ImageSource

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

    hashtag
    Text

    : Returns or sets the text associated with this control.

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

    hashtag
    TextAlign

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

    hashtag
    TextImageRelation

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

    hashtag
    UseMnemonic

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

    hashtag
    Methods

    hashtag
    PerformClick()

    Generates a event for a button.

    hashtag
    Inherited By

    Name
    Description

    hashtag
    Implements

    Name
    Description

    CheckBox

    Wisej.Web.CheckBox

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

    Represents a check box control.

    hashtag
    Constructors

    hashtag
    CheckBox()

    Initializes a new instance of the class.

    hashtag
    Properties

    hashtag
    Appearance

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

    hashtag
    AutoCheck

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

    hashtag
    AutoSize

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

    hashtag
    CheckAlign

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

    hashtag
    Checked

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

    hashtag
    CheckedForeColor

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

    hashtag
    CheckState

    : Returns or sets the state of the .

    hashtag
    Invalid

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

    hashtag
    InvalidMessage

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

    hashtag
    ReadOnly

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

    hashtag
    TextAlign

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

    hashtag
    ThreeState

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

    hashtag
    Methods

    hashtag
    PerformClick()

    Generates a event for a .

    hashtag
    Events

    hashtag
    AppearanceChanged

    Fired when the value of the property changes.

    hashtag
    CheckedChanged

    Fired when the value of the property changes.

    hashtag
    CheckStateChanged

    Fired when the value of the property changes.

    hashtag
    ReadOnlyChanged

    Fired when the value of the property has changed.

    hashtag
    Implements

    Name
    Description

    FileDialogUI

    Wisej.Web.FileDialogUI

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Objectarrow-up-right
    Pointarrow-up-right
    Pointarrow-up-right
    Int32arrow-up-right
    Int32arrow-up-right
    Int32arrow-up-right
    IWisejControl
    Control
    IWisejSerializable
    Objectarrow-up-right
    QueryContinueDragEventArgs
    QueryContinueDragEventArgs
    Control.QueryContinueDrag

    x

    Int32arrow-up-right

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

    y

    Int32arrow-up-right

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

    delta

    Int32arrow-up-right

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

    x

    Int32arrow-up-right

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

    y

    Int32arrow-up-right

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

    delta

    Int32arrow-up-right

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

    role

    Stringarrow-up-right

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

    MouseButtons
    MouseButtons
    Int32arrow-up-right
    MouseButtons
    MouseButtons
    Int32arrow-up-right
    MouseEventHandler

    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.

    IBindableComponent
    IImage
    IReadOnly
    ReadOnly
    ICommandSource

    IImage

    Provides access to common image properties across the controls that 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.

    SplitButton
    IBindableComponent
    IButtonControl
    Form
    ICommandSource
    Command

    Containers

    Represents a split button control.

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

    Allows an object to serialize itself.

    Button

    Represents a button control.

    CheckBox

    Represents a check box control.

    RadioButton

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

    IBindableComponent

    Bindable components implement this interface.

    IImage

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

    IWisejComponent

    All wisej components implement this interface.

    Public Class ButtonBase
        Inherits Control
        Implements IImage
    ButtonBase
    ButtonBase
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    AutoShowLoader
    ShowLoader
    Booleanarrow-up-right
    CharacterCasing
    Imagearrow-up-right
    ContentAlignmentarrow-up-right
    Int32arrow-up-right
    ImageList
    ArgumentOutOfRangeExceptionarrow-up-right
    Stringarrow-up-right
    ImageList
    ImageList
    ImageList
    Imagearrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    ContentAlignmentarrow-up-right
    TextImageRelation
    Booleanarrow-up-right
    Click
    public class ButtonBase : Control, IImage

    All wisej components implement this interface.

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

    Allows an object to serialize itself.

    IBindableComponent

    Bindable components implement this interface.

    IImage

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

    IReadOnly

    Provides access to the ReadOnly property for coontrols that support the read-only mode.

    Public Class CheckBox
        Inherits ButtonBase
        Implements IReadOnly
    ButtonBase
    CheckBox
    CheckBox
    Appearance
    CheckBox
    Booleanarrow-up-right
    Checked
    CheckState
    CheckBox
    CheckBox
    Booleanarrow-up-right
    ContentAlignmentarrow-up-right
    CheckBox
    Booleanarrow-up-right
    CheckBox
    Colorarrow-up-right
    CheckBox
    CheckState
    CheckBox
    Booleanarrow-up-right
    Stringarrow-up-right
    Booleanarrow-up-right
    ContentAlignmentarrow-up-right
    CheckBox
    Booleanarrow-up-right
    CheckBox
    Click
    CheckBox
    EventHandlerarrow-up-right
    Appearance
    EventHandlerarrow-up-right
    Checked
    EventHandlerarrow-up-right
    CheckState
    EventHandlerarrow-up-right
    ReadOnly
    public class CheckBox : ButtonBase, IReadOnly

    ScrollableControl
    • ContainerControl

      • Form

        • FileDialogUI

    UI implementation for the FileDialog class.

    public class FileDialogUI : Form
    Public Class FileDialogUI
        Inherits Form

    hashtag
    Constructors

    hashtag
    FileDialogUI()

    hashtag
    FileDialogUI(fileDialog)

    Name
    Type
    Description

    fileDialog

    hashtag
    Implements

    Name
    Description

    Bindable components implement this interface.

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

    All wisej components implement this interface.

    Control

    ContainerControl

    Wisej.Web.ContainerControl

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

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

    hashtag
    Constructors

    hashtag
    ContainerControl()

    Initializes a new instance of the class.

    hashtag
    Properties

    hashtag
    Accelerators

    : Returns or sets a collection of keys that fire the Accelerator event when the user presses the accelerator key while the focus is on any child control.

    hashtag
    ActiveControl

    : Returns or sets the active control on the container control.

    Throws:

    • The assigned could not be activated.

    hashtag
    BindingContext

    : Returns or sets the BindingContext for the control.

    hashtag
    KeyPreview

    : Returns or sets whether the container will receive key events before the event is passed to the control that has focus.

    hashtag
    ParentForm

    : Returns the that the container control is assigned to.

    hashtag
    ParentPage

    : Returns the that the container control is assigned to.

    hashtag
    RightToLeftLayout

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

    hashtag
    Methods

    hashtag
    Validate()

    Validates the last unvalidated control and its ancestors up through, but not including the current control.

    Returns: .

    hashtag
    Validate(checkAutoValidate)

    Validates the last unvalidated control and its ancestors up through, but not including the current control.

    Parameter
    Type
    Description

    Returns: .

    hashtag
    Events

    hashtag
    Accelerator

    Fired when one of the key is pressed.

    hashtag
    RightToLeftLayoutChanged

    Fired when the value of the property changes.

    hashtag
    Inherited By

    Name
    Description

    hashtag
    Implements

    Name
    Description

    CommonDialog

    Wisej.Web.CommonDialog

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Specifies the base class used for displaying dialog boxes on the screen.

    public class CommonDialog : Component
    Public Class CommonDialog
        Inherits Component

    hashtag
    Constructors

    hashtag
    CommonDialog()

    Initializes a new instance of .

    hashtag
    CommonDialog(container)

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

    Name
    Type
    Description

    hashtag
    Properties

    hashtag
    DialogTemplate

    : Returns or sets the type of the common dialog UI control to show when calling the method.

    hashtag
    Tag

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

    hashtag
    Title

    : Returns or sets the dialog box title.

    hashtag
    WindowState

    : Returns or sets the initial of the common dialog.

    hashtag
    Methods

    hashtag
    Reset()

    When overridden in a derived class, resets the properties of a common dialog box to their default values.

    hashtag
    ShowDialog()

    Runs a common dialog box with a default owner.

    Returns: . if the user clicks OK in the dialog box; otherwise, .

    hashtag
    ShowDialog(onclose)

    Runs a common dialog box with a default owner.

    Parameter
    Type
    Description

    Returns: . if the user clicks OK in the dialog box; otherwise, .

    hashtag
    ShowDialog(owner)

    Runs a common dialog box with the specified owner.

    Parameter
    Type
    Description

    Returns: . if the user clicks OK in the dialog box; otherwise, .

    hashtag
    ShowDialog(owner, onclose)

    Runs a common dialog box with the specified owner.

    Parameter
    Type
    Description

    Returns: . if the user clicks OK in the dialog box; otherwise, .

    hashtag
    ShowDialogAsync(owner)

    Runs a common dialog box with the specified owner asynchronously.

    Parameter
    Type
    Description

    Returns: . if the user clicks OK in the dialog box; otherwise, .

    hashtag
    Events

    hashtag
    HelpRequested

    Fired when the user clicks the Help button on a common dialog box.

    hashtag
    Inherited By

    Name
    Description
    SplitButton
    IWisejControl
    Control
    IWisejSerializable
    IWisejComponent
    IWisejControl
    Control
    IWisejSerializable

    IWisejControl

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

    IWisejWindow

    All wisej top-level windows implement this interface.

    IWisejSerializable

    Allows an object to serialize itself.

    FileDialog
    IBindableComponent
    IContainerControl
    IWisejComponent

    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 control consisting of a movable bar that divides a container's display area into two resizable panels.

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

    Displays data in a customizable list format.

    Represents a desktop container that can host floating windows.

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

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

    Allows an object to serialize itself.

    checkAutoValidate

    Booleanarrow-up-right

    If true, the value of the AutoValidate property is used to determine if validation should be performed; if false, validation is unconditionally performed.

    FileDialogUI

    UI implementation for the FileDialog class.

    FolderBrowserDialogUI

    UI implementation for the FolderDialog class.

    Form

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

    IBindableComponent

    Bindable components implement this interface.

    IContainerControl

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

    IWisejComponent

    All wisej components implement this interface.

    Public Class ContainerControl
        Inherits ScrollableControl
        Implements IContainerControl, IContainerControl
    ScrollableControl
    ContainerControl
    ContainerControl
    Keys[]
    Control
    ArgumentExceptionarrow-up-right
    Control
    BindingContext
    Booleanarrow-up-right
    Form
    Form
    Page
    Page
    Booleanarrow-up-right
    RightToLeft
    Yes
    Booleanarrow-up-right
    Booleanarrow-up-right
    AcceleratorEventHandler
    Accelerators
    EventHandlerarrow-up-right
    RightToLeftLayout
    public class ContainerControl : ScrollableControl, IContainerControl, IContainerControl

    Prompts the user to open a file from the server.

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

    container

    IContainerarrow-up-right

    An IContainerarrow-up-right that represents the container of the CommonDialog component.

    onclose

    Action<DialogResult>arrow-up-right

    Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event. When the onclose event handler is specified, the modal dialog doesn't suspend the execution on the server but it's still shown as a modal dialog on the client.

    owner

    Form

    A Form that represents the top-level window that owns the modal dialog box. It can be null.

    owner

    Form

    A Form that represents the top-level window that owns the modal dialog box. It can be null.

    onclose

    Action<DialogResult>arrow-up-right

    Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event. When the onclose event handler is specified, the modal dialog doesn't suspend the execution on the server but it's still shown as a modal dialog on the client.

    owner

    Form

    A Form that represents the top-level window that owns the modal dialog box. It can be null.

    ColorDialog

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

    FileDialog

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

    FolderBrowserDialog

    Allows the user to select a folder from one of the Roots.

    CommonDialog
    CommonDialog
    Typearrow-up-right
    ShowDialog
    Objectarrow-up-right
    Stringarrow-up-right
    FormWindowState
    WindowState
    DialogResult
    OK
    Cancel
    DialogResult
    OK
    Cancel
    DialogResult
    OK
    Cancel
    DialogResult
    OK
    Cancel
    Task<DialogResult>arrow-up-right
    OK
    Cancel
    EventHandlerarrow-up-right

    Configuration

    Wisej.Core.Configuration

    Namespace: Wisej.Core

    Assembly: Wisej.Framework (3.0.0.0)

    Wisej configuration settings.

    hashtag

    Page
    SplitContainer
    UserControl
    DataRepeater
    Desktop
    UserPopup
    IWisejControl
    Control
    IWisejSerializable
    OpenFileDialog
    SaveFileDialog
    Constructors

    hashtag
    Configuration(json)

    Creates a new instance from the specified json string.

    Name
    Type
    Description

    json

    The json string that defines the configuration values.

    hashtag
    Properties

    hashtag
    AllowedRoutes

    String[]arrow-up-right: List of allowed Url routes separated by a semicolon. i.e.: "api;product;log/performance".

    hashtag
    AutoReload

    Booleanarrow-up-right: When true, the application is automatically reloaded when the session expires or Exit is called.

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

    hashtag
    BrowserCheck

    Stringarrow-up-right: The custom function used to validate the browser. If it returns false the browser is not supported and Wisej redirects to NotSupportedUrl.

    hashtag
    Culture

    Stringarrow-up-right: Returns the culture set at the application's level. It can be any of the supported cultures or the keyword "auto", in which case we will detect the culture from the browser.

    hashtag
    Debug

    Booleanarrow-up-right: Enabled/disables debug mode.

    hashtag
    DisableClientObjectModel

    Booleanarrow-up-right: When true, the client will not be able to access the application's controls using the object model registered with javascript under the "App" namespace.

    hashtag
    DropDuplicateClicks

    Booleanarrow-up-right: When true, the client drops all "execute" events triggered while there is a pending request.

    hashtag
    EmbeddedResourcesCacheControl

    Stringarrow-up-right: Cache-Control for embedded resources. The default is "browser" to cache the embedded resources on the browser for 1 month. Other allowed vaues are: - "server" to cache the resources on the server using the ETag header - "private, max-age=..." to use set the standard Cache-Control header - any value Cache-Control string value.

    hashtag
    EnablePWA

    Booleanarrow-up-right: Enables the PWA installation of the application.

    hashtag
    EnableWebSocket

    Booleanarrow-up-right: Enabled/disables the WebSocket protocol.

    hashtag
    EnableWebSocketCompression

    Booleanarrow-up-right: Enabled/disables gzip compression when using the WebSocket protocol.

    hashtag
    FilePath

    Stringarrow-up-right: The full path of the configuration file.

    hashtag
    Impersonate

    Booleanarrow-up-right: Enables impersonation mode.

    When set to true and windows authentication is configured in web.config, every request thread and application tasks started using Application.StartTask will impersonate the current user.

    hashtag
    KeepAliveInterval

    Int32arrow-up-right: The keep-alive interval in seconds.

    hashtag
    LoaderTimeout

    Int32arrow-up-right: The ajax loader timeout in milliseconds.

    hashtag
    MainWindow

    Stringarrow-up-right: Full name of the first window created automatically at startup.

    hashtag
    MaxModalStack

    Int32arrow-up-right: Returns the maximum number of nested modal loops.

    hashtag
    MaxSessions

    Int32arrow-up-right: Returns the maximum number of active sessions before redirecting to NotAvailableUrl.

    hashtag
    NetworkCheckInterval

    Int32arrow-up-right: Network check interval in milliseconds. The default is 1000 (1 second). If this value is set, Wisej will send a /healthcheck.wx request at the specified interval when the application goes offline.

    hashtag
    NotAvailableUrl

    Stringarrow-up-right: The URL of the page to load when the server cannot respond to the request.

    hashtag
    NotSupportedUrl

    Stringarrow-up-right: The URL of the page to load when the client browser is not supported.

    hashtag
    OfflineUrl

    Stringarrow-up-right: The URL of the page to load when the connection is lost.

    hashtag
    Options

    Objectarrow-up-right: Native client-side platform options.

    hashtag
    PollingInterval

    Int32arrow-up-right: Polling interval in milliseconds. The default is zero (disabled). If this value is set, the polling starts when the application is loaded.

    The polling interval determines the frequency of the automatic poll requests coming from the client when a WebSocket connection is not available. When the client is connected using a WebSocket channel, this value is ignored. An application that wants to enable automatic client updates in absence of a WebSocket connection can set this value, or it can call StartPolling and EndPolling to start and terminate the automatic polling from the client. Both methods are ignored when the client is using a WebSocket connection.

    hashtag
    ResponseTimeout

    Int32arrow-up-right: The timeout for the server to respond to a wisej request in seconds.

    hashtag
    RightToLeft

    Stringarrow-up-right: Returns the rightToLeft mode. It can be "true", "false", or "auto". When set to "auto" the RightToLeft layout is enabled automatically using the current language. The default is "auto".

    hashtag
    Secure

    Booleanarrow-up-right: Forces the client to switch to a secure connection (HTTPS and WSS).

    hashtag
    SessionStorage

    Stringarrow-up-right: Where to save the session id on the client. The default is "session" to indicate the browser's sessionStorage. It can be changed to "local" to indicate the browser's localStorage.

    hashtag
    SessionTimeout

    Int32arrow-up-right: The session timeout in seconds. The timeout is enforced on the client side.

    hashtag
    Settings

    Objectarrow-up-right: Application settings.

    hashtag
    ShowLoader

    Booleanarrow-up-right: Shows the loader animated gif while initializing the application.

    hashtag
    Standalone

    Booleanarrow-up-right: Returns whether this Wisej application is running in a standalone host (Wisej.Application.exe).

    hashtag
    StartUp

    Stringarrow-up-right: The startup Main method.

    hashtag
    ThemeName

    Stringarrow-up-right: Theme name.

    hashtag
    ThreadPool

    Objectarrow-up-right: ThreadPool min/max configuration, null by default.

    hashtag
    Url

    Stringarrow-up-right: Url redirection.

    hashtag
    ValidateClient

    Booleanarrow-up-right: Verifies the client fingerprint when retrieving a session. It prevents session hijacking over unsecured connections.

    hashtag
    Methods

    hashtag
    GetInstance(filePath)

    Loads or retrieves the configuration file.

    Parameter
    Type
    Description

    filePath

    The full path to the .json file to load.

    Returns: Configuration.

    hashtag
    Events

    hashtag
    LoadConfiguration

    LoadConfigurationEventHandler Fired when the system needs to load a Wisej configuration file.

    An application can install a custom configuration handler and return a custom Configuration object. This is a static event and should be attached to before the application starts. One way to do that is to register an HttpModul with IIS, or a middleware for .NET Core, and attach to the event there.

    Public Class Configuration
    public class Configuration

    FileDialog

    Wisej.Web.FileDialog

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • CommonDialog

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

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

    • Override . It's called when the specified file doesn't exist and the property is true.

    • Override to create your custom when the method is called.

    • Set the to a class that has a constructor that accepts

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

    hashtag
    Constructors

    hashtag
    FileDialog()

    Initializes a new instance of .

    hashtag
    FileDialog(roots)

    Initializes a new instance of using the initial roots .

    Name
    Type
    Description

    hashtag
    FileDialog(container)

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

    Name
    Type
    Description

    hashtag
    Properties

    hashtag
    AddExtension

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

    hashtag
    CheckFileExists

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

    hashtag
    DefaultExtension

    : Returns or sets the default file name extension.

    hashtag
    FileName

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

    hashtag
    FileNames

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

    hashtag
    FileSystem

    : Returns the that contains the selected .

    hashtag
    Filter

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

    hashtag
    FilterIndex

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

    hashtag
    InitialDirectory

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

    hashtag
    Roots

    : List of root file systems displayed by the FileDialog.

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

    hashtag
    ShowHelp

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

    hashtag
    Title

    : Returns or sets the file dialog box title.

    hashtag
    Methods

    hashtag
    GetRoot(path)

    Returns the that contains the specified path .

    Parameter
    Type
    Description

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

    hashtag
    MapPath(filePath)

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

    Parameter
    Type
    Description

    Returns: . The physical path for the implementation.

    hashtag
    ProcessFileNames(fileNames)

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

    Parameter
    Type
    Description

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

    hashtag
    Reset()

    Resets all properties to their default values.

    hashtag
    Events

    hashtag
    FileOk

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

    hashtag
    LoadPath

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

    hashtag
    Inherited By

    Name
    Description
      <script>
        Wisej.onExit = function() {
          // this is the default implementation
          // when AutoReload is set to true.
          location.reload();
        }
      </script>
    [assembly: PreApplicationStartMethod(typeof(ApplicationNameSpace.HttpModuleStartup), "Start")]
    
    namespace ApplicationNameSpace
    {
      public static class HttpModuleStartup
      {
        public static void Start()
        {
          Wisej.Core.Configuration.LoadConfiguration += (s, e) =>
          {
            // load json from a file, or build a json object.
            // you can also implement your own caching mechanism here.
            
            e.SuppressCache = true;
            
            return new Wisej.Core.Configuration(new
            {
              url = "Default.html",
              theme = "bootstrap-4",
              startup = "ApplicationNameSpace.Program.Main, Application"
              
            }.ToJSON());
          }
        }
      }
    }
    Stringarrow-up-right
    Stringarrow-up-right
    as the single argument to change the User Interface (UI) of the file dialog.
  • Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.

  • roots

    IFileSystemProvider[]

    Initial file systems to load in the FolderBrowserDialog.

    container

    IContainerarrow-up-right

    An IContainerarrow-up-right that represents the container of the FileDialog component.

    path

    Stringarrow-up-right

    Full path of the file to locate in on of the Roots.

    filePath

    Stringarrow-up-right

    Virtual path to map to the corresponding physical path.

    fileNames

    String[]arrow-up-right

    Array containing the selected file paths.

    OpenFileDialog

    Prompts the user to open a file from the server.

    SaveFileDialog

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

    Public Class FileDialog
        Inherits CommonDialog
    FileDialog
    OpenFileDialog
    SaveFileDialog
    OpenFileDialog
    SaveFileDialog
    PromptFileNotFound
    CheckFileExists
    CreateUI
    Form
    ShowDialog
    DialogTemplate
    Form
    FileDialog
    FileSystemProvider
    Roots
    FileDialog
    FileDialog
    FileDialog
    Booleanarrow-up-right
    Booleanarrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    String[]arrow-up-right
    IFileSystemProvider
    IFileSystemProvider
    FileName
    Stringarrow-up-right
    Int32arrow-up-right
    Stringarrow-up-right
    FileDialogRootCollection
    IFileSystemProvider
    IFileSystemProvider
    Booleanarrow-up-right
    Stringarrow-up-right
    IFileSystemProvider
    IFileSystemProvider
    IFileSystemProvider
    IFileSystemProvider
    Stringarrow-up-right
    IFileSystemProvider
    FileDialog
    Booleanarrow-up-right
    CancelEventHandlerarrow-up-right
    FileDialogLoadPathEventHandler
    public class FileDialog : CommonDialog

    Control.ControlCollection

    Wisej.Web.Control ControlCollection

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Represents a collection of Control objects.

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

    hashtag
    Constructors

    hashtag
    ControlCollection(owner)

    Initializes a new instance of the class.

    Name
    Type
    Description

    hashtag
    Properties

    hashtag
    IsDisposed

    : Returns whether the owner control has already been disposed.

    hashtag
    Item(index)

    : Returns the at the specified indexed location.

    hashtag
    Item(key)

    : Returns the with the specified key in the collection.

    hashtag
    Owner

    : Returns the control that owns this .

    hashtag
    Methods

    hashtag
    Add(child)

    Adds the specified control to the control collection.

    Parameter
    Type
    Description

    hashtag
    AddRange(controls)

    Adds an array of control objects to the collection.

    Parameter
    Type
    Description

    hashtag
    Clear()

    Removes all controls from the collection.

    hashtag
    Clear(dispose)

    Removes and disposes all controls from the collection.

    Parameter
    Type
    Description

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

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

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

    hashtag
    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 ("").

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

    hashtag
    GetEnumerator()

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

    Returns: . An .

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

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

    hashtag
    Remove(child)

    Removes the specified control from the control collection.

    Parameter
    Type
    Description

    hashtag
    RemoveByKey(key)

    Removes the child control with the specified key.

    Parameter
    Type
    Description

    hashtag
    SetChildIndex(child, newIndex)

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

    Parameter
    Type
    Description

    hashtag
    Inherited By

    Name
    Description

    Accordion

    Wisej.Web.Accordion

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    • Control

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

    hashtag
    Constructors

    hashtag
    Accordion()

    Initializes a new instance of the class.

    hashtag
    Properties

    hashtag
    BorderStyle

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

    hashtag
    Collapsible

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

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

    hashtag
    DisplayRectangle

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

    hashtag
    HeaderSize

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

    hashtag
    ImageList

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

    hashtag
    PanelCount

    : Returns the number of panels in the container.

    hashtag
    Panels

    : Returns the collection of panels in the container.

    hashtag
    SelectedIndex

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

    Throws:

    • The value is less than -1.

    hashtag
    SelectedOnTop

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

    hashtag
    SelectedPanel

    : Returns or sets the currently selected panel.

    hashtag
    ShowToolTips

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

    hashtag
    Methods

    hashtag
    DeselectPanel(index)

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

    Parameter
    Type
    Description

    Throws:

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

    hashtag
    DeselectPanel(panel)

    Makes the following the specified the current panel.

    Parameter
    Type
    Description

    Throws:

    • panel is null.

    hashtag
    DeselectPanel(panelName)

    Makes the following the the specified name the current panel.

    Parameter
    Type
    Description

    Throws:

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

    hashtag
    GetControl(index)

    Returns the panel at the specified location.

    Parameter
    Type
    Description

    Returns: . The at the specified location.

    Throws:

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

    hashtag
    SelectPanel(index)

    Makes the with the specified index the current .

    Parameter
    Type
    Description

    Throws:

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

    hashtag
    SelectPanel(panel)

    Makes the specified the current .

    Parameter
    Type
    Description

    Throws:

    • panel is null.

    hashtag
    SelectPanel(panelName)

    Makes with the specified name the current .

    Parameter
    Type
    Description

    Throws:

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

    hashtag
    Events

    hashtag
    Deselected

    Fired when a panel is deselected.

    hashtag
    Deselecting

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

    hashtag
    Selected

    Fired when a panel is selected.

    hashtag
    SelectedIndexChanged

    Fired when the property has changed.

    hashtag
    Selecting

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

    hashtag
    Implements

    Name
    Description

    Padding

    Wisej.Web.Padding

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

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

    hashtag

    Component

    Wisej.Web.Component

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Control
    >,
    ICollection
    <
    Control
    >,
    IEnumerable
    <
    Control
    >,
    IWisejSynchronized

    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

    Booleanarrow-up-right

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

    control

    Control

    The Control to locate in the collection.

    key

    Stringarrow-up-right

    The key to locate in the ControlCollection.

    type

    Typearrow-up-right

    The type of the controls to locate in the ControlCollection.

    searchAllChildren

    Booleanarrow-up-right

    true to search all child controls; otherwise, false.

    key

    Stringarrow-up-right

    The key to located in the ControlCollection.

    searchAllChildren

    Booleanarrow-up-right

    true to search all child controls; otherwise, false.

    child

    Control

    The Control to search for in the control collection.

    throwException

    Booleanarrow-up-right

    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

    Stringarrow-up-right

    The name of the control to search for.

    child

    Control

    The Control to remove.

    key

    Stringarrow-up-right

    The name of the child control to remove.

    child

    Control

    The child control to search for.

    newIndex

    Int32arrow-up-right

    The new index value of the control.

    TableLayoutControlCollection

    Represents a collection of child controls in a table layout container.

    ControlCollection
    Booleanarrow-up-right
    Control
    Control
    Control
    Control
    Control
    ControlCollection
    Booleanarrow-up-right
    Control
    ControlCollection
    Booleanarrow-up-right
    ControlCollection
    Control[]
    ArgumentNullExceptionarrow-up-right
    Control[]
    ArgumentNullExceptionarrow-up-right
    Int32arrow-up-right
    Control
    ControlCollection
    ArgumentExceptionarrow-up-right
    Control
    ControlCollection
    ControlCollection
    IEnumeratorarrow-up-right
    IEnumeratorarrow-up-right
    Int32arrow-up-right
    Control
    ControlCollection
    Int32arrow-up-right

    Allows an object to serialize itself.

    index

    Int32arrow-up-right

    The index in the Panels collection of the AccordionPanel to deselect.

    panel

    AccordionPanel

    The AccordionPanel to deselect.

    panelName

    Stringarrow-up-right

    The Name of the panel to deselect.

    index

    Int32arrow-up-right

    The index of the AccordionPanel to get.

    index

    Int32arrow-up-right

    The index in the Panels collection of the tab to select.

    panel

    AccordionPanel

    The AccordionPanel to select.

    panelName

    Stringarrow-up-right

    The Name of the tab to select.

    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.

    Public Class Accordion
        Inherits Control
        Implements ISupportInitialize
    Accordion
    AccordionPanel
    Accordion
    BorderStyle
    Accordion
    Booleanarrow-up-right
    AccordionPanel
    Rectanglearrow-up-right
    Int32arrow-up-right
    ImageList
    Int32arrow-up-right
    PanelCollection
    Int32arrow-up-right
    ArgumentOutOfRangeExceptionarrow-up-right
    Booleanarrow-up-right
    Accordion
    AccordionPanel
    Booleanarrow-up-right
    AccordionPanel
    AccordionPanel
    ArgumentOutOfRangeExceptionarrow-up-right
    AccordionPanel
    Panels
    AccordionPanel
    AccordionPanel
    ArgumentNullExceptionarrow-up-right
    AccordionPanel
    AccordionPanel
    ArgumentNullExceptionarrow-up-right
    Name
    AccordionPanel
    Panels
    AccordionPanel
    Control
    AccordionPanel
    ArgumentOutOfRangeExceptionarrow-up-right
    AccordionPanel
    Panels
    AccordionPanel
    AccordionPanel
    ArgumentOutOfRangeExceptionarrow-up-right
    AccordionPanel
    Panels
    AccordionPanel
    AccordionPanel
    ArgumentNullExceptionarrow-up-right
    AccordionPanel
    AccordionPanel
    ArgumentNullExceptionarrow-up-right
    Name
    AccordionPanel
    Panels
    AccordionEventHandler
    AccordionCancelEventHandler
    AccordionEventHandler
    EventHandlerarrow-up-right
    SelectedIndex
    AccordionCancelEventHandler
    public class Accordion : Control, ISupportInitialize

    Constructors

    hashtag
    Padding(left, top, right, bottom)

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

    Name
    Type
    Description

    left

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

    top

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

    hashtag
    Padding(all)

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

    Name
    Type
    Description

    all

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

    hashtag
    Properties

    hashtag
    All

    Int32arrow-up-right: Returns or sets the padding value for all the edges.

    hashtag
    Bottom

    Int32arrow-up-right: Returns or sets the padding value for the bottom edge.

    hashtag
    Horizontal

    Int32arrow-up-right: Returns the combined padding for the right and left edges.

    hashtag
    IsEmpty

    Booleanarrow-up-right: Returns if the padding is empty.

    hashtag
    Left

    Int32arrow-up-right: Returns or sets the padding value for the left edge.

    hashtag
    Right

    Int32arrow-up-right: Returns or sets the padding value for the right edge.

    hashtag
    Size

    Sizearrow-up-right: Returns the padding information in the form of a Sizearrow-up-right.

    hashtag
    Top

    Int32arrow-up-right: Returns or sets the padding value for the top edge.

    hashtag
    Vertical

    Int32arrow-up-right: Returns the combined padding for the top and bottom edges.

    hashtag
    Methods

    hashtag
    Add(p1, p2)

    Computes the sum of the two specified Padding values.

    Parameter
    Type
    Description

    p1

    A .

    p2

    A .

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

    hashtag
    Subtract(p1, p2)

    Subtracts one specified Padding value from another.

    Parameter
    Type
    Description

    p1

    A .

    p2

    A .

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

    hashtag
    Used By

    Name
    Description

    Returns or sets padding within the control.

    Returns or sets the space between controls.

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

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

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

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

    hashtag
    Constructors

    hashtag
    Component()

    Default constructor

    hashtag
    Methods

    hashtag
    Update()

    Updates the component on the client.

    hashtag
    Inherited By

    Name
    Description

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

    Represents a component in the control's taskbar.

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

    hashtag
    Implements

    Name
    Description

    All wisej components implement this interface.

    Allows an object to serialize itself.

    Component

    Clipboard

    Wisej.Web.Clipboard

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

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

    public class Clipboard
    Public Class Clipboard

    hashtag
    Methods

    hashtag
    Clear()

    Removes all data from the Clipboard.

    hashtag
    ContainsAudio()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    hashtag
    SetAudio(audioBytes)

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

    Parameter
    Type
    Description

    Throws:

    • audioBytes is null.

    hashtag
    SetAudio(audioStream)

    Saves the in the format to the clipboard.

    Parameter
    Type
    Description

    Throws:

    • audioStream is null.

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

    hashtag
    SetData(format, data)

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

    Parameter
    Type
    Description

    Throws:

    • data is null.

    hashtag
    SetDataObject(data)

    Saves the specified data to the clipboard.

    Parameter
    Type
    Description

    Throws:

    • The value of data is null.

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

    hashtag
    SetImage(image)

    Saves the in the format to the clipboard

    Parameter
    Type
    Description

    Throws:

    • image is null.

    hashtag
    SetText(text)

    Saves the text data in the format to the clipboard.

    Parameter
    Type
    Description

    Throws:

    • text is null or .

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

    IWisejSerializable

    right

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

    bottom

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

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

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

    Returns or sets 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.

    Int32arrow-up-right
    Int32arrow-up-right
    Int32arrow-up-right
    Padding
    Padding
    Padding
    Padding
    Padding
    Padding
    Padding
    Padding
    Control.Padding
    Control.Margin
    DataGridViewCellStyle.Padding
    DataGridViewCell

    Represents a DateTime component in the control's taskbar.

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

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

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

    Allows controls to execute javascript code.

    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
    DesktopTaskBarItem
    Desktop
    DesktopTaskBarItemControl
    Desktop
    Control
    IWisejComponent
    IWisejSerializable

    format

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

    format

    One of the values.

    format

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

    format

    One of the values.

    audioBytes

    A array containing the audio data.

    audioStream

    A containing the audio data.

    text

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

    format

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

    data

    An representing the data to add.

    data

    The data to place on the Clipboard.

    filePaths

    A containing the file names.

    image

    The to add to the Clipboard.

    text

    The text to add to the Clipboard.

    text

    The text to add to the Clipboard.

    format

    One of the values.

    WaveAudio
    Booleanarrow-up-right
    Booleanarrow-up-right
    FileDrop
    Booleanarrow-up-right
    Bitmap
    Booleanarrow-up-right
    Text
    UnicodeText
    Booleanarrow-up-right
    TextDataFormat
    Booleanarrow-up-right
    Streamarrow-up-right
    Streamarrow-up-right
    WaveAudio
    Objectarrow-up-right
    Objectarrow-up-right
    IDataObject
    IDataObject
    StringCollectionarrow-up-right
    StringCollectionarrow-up-right
    FileDrop
    Imagearrow-up-right
    Imagearrow-up-right
    Bitmap
    Text
    UnicodeText
    Stringarrow-up-right
    Emptyarrow-up-right
    Text
    UnicodeText
    TextDataFormat
    Stringarrow-up-right
    Emptyarrow-up-right
    Bytearrow-up-right
    WaveAudio
    Streamarrow-up-right
    ArgumentNullExceptionarrow-up-right
    Streamarrow-up-right
    WaveAudio
    ArgumentNullExceptionarrow-up-right
    ArgumentNullExceptionarrow-up-right
    ArgumentNullExceptionarrow-up-right
    ArgumentNullExceptionarrow-up-right
    FileDrop
    ArgumentNullExceptionarrow-up-right
    ArgumentExceptionarrow-up-right
    InvalidPathCharsarrow-up-right
    InnerExceptionarrow-up-right
    ArgumentExceptionarrow-up-right
    Imagearrow-up-right
    Bitmap
    ArgumentNullExceptionarrow-up-right
    UnicodeText
    ArgumentNullExceptionarrow-up-right
    Emptyarrow-up-right
    TextDataFormat
    ArgumentNullExceptionarrow-up-right
    Int32arrow-up-right
    Int32arrow-up-right
    LabelWrapper.Padding
    UserPopup.Offset
    ListView.ItemPadding
    ListViewItem
    View
    StatusBarPanel.Padding
    ToolBarButton.Padding
    ToolBarButton.Margin
    Padding.Add
    Padding
    ClientTheme.GetInsets
    DesktopTaskBarItemDateTime
    Desktop
    Animation
    ErrorProvider
    HelpTip
    JavaScript
    Rotation
    Control
    StyleSheet
    ToolTip
    ImageList
    Imagearrow-up-right
    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
    Stringarrow-up-right
    DataFormats
    TextDataFormat
    TextDataFormat
    Stringarrow-up-right
    DataFormats
    TextDataFormat
    TextDataFormat
    Byte[]arrow-up-right
    Bytearrow-up-right
    Streamarrow-up-right
    Streamarrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    DataFormats
    Objectarrow-up-right
    Objectarrow-up-right
    Objectarrow-up-right
    StringCollectionarrow-up-right
    StringCollectionarrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    TextDataFormat
    TextDataFormat

    ClientTheme

    Wisej.Core.ClientTheme

    Namespace: Wisej.Core

    Assembly: Wisej.Framework (3.0.0.0)

    Represents a Wisej theme.

    public class ClientTheme : IWisejSerializable
    Public Class ClientTheme
        Inherits IWisejSerializable

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

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

    hashtag
    Constructors

    hashtag
    ClientTheme(name)

    Default private constructor.

    Name
    Type
    Description

    hashtag
    ClientTheme(name, json)

    Constructs a new theme from the name and JSON definition.

    Name
    Type
    Description

    hashtag
    ClientTheme(name, baseTheme)

    Constructs a new theme from the base theme.

    Name
    Type
    Description

    hashtag
    Properties

    hashtag
    Appearances

    : Theme appearances.

    This is a complex dynamic object with several child objects. The structure can get quite complicated. Before messing with the Appearances object, please study the structure of the themes using the ThemeBuilder or a text editor. Being a dynamic object, you can either create a new appearance or alter an existing appearance at any level.

    hashtag
    Colors

    : Theme colors.

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

    hashtag
    Fonts

    : Theme fonts.

    You can add or alter any font to the theme. The structure of the font definition can get complicated. Please refer to the existing themes and the ThemeBuilder to determine the structure to use. The simplest way is to change an existing theme font:

    hashtag
    Images

    : Theme images.

    You can add or change any theme image. Images in the theme are just URLs but can be defined in several ways:

    • Absolute URL An URL starting with http: or https: pointing to an image resource.

    • Relative URL An URL relative to the current site or relative to value of Images.baseUrl.

    • base64 A base64 encoded embedded image.

    hashtag
    Name

    : The name of the theme.

    hashtag
    Settings

    : Theme settings.

    The Settings property, added in Wisej 2, allows a theme to define certain internal properties. Currently these are the supported properties:

    • native-scrollbars Instructs Wisej to use the native scrollbars instead of the themed scrollbars. Setting this property can have negative side effects for virtual scrolling widgets like the DataGridView. The default is false.

    • overlapped-scrollbars Instructs Wisej to layout the scrollbars over the content being scrolled, similar to Windows' fluent themes or mobiles. The default is false.

    hashtag
    Stylesheet

    : Stylesheet rules embedded in the theme.

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

    hashtag
    Methods

    hashtag
    GetColor(appearance, name, state)

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

    Parameter
    Type
    Description

    Returns: . A representing the color in the theme.

    hashtag
    GetColor(name)

    Returns the resolved theme color from the color list.

    Parameter
    Type
    Description

    Returns: . A representing the color in the theme.

    hashtag
    GetFont(appearance, name, state)

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

    Parameter
    Type
    Description

    Returns: . A representing the queried font or null if not found.

    hashtag
    GetFont(name)

    Returns the resolved font defined from the font list.

    Parameter
    Type
    Description

    Returns: . A representing the queried font or null if not found.

    hashtag
    GetImage(appearance, name, state)

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

    Parameter
    Type
    Description

    Returns: . A representing the queried image or null if not found. SVG images at runtime always return null, they are resolved only at design time.

    hashtag
    GetImage(name)

    Returns the resolved image defined from the image list.

    Parameter
    Type
    Description

    Returns: . A representing the queried image or null if not found. SVG images at runtime always return null, they are resolved only at design time.

    hashtag
    GetInsets(appearance, state, includePadding)

    Returns the size of the inset border and padding.

    Parameter
    Type
    Description

    Returns: . Dimension of the border and optionally the padding as a value

    hashtag
    GetProperty<T>(appearance, name, state)

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

    Parameter
    Type
    Description

    Returns: . The typed value of the requested property, or default(T) if not found.

    hashtag
    GetStyle<T>(appearance, name, state)

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

    Parameter
    Type
    Description

    Returns: . The typed value of the requested style, or default(T) if not found.

    hashtag
    IsThemeColor(color)

    Returns true if the color is a theme color.

    Parameter
    Type
    Description

    Returns: . True if color is a theme color.

    Since the theme may also define , using on a system color returns false, but the rendering on the browser will use the color in the theme, if defined.

    hashtag
    IsThemeFont(font)

    Returns true if the font is a theme font.

    Parameter
    Type
    Description

    Returns: . True if font is a theme font.

    Theme fonts (font's with the starting with "@") are always rendered using the definition in the theme for their size and style. However, an application may use a theme font and change the size and style. In this case, the is the theme name without the "@". If the name of the font (which could be a system name like "Arial") matches a theme font, Wisej will use the theme font but it uses the size and style set by the application.

    hashtag
    TranslateColor(color)

    Returns the resolved with the proper RGB values. If the color specified in color is a theme color, the value is resolved from the current theme, otherwise the original color is returned.

    Parameter
    Type
    Description

    Returns: . A instance with the resolved RGB values.

    hashtag
    TranslateFont(font)

    Returns the resolved from the theme font. If the font is a theme font, the value is resolved from current theme.

    Parameter
    Type
    Description

    Returns: . A instance that can be used directly.

    hashtag
    Implements

    Name
    Description

    Accordion.PanelCollection

    Wisej.Web.Accordion PanelCollection

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Contains a collection of objects.

    // create a new custom theme cloned from the current theme.
    var myTheme1 = new ClientTheme("MyTheme1", Application.Theme);
    
    // create a new custom theme from a JSON string.
    var myTheme2 = new ClientTheme("MyTheme2", json);

    state

    The name of the state to query. It's optional. The default is "default".

    state

    The name of the state to query. It's optional. The default is "default".

    state

    The name of the state to query. It's optional. The default is "default".

    includePadding

    Whether to include padding in the insets dimension.

    name

    The name of the property to retrieve.

    state

    The state that defines the property. It can omitted, the default state is "default".

    name

    The name of the property to retrieve.

    state

    The state that defines the property. It can omitted, the default state is "default".

    name

    Stringarrow-up-right

    Unique name of the theme.

    name

    Stringarrow-up-right

    Unique name of the theme.

    json

    Stringarrow-up-right

    JSON definition of the theme.

    name

    Stringarrow-up-right

    Unique name of the theme.

    baseTheme

    ClientTheme

    Original theme to copy into the new theme.

    appearance

    Stringarrow-up-right

    The appearance path that identifies the component in the theme. Nested appearances can be specified using a forward slash: i.e. window/captionbar.

    name

    Stringarrow-up-right

    The name of the property or the style value to query.

    name

    Stringarrow-up-right

    The name of the color to resolve from the color list.

    appearance

    Stringarrow-up-right

    The appearance path that identifies the component in the theme. Nested appearances can be specified using a forward slash: i.e. window/captionbar.

    name

    Stringarrow-up-right

    The name of the property value to query.

    name

    Stringarrow-up-right

    appearance

    Stringarrow-up-right

    The appearance path that identifies the component in the theme. Nested appearances can be specified using a forward slash: i.e. window/captionbar.

    name

    Stringarrow-up-right

    The name of the property or the style value to query.

    name

    Stringarrow-up-right

    appearance

    Stringarrow-up-right

    The name of the appearance in the theme. Child component appearances can be specified using the forward slash, i.e. "button/icon".

    state

    Stringarrow-up-right

    The state that defines the property. It can omitted, the default state is "default".

    T

    The Typearrow-up-right of the value to retrieve.

    appearance

    Stringarrow-up-right

    The name of the appearance in the theme. Child component appearances can be specified using the forward slash, i.e. "button/icon".

    T

    The Typearrow-up-right of the value to retrieve.

    appearance

    Stringarrow-up-right

    The name of the appearance in the theme. Child component appearances can be specified using the forward slash, i.e. "button/icon".

    color

    Colorarrow-up-right

    Color to check.

    font

    Fontarrow-up-right

    Font to check.

    color

    Colorarrow-up-right

    The Colorarrow-up-right to resolve to a usable value.

    font

    Fontarrow-up-right

    The Fontarrow-up-right to resolve to a usable instance.

    IWisejSerializable

    Allows an object to serialize itself.

    Images
    Fonts
    Appearances
    Settings
    Stylesheet
    ToJSONarrow-up-right
    Objectarrow-up-right
    Objectarrow-up-right
    Objectarrow-up-right
    Objectarrow-up-right
    Stringarrow-up-right
    Objectarrow-up-right
    Objectarrow-up-right
    Colorarrow-up-right
    Colorarrow-up-right
    Colorarrow-up-right
    Colorarrow-up-right
    Fontarrow-up-right
    Fontarrow-up-right
    Fontarrow-up-right
    Fontarrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Padding
    Padding
    T
    T
    Booleanarrow-up-right
    SystemColorsarrow-up-right
    IsThemeColor
    Booleanarrow-up-right
    OriginalFontNamearrow-up-right
    OriginalFontNamearrow-up-right
    Colorarrow-up-right
    Colorarrow-up-right
    Colorarrow-up-right
    Fontarrow-up-right
    Fontarrow-up-right
    Fontarrow-up-right
    hashtag
    Properties

    hashtag
    Count

    Int32arrow-up-right: Returns the number of panels in the collection.

    hashtag
    Item(index)

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

    Throws:

    • ArgumentOutOfRangeExceptionarrow-up-right index is less than zero or greater than the highest available index.

    • ArgumentNullExceptionarrow-up-right value is null.

    hashtag
    Item(name)

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

    hashtag
    Methods

    hashtag
    Add(panel)

    Adds a AccordionPanel to the collection.

    Parameter
    Type
    Description

    panel

    The to add.

    Throws:

    • ArgumentNullExceptionarrow-up-right The specified panel is null.

    hashtag
    Add(text)

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

    Parameter
    Type
    Description

    text

    The text to display on the panel.

    hashtag
    Add(key, text)

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

    Parameter
    Type
    Description

    key

    The name of the .

    text

    The text to display on the title of .

    hashtag
    Add(key, text, imageIndex)

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

    Parameter
    Type
    Description

    key

    The name of the .

    text

    The text to display on the .

    hashtag
    Add(key, text, imageKey)

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

    Parameter
    Type
    Description

    key

    The name of the .

    text

    The text to display on the .

    hashtag
    AddRange(panels)

    Adds a set of AccordionPanel panels to the collection.

    Parameter
    Type
    Description

    panels

    An array of type that contains the panels to add.

    Throws:

    • ArgumentNullExceptionarrow-up-right The value of panels is null.

    hashtag
    Clear()

    Removes all the AccordionPanel panels from the collection.

    hashtag
    Clear(dispose)

    Removes and disposes all AccordionPanel panels from the collection.

    Parameter
    Type
    Description

    dispose

    Indicates whether to dispose the panels removed from the collection.

    hashtag
    Contains(panel)

    Determines whether a specified AccordionPanel is in the collection.

    Parameter
    Type
    Description

    panel

    The to locate in the collection.

    Returns: Booleanarrow-up-right. true if the specified AccordionPanel is in the collection; otherwise, false.

    Throws:

    • ArgumentNullExceptionarrow-up-right The value of panel is null.

    hashtag
    ContainsKey(key)

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

    Parameter
    Type
    Description

    key

    The name of the to search for.

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

    hashtag
    CopyTo(array, index)

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

    Parameter
    Type
    Description

    array

    The one-dimensional array that is the destination of the panels copied from the collection. The array must have zero-based indexing.

    index

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

    Throws:

    • ArgumentNullExceptionarrow-up-right array is null.

    • ArgumentOutOfRangeExceptionarrow-up-right array is less than zero.

    • ArgumentExceptionarrow-up-right array is multidimensional or the number of elements in the Panels is greater than the available space from index to the end of array .

    hashtag
    IndexOf(panel)

    Returns the index of the AccordionPanel in the collection.

    Parameter
    Type
    Description

    panel

    The to locate in the collection.

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

    Throws:

    • ArgumentNullExceptionarrow-up-right The value of panel is null.

    hashtag
    IndexOfKey(key)

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

    Parameter
    Type
    Description

    key

    The name of the to find in the collection.

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

    hashtag
    Insert(index, panel)

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

    Parameter
    Type
    Description

    index

    The zero-based index location where the is inserted.

    panel

    The to insert in the collection.

    hashtag
    Insert(index, text)

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

    Parameter
    Type
    Description

    index

    The zero-based index location where the is inserted.

    text

    The text to display in the .

    hashtag
    Insert(index, key, text)

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

    Parameter
    Type
    Description

    index

    The zero-based index location where the is inserted.

    key

    The name of the .

    hashtag
    Insert(index, key, text, imageIndex)

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

    Parameter
    Type
    Description

    index

    The zero-based index location where the is inserted

    key

    The name of the .

    hashtag
    Insert(index, key, text, imageKey)

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

    Parameter
    Type
    Description

    index

    The zero-based index location where the is inserted.

    key

    The name of the .

    hashtag
    Remove(panel)

    Removes the AccordionPanel from the collection.

    Parameter
    Type
    Description

    panel

    The to remove.

    Throws:

    • ArgumentNullExceptionarrow-up-right The panel parameter is null.

    hashtag
    RemoveAt(index)

    Removes the AccordionPanel at the specified index from the collection.

    Parameter
    Type
    Description

    index

    The zero-based index of the to remove.

    hashtag
    RemoveByKey(key)

    Removes the AccordionPanel with the specified key from the collection.

    Parameter
    Type
    Description

    key

    The name of the to remove.

    Public Class PanelCollection
        Inherits IList
        Implements ICollection, IEnumerable, IList(Of AccordionPanel), ICollection(Of AccordionPanel), IEnumerable(Of AccordionPanel)
    AccordionPanel
    public class PanelCollection : IList, ICollection, IEnumerable, IList<AccordionPanel>, ICollection<AccordionPanel>, IEnumerable<AccordionPanel>
    // alter the border of buttons.
    // note that when there is a keyword clash you can use the @ prefix.
    Application.Theme.Appearances.button.states.@default.styles.width = 3;
    Application.Theme.Appearances.button.states.@default.styles.radius = 0;
    
    // additionally, you my use a string indexer to reach any property.
    Application.Theme.Appearances.button.states["default"].styles.radius = 0;
    
    // change existing color.
    Application.Theme.Colors.buttonFace = "red";
    
    // create a new color.
    Application.Theme.Colors.myCoolColor = "rgba(5,23,55,0.9)";
    
    // 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";
    
    
    // make the window title bigger and bold.
    Application.Theme.Fonts.windowTitle.size = 18;
    Application.Theme.Fonts.windowTitle.bold = true;
    
    
    // create a custom css rules in the theme.
    Application.Theme.Stylesheet.rules = new []{
    
      "body: { background-color: red };",
      ".myClass: { background-color: red };"
    };
    
    Stringarrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    Booleanarrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right

    imageIndex

    The index of the image to display on the title of the .

    imageKey

    The key of the image to display on the title of the .

    text

    The text to display on the .

    text

    The text to display on the .

    imageIndex

    The zero-based index of the image to display on the .

    text

    The text to display on the .

    imageKey

    The key of the image to display on the .

    AccordionPanel
    AccordionPanel
    Stringarrow-up-right
    Stringarrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    AccordionPanel[]
    AccordionPanel
    Booleanarrow-up-right
    AccordionPanel
    AccordionPanel
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    AccordionPanel[]
    AccordionPanel
    Int32arrow-up-right
    AccordionPanel
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Int32arrow-up-right
    AccordionPanel
    AccordionPanel
    AccordionPanel
    Int32arrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Int32arrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Int32arrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Int32arrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    AccordionPanel
    AccordionPanel
    Int32arrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Int32arrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Int32arrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel
    Stringarrow-up-right
    AccordionPanel

    DataObject

    Wisej.Web.DataObject

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Implements a basic data transfer mechanism.

    public class DataObject : IDataObject
    Public Class DataObject
        Inherits IDataObject

    hashtag
    Constructors

    hashtag
    DataObject()

    Initializes a new instance of the class.

    hashtag
    DataObject(data)

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

    Name
    Type
    Description

    hashtag
    DataObject(format, data)

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

    Name
    Type
    Description

    hashtag
    DataObject(format, data)

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

    Name
    Type
    Description

    hashtag
    Methods

    hashtag
    ContainsAudio()

    Indicates whether the data object contains data in the format.

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

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

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

    hashtag
    ContainsText()

    Indicates whether the data object contains data in the format.

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

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

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

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

    hashtag
    GetData(format)

    Returns the data associated with the specified data format.

    Parameter
    Type
    Description

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

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

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

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

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

    hashtag
    GetFileDropList()

    Returns the list of file types from the data object.

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

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

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

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

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

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

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

    hashtag
    SetAudio(audioBytes)

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

    Parameter
    Type
    Description

    Throws:

    • audioBytes is null.

    hashtag
    SetAudio(audioStream)

    Adds a to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • audioStream is null.

    hashtag
    SetData(data)

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

    Parameter
    Type
    Description

    hashtag
    SetData(format, data)

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

    Parameter
    Type
    Description

    hashtag
    SetData(format, data)

    Adds the specified object to the using the specified format.

    Parameter
    Type
    Description

    hashtag
    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

    hashtag
    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

    hashtag
    SetFileDropList(filePaths)

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

    Parameter
    Type
    Description

    Throws:

    • filePaths is null.

    hashtag
    SetFileDropList(filePaths)

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

    Parameter
    Type
    Description

    Throws:

    • filePaths is null.

    hashtag
    SetImage(image)

    Adds an to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • image is null.

    hashtag
    SetText(textData)

    Adds text data to the data object in the format.

    Parameter
    Type
    Description

    Throws:

    • textData is null or .

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

    hashtag
    Implements

    Name
    Description

    data

    The data to store.

    data

    Objectarrow-up-right

    The data to store.

    format

    Stringarrow-up-right

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

    data

    Objectarrow-up-right

    The data to store.

    format

    Typearrow-up-right

    A Typearrow-up-right representing the format of the data.

    data

    Objectarrow-up-right

    The data to store.

    format

    TextDataFormat

    One of the TextDataFormat values.

    format

    Typearrow-up-right

    A Typearrow-up-right representing the format of the data to retrieve.

    format

    Stringarrow-up-right

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

    format

    Stringarrow-up-right

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

    autoConvert

    Booleanarrow-up-right

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

    format

    Typearrow-up-right

    A Typearrow-up-right representing the format to check for.

    format

    Stringarrow-up-right

    A Typearrow-up-right representing the format of the data to retrieve.

    format

    Stringarrow-up-right

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

    autoConvert

    Booleanarrow-up-right

    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

    Booleanarrow-up-right

    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[]arrow-up-right

    A Bytearrow-up-right array containing the audio data.

    audioStream

    Streamarrow-up-right

    A Streamarrow-up-right containing the audio data.

    data

    Objectarrow-up-right

    The data to store.

    format

    Typearrow-up-right

    A Typearrow-up-right representing the format associated with the data.

    data

    Objectarrow-up-right

    The data to store.

    format

    Stringarrow-up-right

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

    data

    Objectarrow-up-right

    The data to store.

    format

    Stringarrow-up-right

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

    autoConvert

    Booleanarrow-up-right

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

    url

    Stringarrow-up-right

    The url to the file to download.

    fileName

    Stringarrow-up-right

    The name of the file to download from the url.

    filePaths

    StringCollectionarrow-up-right

    A StringCollectionarrow-up-right containing the file names.

    filePaths

    String[]arrow-up-right

    A StringCollectionarrow-up-right containing the file names.

    image

    Imagearrow-up-right

    The Imagearrow-up-right to add to the data object.

    textData

    Stringarrow-up-right

    The text to add to the data object.

    textData

    Stringarrow-up-right

    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
    Booleanarrow-up-right
    FileDrop
    Booleanarrow-up-right
    Bitmap
    Booleanarrow-up-right
    UnicodeText
    Booleanarrow-up-right
    TextDataFormat
    Booleanarrow-up-right
    Streamarrow-up-right
    Streamarrow-up-right
    WaveAudio
    Objectarrow-up-right
    Objectarrow-up-right
    Objectarrow-up-right
    DataObject
    Booleanarrow-up-right
    DataObject
    Booleanarrow-up-right
    DataObject
    Booleanarrow-up-right
    String[]arrow-up-right
    HttpFileCollection
    HttpFileCollection
    DataObject
    String[]arrow-up-right
    Stringarrow-up-right
    DataObject
    String[]arrow-up-right
    Stringarrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Bitmap
    UnicodeText
    Stringarrow-up-right
    Emptyarrow-up-right
    UnicodeText
    TextDataFormat
    Stringarrow-up-right
    Emptyarrow-up-right
    Bytearrow-up-right
    WaveAudio
    Streamarrow-up-right
    ArgumentNullExceptionarrow-up-right
    Streamarrow-up-right
    WaveAudio
    ArgumentNullExceptionarrow-up-right
    DataObject
    DataObject
    DataObject
    DataObject
    DownloadURL
    FileDrop
    ArgumentNullExceptionarrow-up-right
    FileDrop
    ArgumentNullExceptionarrow-up-right
    Imagearrow-up-right
    Bitmap
    ArgumentNullExceptionarrow-up-right
    UnicodeText
    ArgumentNullExceptionarrow-up-right
    Emptyarrow-up-right
    TextDataFormat
    ArgumentNullExceptionarrow-up-right
    Emptyarrow-up-right
    Objectarrow-up-right

    Application

    Wisej.Web.Application

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

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

    public class Application : IWisejComponent, IDisposable,
    Public Class Application
        Inherits IWisejComponent
        Implements IDisposable, IWisejSynchronized, IServiceProvider

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

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

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

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

    • Read the application's URL. Use ,

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

    hashtag
    Properties

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

    hashtag
    Browser

    : Returns or sets the client browser information.

    hashtag
    ClientId

    : Returns the current unique client id.

    hashtag
    Clients

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

    hashtag
    CommonAppDataPath

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

    hashtag
    CommonAppDataRegistry

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

    hashtag
    CompanyName

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

    hashtag
    Configuration

    : Returns the current .

    hashtag
    Cookies

    : Collection of cookies.

    hashtag
    Current

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

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

    hashtag
    CurrentCulture

    : Returns or sets the current for the session.

    hashtag
    Desktop

    : Returns or sets the current Desktop.

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

    hashtag
    ExecutablePath

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

    hashtag
    FavIcon

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

    hashtag
    FavIconSource

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

    hashtag
    Hash

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

    hashtag
    IsAuthenticated

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

    hashtag
    IsDisposed

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

    hashtag
    IsExpired

    : Returns true when the current session has expired.

    hashtag
    IsSecure

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

    hashtag
    IsTerminated

    : Returns true when the current session has been terminated.

    hashtag
    IsWebSocket

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

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

    hashtag
    MainPage

    : Returns or sets the current full page window.

    hashtag
    OpenForms

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

    hashtag
    OpenPages

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

    hashtag
    Platform

    : The name of the currently loaded platform.

    hashtag
    ProductName

    : Returns the product name associated with this application.

    hashtag
    ProductVersion

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

    hashtag
    QueryString

    : Returns the parameters used to launch the application.

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

    hashtag
    RuntimeMode

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

    hashtag
    ServerName

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

    hashtag
    ServerPort

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

    hashtag
    ServerVariables

    : Returns the server variables.

    hashtag
    Session

    : Provides a generic storage for session-based objects.

    hashtag
    SessionCount

    : Returns the total number of currently active sessions.

    hashtag
    SessionId

    : Returns the unique current session ID.

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

    hashtag
    ShowLoader

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

    hashtag
    StartupPath

    : Returns the root path of the web application.

    hashtag
    StartupUri

    : Returns the URI used to start the application.

    hashtag
    StartupUrl

    : Returns the URL used to start the application.

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

    hashtag
    Title

    : Returns or sets the page title in the browser.

    hashtag
    Uri

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

    hashtag
    Url

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

    hashtag
    User

    : Returns the security information for the current request.

    hashtag
    UserAgent

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

    hashtag
    UserHostAddress

    : Returns the IP host address of the remote client.

    hashtag
    UserHostName

    : Returns the DNS name of the remote client.

    hashtag
    UserIdentity

    : Returns the type for the current user.

    hashtag
    UserLanguages

    : Gets a sorted string array of client language preferences.

    hashtag
    Methods

    hashtag
    AddEventFilter(filter)

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

    Parameter
    Type
    Description

    hashtag
    AddService(serviceType, serviceInstance, scope)

    EXPERIMENTAL: Adds a scoped service to the service container.

    Parameter
    Type
    Description

    Throws:

    • serviceType is null.

    • A service of type serviceType already exists.

    hashtag
    AddService(serviceType, callback, scope)

    EXPERIMENTAL: Adds a scoped service to the service container.

    Parameter
    Type
    Description

    Throws:

    • serviceType is null.

    • A service of type serviceType already exists.

    hashtag
    AddTranslation(text, translation)

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

    Parameter
    Type
    Description

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

    hashtag
    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

    hashtag
    Call(function, args)

    Executes the JavaScript function on the client.

    Parameter
    Type
    Description

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

    hashtag
    CancelFullScreen()

    Cancels the fullscreen mode.

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

    hashtag
    Download(filePath, fileName, ondownload)

    Downloads the specified file on the client.

    Parameter
    Type
    Description

    hashtag
    Download(image, fileName, ondownload)

    Downloads the specified image to the client.

    Parameter
    Type
    Description

    hashtag
    Download(stream, fileName, ondownload)

    Downloads the bytes in the stream to the client.

    Parameter
    Type
    Description

    hashtag
    DownloadAndOpen(target, filePath, fileName, ondownload)

    Downloads the specified file on the client.

    Parameter
    Type
    Description

    hashtag
    DownloadAndOpen(target, image, fileName, ondownload)

    Downloads the specified image to the client.

    Parameter
    Type
    Description

    hashtag
    DownloadAndOpen(target, stream, fileName, ondownload)

    Downloads the bytes in the stream to the client.

    Parameter
    Type
    Description

    hashtag
    EndPolling()

    Stops the polling requests from the client.

    hashtag
    Eval(script)

    Executes the JavaScript script on the client.

    Parameter
    Type
    Description

    hashtag
    Eval(script, callback)

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

    Parameter
    Type
    Description

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

    hashtag
    Exit()

    Terminates the application and the corresponding session.

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

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

    hashtag
    GetService<T>()

    EXPERIMENTAL: Returns the requested service.

    Parameter
    Type
    Description

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

    hashtag
    GetService(serviceType)

    EXPERIMENTAL: Returns the requested service.

    Parameter
    Type
    Description

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

    Throws:

    • serviceType is null.

    hashtag
    LoadAssembly(nameOrFile)

    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.

    hashtag
    LoadComponent(nameOrFile, className)

    Creates an instance of the specified component from the assembly.

    Parameter
    Type
    Description

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

    hashtag
    LoadPackages(packages, callback)

    Parameter
    Type
    Description

    hashtag
    LoadPackagesAsync(packages)

    Parameter
    Type
    Description

    Returns: .

    hashtag
    LoadTheme(name, mixins)

    Changes the current theme.

    Parameter
    Type
    Description

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

    hashtag
    Navigate(url, target)

    Navigate to the specified URL.

    Parameter
    Type
    Description

    hashtag
    Play(type)

    Plays one of the built-in sounds

    Parameter
    Type
    Description

    hashtag
    Play(soundUrl)

    Plays a sound.

    Parameter
    Type
    Description

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

    hashtag
    Print(control)

    Prints the specified control.

    Parameter
    Type
    Description

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

    hashtag
    Print()

    Prints the entire browser window.

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

    hashtag
    Reload()

    Causes the application to reload on the browser.

    hashtag
    RemoveEventFilter(filter)

    Removes the filter from the list of registered event filters.

    Parameter
    Type
    Description

    hashtag
    RemoveService(serviceType)

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

    Parameter
    Type
    Description

    Throws:

    • serviceType is null.

    hashtag
    RequestFullScreen()

    Requests the browser to enable fullscreen mode if supported.

    hashtag
    RunInContext(context, action)

    Executes the callback in context.

    Parameter
    Type
    Description

    hashtag
    SetSessionTimeout(seconds)

    Sets the current session timeout in seconds.

    Parameter
    Type
    Description

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

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

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

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

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

    hashtag
    Events

    hashtag
    ActiveWindowChanged

    Fired when the active window changes.

    hashtag
    ApplicationExit

    Fired when the application is about to shut down.

    hashtag
    ApplicationRefresh

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

    hashtag
    ApplicationStart

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

    hashtag
    BeforeInstallPrompt

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

    hashtag
    BeginRequest

    Fired at the beginning of every request.

    hashtag
    BrowserSizeChanged

    Fired when the user resizes the browser.

    hashtag
    BrowserTabActivated

    Fired when the user activates the browser tab.

    hashtag
    BrowserTabDeactivated

    Fired when the user deactivates the browser tab.

    hashtag
    CultureChanged

    Fired when the changes.

    hashtag
    EndRequest

    Fired at the end of every request.

    hashtag
    FocusedControlChanged

    Fired when the focused control changes.

    hashtag
    HashChanged

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

    hashtag
    Idle

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

    hashtag
    ImpersonationBegin

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

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

    hashtag
    ImpersonationEnd

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

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

    hashtag
    LicenseError

    Fired when a license error occurs.

    hashtag
    ResponsiveProfileChanged

    Fired when the active responsive profile is changed.

    hashtag
    RightToLeftChanged

    Fired when the value changes.

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

    hashtag
    ThemeChanged

    Fired when the current theme is changed.

    hashtag
    ThreadException

    Fired when a thread exception is thrown.

    hashtag
    Implements

    Name
    Description
    ,
    , and
    .
  • 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.

  • scope

    Scope of the serviceInstance .

    scope

    Scope of the service.

    args

    The arguments to pass to the function.

    ondownload

    Optional callback invoked when fileName is downloaded.

    ondownload

    Optional callback invoked when fileName is downloaded.

    ondownload

    Optional callback invoked when fileName is downloaded.

    fileName

    The name of the file to save on the client.

    ondownload

    Optional callback invoked when fileName is downloaded.

    fileName

    The name of the file to save on the client.

    ondownload

    Optional callback invoked when fileName is downloaded.

    fileName

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

    ondownload

    Optional callback invoked when fileName is downloaded.

    callback

    A callback method to invoke at the specified intervals.

    IWisejSynchronized
    ,
    IServiceProvider

    filter

    IEventFilter

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

    serviceType

    Typearrow-up-right

    Type of the service to add.

    serviceInstance

    Objectarrow-up-right

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

    serviceType

    Typearrow-up-right

    Type of the service to add.

    callback

    Func<Type, ServiceScope, Object>arrow-up-right

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

    text

    Stringarrow-up-right

    The text to translate.

    translation

    Stringarrow-up-right

    The translation override.

    message

    Stringarrow-up-right

    A string you want to display in the alert dialog.

    function

    Stringarrow-up-right

    The name of the function to execute.

    callback

    Action<Object>arrow-up-right

    Asynchronous callback method that receives the return value.

    function

    Stringarrow-up-right

    The name of the function to execute.

    args

    Object[]arrow-up-right

    The arguments to pass to the function.

    function

    Stringarrow-up-right

    The name of the function to execute.

    args

    Object[]arrow-up-right

    The arguments to pass to the function.

    message

    Stringarrow-up-right

    A string you want to display in the confirm dialog.

    filePath

    Stringarrow-up-right

    The file to download.

    fileName

    Stringarrow-up-right

    The name of the file to save on the client.

    image

    Imagearrow-up-right

    The image to download.

    fileName

    Stringarrow-up-right

    The name of the file to save on the client.

    stream

    Streamarrow-up-right

    The stream to send to the client.

    fileName

    Stringarrow-up-right

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

    target

    Stringarrow-up-right

    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

    Stringarrow-up-right

    The file to download.

    target

    Stringarrow-up-right

    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

    Imagearrow-up-right

    The image to download.

    target

    Stringarrow-up-right

    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

    Streamarrow-up-right

    The stream to send to the client.

    script

    Stringarrow-up-right

    The script to evaluate.

    script

    Stringarrow-up-right

    The script to evaluate.

    callback

    Action<Object>arrow-up-right

    Asynchronous callback method that receives the return value.

    script

    Stringarrow-up-right

    The script to evaluate.

    match

    Predicate<IWisejComponent>arrow-up-right

    A custom Predicatearrow-up-right expression used to match the IWisejComponent to find.

    match

    Predicate<IWisejComponent>arrow-up-right

    A custom Predicatearrow-up-right expression used to match the list of IWisejComponent objects to find.

    T

    Type of the service to retrieve.

    serviceType

    Typearrow-up-right

    Type of the service to add.

    nameOrFile

    Stringarrow-up-right

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

    nameOrFile

    Stringarrow-up-right

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

    className

    Stringarrow-up-right

    packages

    IEnumerable<Package>arrow-up-right

    callback

    Action<Boolean>arrow-up-right

    packages

    IEnumerable<Package>arrow-up-right

    name

    Stringarrow-up-right

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

    mixins

    String[]arrow-up-right

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

    path

    Stringarrow-up-right

    url

    Stringarrow-up-right

    URL to navigate to.

    target

    Stringarrow-up-right

    The target browser window: _self, _blank, etc.

    type

    MessageBoxIcon

    One of MessageBoxIcon value that identifies the sound to play.

    soundUrl

    Stringarrow-up-right

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

    callback

    Actionarrow-up-right

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

    control

    IWisejControl

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

    message

    Stringarrow-up-right

    A string of text to display to the user.

    defaultValue

    Stringarrow-up-right

    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.

    serviceType

    Typearrow-up-right

    Type of the service to remove.

    context

    IWisejComponent

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

    action

    Actionarrow-up-right

    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

    Int32arrow-up-right

    interval

    Int32arrow-up-right

    Polling interval in milliseconds. The minimum is 1000ms.

    action

    Actionarrow-up-right

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

    T

    action

    Func<T>arrow-up-right

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

    dueTime

    Int32arrow-up-right

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

    period

    Int32arrow-up-right

    The time interval between invocations, in milliseconds.

    context

    IWisejComponent

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

    action

    Actionarrow-up-right

    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
    Dictionaryarrow-up-right
    Cookies
    ServerVariables
    ServerPort
    ServerName
    UserAgent
    Uri
    Url
    Application
    docs.wisejarrow-up-right
    ClientProfile
    ClientBrowser
    Stringarrow-up-right
    ClientCollection
    Stringarrow-up-right
    RegistryKeyarrow-up-right
    Stringarrow-up-right
    AssemblyCompanyAttributearrow-up-right
    Configuration
    Configuration
    CookieCollection
    IWisejComponent
    Update
    StartTask
    Current
    Application
    Update
    RunInContext
    Current
    CultureInfoarrow-up-right
    CultureInfoarrow-up-right
    Desktop
    Booleanarrow-up-right
    Stringarrow-up-right
    Imagearrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Stringarrow-up-right
    LicenseKey
    Page
    FormCollection
    PageCollection
    ClientPlatform
    Stringarrow-up-right
    Stringarrow-up-right
    AssemblyInformationalVersionAttributearrow-up-right
    AssemblyFileVersionAttributearrow-up-right
    NameValueCollectionarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Stringarrow-up-right
    Int32arrow-up-right
    NameValueCollectionarrow-up-right
    Objectarrow-up-right
    Int32arrow-up-right
    Stringarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Stringarrow-up-right
    Uriarrow-up-right
    Stringarrow-up-right
    ClientTheme
    ClientTheme
    ClientTheme
    Stringarrow-up-right
    Uriarrow-up-right
    Uriarrow-up-right
    StartupUri
    Stringarrow-up-right
    StartupUrl
    IPrincipalarrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    WindowsIdentityarrow-up-right
    WindowsIdentityarrow-up-right
    String[]arrow-up-right
    ArgumentNullExceptionarrow-up-right
    ArgumentExceptionarrow-up-right
    ArgumentNullExceptionarrow-up-right
    ArgumentExceptionarrow-up-right
    Taskarrow-up-right
    Taskarrow-up-right
    Taskarrow-up-right
    Task<Object>arrow-up-right
    Taskarrow-up-right
    Task<Boolean>arrow-up-right
    Taskarrow-up-right
    Taskarrow-up-right
    Task<Object>arrow-up-right
    Taskarrow-up-right
    IWisejComponent
    IWisejComponent
    IList<IWisejComponent>arrow-up-right
    IWisejComponent
    T
    Objectarrow-up-right
    ArgumentNullExceptionarrow-up-right
    Assemblyarrow-up-right
    Assemblyarrow-up-right
    IWisejComponent
    IWisejComponent
    Task<Boolean>arrow-up-right
    Stringarrow-up-right
    Task<String>arrow-up-right
    Taskarrow-up-right
    ArgumentNullExceptionarrow-up-right
    IsWebSocket
    EndPolling
    ArgumentOutOfRangeExceptionarrow-up-right
    background-tasksarrow-up-right
    Taskarrow-up-right
    Taskarrow-up-right
    Update
    Timer
    StartPolling
    EndPolling
    background-tasksarrow-up-right
    Task<T>arrow-up-right
    Update
    StartTask
    Timer
    StartPolling
    EndPolling
    Timerarrow-up-right
    Timerarrow-up-right
    Timerarrow-up-right
    Timerarrow-up-right
    system.threadingarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    BeforeInstallPromptEventarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    CurrentCulture
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    HashChangedEventHandler
    EventHandlerarrow-up-right
    HandledEventHandlerarrow-up-right
    HandledEventHandlerarrow-up-right
    LicenseErrorEventHandler
    ResponsiveProfileChangedEventHandler
    EventHandlerarrow-up-right
    RightToLeft
    HandledEventHandlerarrow-up-right
    EventHandlerarrow-up-right
    ThreadExceptionEventHandlerarrow-up-right
    StartupUri
    StartupUrl
        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);
          }
        });
    
    });
    ServiceScope
    ServiceScope
    Object[]arrow-up-right
    Action<String>arrow-up-right
    Action<String>arrow-up-right
    Action<String>arrow-up-right
    Stringarrow-up-right
    Action<String>arrow-up-right
    Stringarrow-up-right
    Action<String>arrow-up-right
    Stringarrow-up-right
    Action<String>arrow-up-right
    Actionarrow-up-right

    Control

    Wisej.Web.Control

    Namespace: Wisej.Web

    Assembly: Wisej.Framework (3.0.0.0)

    Base class for all Wisej controls.

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

    hashtag
    Constructors

    hashtag
    Control()

    Initializes a new instance of the class.

    hashtag
    Properties

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

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

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

    hashtag
    AllowDrag

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

    hashtag
    AllowDrop

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

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

    hashtag
    Anonymous

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

    hashtag
    AppearanceKey

    : Sets the appearance key for the theme engine.

    hashtag
    BackColor

    : Returns or sets the background color for the control.

    hashtag
    BackgroundImage

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

    hashtag
    BackgroundImageLayout

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

    hashtag
    BackgroundImageSource

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

    hashtag
    BecomingActiveControl

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

    hashtag
    BindingContext

    : Returns or sets the for the control.

    hashtag
    Bottom

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

    hashtag
    Bounds

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

    hashtag
    CanExecute

    : Determines whether the control can execute a command.

    hashtag
    CanFocus

    : Returns whether the control can receive focus.

    hashtag
    CanSelect

    : Returns whether the control can be selected.

    hashtag
    Capture

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

    hashtag
    CausesValidation

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

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

    hashtag
    ClientRectangle

    : Returns the client rectangle of the control.

    hashtag
    ClientSize

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

    hashtag
    ContainsFocus

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

    hashtag
    ContextMenu

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

    hashtag
    Controls

    : Returns the collection of controls contained within the control.

    hashtag
    Created

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

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

    hashtag
    CssStyle

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

    You can use any CSS style string.

    hashtag
    Cursor

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

    hashtag
    DataBindings

    : Returns the data bindings for the control.

    hashtag
    DefaultBackColor

    : Returns the default background color of the control.

    hashtag
    DefaultFont

    : Returns the default font of the control.

    hashtag
    DefaultForeColor

    : Returns the default background color of the control.

    hashtag
    DisplayRectangle

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

    hashtag
    Disposing

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

    hashtag
    Dock

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

    hashtag
    Enabled

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

    hashtag
    EnableNativeContextMenu

    : Enables or disables the browser's context menu.

    hashtag
    Focusable

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

    hashtag
    Focused

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

    hashtag
    Font

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

    hashtag
    ForeColor

    : Returns or sets the text color of the control.

    hashtag
    Handle

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

    hashtag
    HasChildren

    : Returns whether the control contains any child control.

    hashtag
    HasDataBindings

    : Returns whether the control specifies data bindings.

    hashtag
    HasResponsiveProfiles

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

    hashtag
    HasUserData

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

    hashtag
    Height

    : Returns or sets the height of the control.

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

    hashtag
    IsDisposed

    : Returns whether the control has been disposed.

    hashtag
    IsHandleCreated

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

    hashtag
    IsMirrored

    : Returns whether the control is mirrored.

    hashtag
    LayoutEngine

    : Returns the control's layout engine.

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

    hashtag
    Location

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

    hashtag
    Margin

    : Returns or sets the space between controls.

    hashtag
    MaximumSize

    : Returns or sets the maximum size for the control.

    hashtag
    MinimumSize

    : Returns or sets the minimum size for the control.

    hashtag
    ModifierKeys

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

    hashtag
    MouseButtons

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

    hashtag
    MousePosition

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

    hashtag
    Movable

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

    hashtag
    Name

    : Gets or sets the name of the control.

    hashtag
    Padding

    : Returns or sets padding within the control.

    hashtag
    Parent

    : Returns or sets the parent container of the control.

    hashtag
    PreferredSize

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

    hashtag
    ResizableEdges

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

    hashtag
    ResponsiveProfiles

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

    hashtag
    Right

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

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

    circle-info

    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.

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

    hashtag
    ShowLoader

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

    hashtag
    Size

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

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

    hashtag
    TabIndex

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

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

    hashtag
    Tag

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

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

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

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

    hashtag
    TopLevelControl

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

    hashtag
    UserData

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

    hashtag
    UseWaitCursor

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

    hashtag
    ValidationCancelled

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

    hashtag
    Visible

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

    hashtag
    WheelDelta

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

    hashtag
    Width

    : Returns or sets the width of the control.

    hashtag
    Methods

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

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

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

    hashtag
    BeginInvoke(method)

    Executes the specified delegate asynchronously.

    Parameter
    Type
    Description

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

    hashtag
    BeginInvoke(method, args)

    Executes the specified delegate asynchronously.

    Parameter
    Type
    Description

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

    hashtag
    BringToFront()

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

    hashtag
    Call(function, args)

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

    Parameter
    Type
    Description

    hashtag
    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

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

    hashtag
    CenterToParent()

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

    hashtag
    CenterToParent(horizontal, vertical)

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

    Parameter
    Type
    Description

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

    hashtag
    CreateControl()

    Creates and register this control and all its children.

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

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

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

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

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

    hashtag
    EndInvoke(asyncResult)

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

    Parameter
    Type
    Description

    Returns: . The return value from the asynchronous operation.

    hashtag
    Eval(javaScript)

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

    Parameter
    Type
    Description

    hashtag
    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

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

    hashtag
    FindForm()

    Retrieves the form that the control is on.

    Returns: .

    hashtag
    FindPage()

    Retrieves the page that the control is on.

    Returns: .

    hashtag
    Focus()

    Sets input focus to the control.

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

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

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

    hashtag
    GetClientEventListener(id)

    Returns the script associated to the listener identified by id .

    Parameter
    Type
    Description

    Returns: . JavaScript associated with the listener.

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

    hashtag
    GetContainerControl()

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

    Returns: . The parent .

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

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

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

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

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

    hashtag
    Hide()

    Conceals the control from the user.

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

    hashtag
    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

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

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

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

    hashtag
    LayoutChildren(dock, spacing, useMargins, hAlign, vAlign)

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

    Parameter
    Type
    Description

    hashtag
    LayoutChildren(dock, viewArea, spacing, useMargins, hAlign, vAlign)

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

    Parameter
    Type
    Description

    hashtag
    LayoutChildren(controls, dock, spacing, useMargins, hAlign, vAlign)

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

    Parameter
    Type
    Description

    hashtag
    LayoutChildren(controls, dock, viewArea, spacing, useMargins, hAlign, vAlign)

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

    Parameter
    Type
    Description

    hashtag
    LayoutChildren(direction, spacing, useMargins, hAlign, vAlign)

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

    Parameter
    Type
    Description

    hashtag
    LayoutChildren(direction, viewArea, spacing, useMargins, hAlign, vAlign)

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

    Parameter
    Type
    Description

    hashtag
    LayoutChildren(controls, direction, spacing, useMargins, hAlign, vAlign)

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

    Parameter
    Type
    Description

    Throws:

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

    hashtag
    LayoutChildren(controls, direction, viewArea, spacing, useMargins, hAlign, vAlign)

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

    Parameter
    Type
    Description

    Throws:

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

    hashtag
    PerformLayout()

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

    hashtag
    PerformLayout(affectedControl, affectedProperty)

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

    Parameter
    Type
    Description

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

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

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

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

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

    hashtag
    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

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

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

    hashtag
    RemoveCssClass(name)

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

    Parameter
    Type
    Description

    Returns: . The new value of the property.

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

    hashtag
    ResetBindings()

    Removes all the data bindings from the control.

    hashtag
    ResumeLayout()

    Resumes layout logic.

    hashtag
    ResumeLayout(performLayout)

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

    Parameter
    Type
    Description

    hashtag
    ScrollControlIntoView(alignX, alignY)

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

    Parameter
    Type
    Description

    hashtag
    ScrollControlIntoView()

    Scrolls the child control into view.

    hashtag
    Select()

    Activates a control.

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

    hashtag
    SendToBack()

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

    hashtag
    SetBounds(x, y, width, height)

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

    Parameter
    Type
    Description

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

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

    Parameter
    Type
    Description

    hashtag
    Show()

    Displays the control to the user.

    hashtag
    SuspendLayout()

    Suspends the layout logic for the control.

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

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

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

    hashtag
    Events

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

    hashtag
    AutoSizeChanged

    Fired when the property value changes.

    hashtag
    BackColorChanged

    Fired when the value of the property changes.

    hashtag
    BackgroundImageChanged

    Fired when the value of the property changes.

    hashtag
    BackgroundImageLayoutChanged

    Fired when the property changes.

    hashtag
    BecomingActiveControlChanged

    Fired when the value of the property changes.

    hashtag
    BindingContextChanged

    Occurs when the value of the property changes.

    hashtag
    CausesValidationChanged

    Fired when the value of the property changes.

    hashtag
    Click

    Fired when the control is clicked.

    hashtag
    ClientSizeChanged

    Fired when the property value changes.

    hashtag
    ContextMenuChanged

    Fired when the value of the property changes.

    hashtag
    ControlAdded

    Fired when a new control is added to the .

    hashtag
    ControlCreated

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

    hashtag
    ControlRemoved

    Fired when a control is removed from the .

    hashtag
    CursorChanged

    Fired when the value of the property changes.

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

    hashtag
    Disposed

    Fired when the component is disposed.

    hashtag
    DockChanged

    Fired when the value of the property changes.

    hashtag
    DoubleClick

    Fired when the control is double-clicked.

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

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

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

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

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

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

    hashtag
    EnabledChanged

    Fired when the property value has changed.

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

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

    hashtag
    Enter

    Fired when the control gains the input focus.

    hashtag
    FontChanged

    Fired when the property value changes.

    hashtag
    ForeColorChanged

    Fired when the property value changes.

    hashtag
    GotFocus

    Fired when the control gains the focus.

    hashtag
    HelpRequested

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

    hashtag
    ImeModeChanged

    Fired when the ImeMode property has changed.

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

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

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

    hashtag
    Layout

    Fired when a control should reposition its child controls.

    hashtag
    Leave

    Fired when the control loses the input focus.

    hashtag
    LocationChanged

    Fired when the property value has changed.

    hashtag
    LongTap

    Fired when a pointer holds on the screen.

    hashtag
    LostFocus

    Fired when the control loses focus.

    hashtag
    MarginChanged

    Fired when the control's margin changes.

    hashtag
    MouseCaptureChanged

    Fired when the control loses mouse capture.

    hashtag
    MouseClick

    Fired when the control is clicked by the mouse.

    hashtag
    MouseDoubleClick

    Fired when the control is double clicked by the mouse.

    hashtag
    MouseDown

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

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

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

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

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

    hashtag
    MouseUp

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

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

    hashtag
    PaddingChanged

    Fired when the control's padding changes.

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

    hashtag
    ParentChanged

    Fired when the property value changes.

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

    hashtag
    PreviewKeyDown

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

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

    hashtag
    Resize

    Fired when the control is resized.

    hashtag
    ResponsiveProfileChanged

    Fired when the active responsive profile is changed.

    hashtag
    RightToLeftChanged

    Fired when the property value changes.

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

    hashtag
    SizeChanged

    Fired when the property value changes.

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

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

    hashtag
    StyleChanged

    Fired when the control style changed.

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

    hashtag
    TabIndexChanged

    Fired when the property value has changed.

    hashtag
    TabStopChanged

    Fired when the value of the property changes.

    hashtag
    Tap

    Fired when a pointer taps on the screen.

    hashtag
    TextChanged

    Fired when the property value changes.

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

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

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

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

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

    hashtag
    Validated

    Fired when the control is finished validating.

    hashtag
    Validating

    Fired when the control is validating.

    hashtag
    VisibleChanged

    Fired when the property value changes.

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

    hashtag
    Inherited By

    Name
    Description

    hashtag
    Implements

    Name
    Description
    RemoveClientEventListener
  • GetClientEventListener

  • RemoveClientEventListener
  • GetClientEventListener

  • args

    The arguments to pass to the function.

    imageSource

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

    imageSource

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

    imageSize

    The size of the drag image specified in imageSource.

    image

    An to use as the drag cursor.

    image

    An to use as the drag cursor.

    imageSize

    The size of the drag image specified in image.

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using dock = , or , or .

    vAlign

    Vertical alignment when using dock = , or , .

    spacing

    Spacing between the .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using dock = , or , or .

    vAlign

    Vertical alignment when using dock = , or , .

    spacing

    Spacing between the .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using dock = , or , or .

    vAlign

    Vertical alignment when using dock = , or , .

    viewArea

    Rectangle limiting the area to arrange the in. If empty, it will use .

    spacing

    Spacing between the .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using dock = , or , or .

    vAlign

    Vertical alignment when using dock = , or , .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using direction = .

    vAlign

    Vertical alignment when using direction = .

    spacing

    Spacing between the .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using direction = .

    vAlign

    Vertical alignment when using direction = .

    spacing

    Spacing between the controls .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using direction = .

    vAlign

    Vertical alignment when using direction = .

    viewArea

    Rectangle limiting the area to arrange the controls in. If empty, it will use .

    spacing

    Spacing between the controls .

    useMargins

    When true (default), it will also use the to arrange the controls.

    hAlign

    Horizontal alignment when using direction = .

    vAlign

    Vertical alignment when using direction = .

    tabStopOnly

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

    nested

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

    wrap

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

    width

    The new property value of the control.

    height

    The new property value of the control.

    width

    The new property value of the control.

    height

    The new property value of the control.

    specified

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

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

    Represents a button control.

    Implements the basic functionality common to button controls.

    Represents a check box control.

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

    Represents a combo box control.

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

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

    Represents a spinner control that displays string values.

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

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

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

    Represents a label control.

    Represents an hyper-link control.

    Represents a control to display a list of items.

    Provides a common implementation of members for the and classes.

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

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

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

    Represents a spinner control that displays numeric values.

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

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

    Represents an image control.

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

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

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

    Represents an horizontal scroll bar.

    Represents a vertical scroll bar.

    Implements the basic functionality of a scroll bar control.

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

    Creates a panel that is associated with a .

    Manages a related set of pages.

    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 .

    Allows an object to serialize itself.

    IBindableComponent
    ,
    IWisejSerializable
    ,
    IHasPropertyStore
    ,
    IHasResponsiveProfiles

    name

    Stringarrow-up-right

    Name of the client event to attach the listener to.

    script

    Stringarrow-up-right

    JavaScript code to execute when the event occurs.

    name

    Stringarrow-up-right

    Name of the css class to add.

    state

    Stringarrow-up-right

    Name of the custom state to add to the widget.

    method

    Delegatearrow-up-right

    A delegate to a method that takes no parameters.

    method

    Delegatearrow-up-right

    A delegate to a method that takes no parameters.

    args

    Object[]arrow-up-right

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

    function

    Stringarrow-up-right

    The name of the JavaScript function to execute.

    args

    Object[]arrow-up-right

    The arguments to pass to the function.

    function

    Stringarrow-up-right

    The name of the JavaScript function to execute.

    callback

    Action<Object>arrow-up-right

    Asynchronous callback method that receives the return value.

    function

    Stringarrow-up-right

    The name of the JavaScript function to execute.

    args

    Object[]arrow-up-right

    The arguments to pass to the function.

    horizontal

    Booleanarrow-up-right

    Center horizontally.

    vertical

    Booleanarrow-up-right

    Center vertically.

    control

    Control

    The child Control to find.

    data

    Objectarrow-up-right

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    data

    Objectarrow-up-right

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    data

    Objectarrow-up-right

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    data

    Objectarrow-up-right

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    data

    Objectarrow-up-right

    The data to drag.

    allowedEffects

    DragDropEffects

    One of the DragDropEffects values.

    asyncResult

    IAsyncResultarrow-up-right

    An IAsyncResultarrow-up-right that represents a BeginInvoke operation started on a control.

    javaScript

    Stringarrow-up-right

    The JavaScript code to run on the client.

    javaScript

    Stringarrow-up-right

    The JavaScript code to evaluate on the client.

    callback

    Action<Object>arrow-up-right

    Asynchronous callback method that receives the return value.

    javaScript

    Stringarrow-up-right

    The JavaScript code to evaluate on the client.

    pt

    Pointarrow-up-right

    A Pointarrow-up-right 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

    Pointarrow-up-right

    A Pointarrow-up-right 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

    Int32arrow-up-right

    Id of the listener to retrieve the script for.

    name

    Stringarrow-up-right

    Name of the event.

    control

    Control

    The Control to start the search with.

    forward

    Booleanarrow-up-right

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

    flag

    ControlStyles

    The ControlStyles bit to return the value from.

    name

    Stringarrow-up-right

    Name of the client event to verify.

    name

    Stringarrow-up-right

    Css class name to verify.

    state

    Stringarrow-up-right

    Name of the state to check.

    invalidateChildren

    Booleanarrow-up-right

    When true, invalidates all the children of the control.

    method

    Delegatearrow-up-right

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

    method

    Delegatearrow-up-right

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

    args

    Object[]arrow-up-right

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

    charCode

    Chararrow-up-right

    The character to test.

    text

    Stringarrow-up-right

    The string to search.

    dock

    DockStyle

    Indicates whether to arrange the Controls horizontally or vertically.

    spacing

    Int32arrow-up-right

    Spacing between the Controls.

    dock

    DockStyle

    Indicates whether to arrange the Controls horizontally or vertically.

    viewArea

    Rectanglearrow-up-right

    Rectangle limiting the area to arrange the Controls in. If empty, it will use DisplayRectangle.

    controls

    ICollection<Control>arrow-up-right

    List of child controls to arrange. If null, all the children will be arranged.

    dock

    DockStyle

    Indicates whether to arrange the Controls horizontally or vertically.

    controls

    ICollection<Control>arrow-up-right

    List of child controls to arrange. If null, all the children will be arranged.

    dock

    DockStyle

    Indicates whether to arrange the Controls horizontally or vertically.

    direction

    Orientation

    Indicates whether to arrange the Controls horizontally or vertically.

    spacing

    Int32arrow-up-right

    Spacing between the Controls.

    direction

    Orientation

    Indicates whether to arrange the Controls horizontally or vertically.

    viewArea

    Rectanglearrow-up-right

    Rectangle limiting the area to arrange the Controls in. If empty, it will use DisplayRectangle.

    controls

    ICollection<Control>arrow-up-right

    List of child controls to arrange. If null, all the children will be arranged.

    direction

    Orientation

    Indicates whether to arrange the controls horizontally or vertically.

    controls

    ICollection<Control>arrow-up-right

    List of child controls to arrange. If null, all the children will be arranged.

    direction

    Orientation

    Indicates whether to arrange the controls horizontally or vertically.

    affectedControl

    Control

    A Control that represents the recently changed control.

    affectedProperty

    Stringarrow-up-right

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

    point

    Pointarrow-up-right

    The screen coordinate Pointarrow-up-right to convert.

    point

    Pointarrow-up-right

    The client coordinate Pointarrow-up-right to convert.

    rect

    Rectanglearrow-up-right

    The screen coordinate Rectanglearrow-up-right to convert.

    rect

    Rectanglearrow-up-right

    The client coordinate Rectanglearrow-up-right to convert.

    refreshChildren

    Booleanarrow-up-right

    True to also refresh all the children of this control.

    id

    Int32arrow-up-right

    Id of the listener to remove.

    name

    Stringarrow-up-right

    Name of the event.

    name

    Stringarrow-up-right

    The css class name to remove.

    state

    Stringarrow-up-right

    Name of the state to remove.

    performLayout

    Booleanarrow-up-right

    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

    Booleanarrow-up-right

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

    x

    Int32arrow-up-right

    The new Left property value of the control.

    y

    Int32arrow-up-right

    The new Top property value of the control.

    x

    Int32arrow-up-right

    The new Left property value of the control.

    y

    Int32arrow-up-right

    The new Top property value of the control.

    flags

    ValidationConstraints

    TableLayoutPanel

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

    FileDialogUI

    UI implementation for the FileDialog class.

    FolderBrowserDialogUI

    UI implementation for the FolderDialog class.

    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.

    Control
    Stringarrow-up-right
    Stringarrow-up-right
    AccessibleRole
    Booleanarrow-up-right
    Booleanarrow-up-right
    AnchorStyles
    Booleanarrow-up-right
    Stringarrow-up-right
    Colorarrow-up-right
    Imagearrow-up-right
    ImageLayout
    ImageLayout
    Stringarrow-up-right
    Booleanarrow-up-right
    BindingContext
    BindingContext
    Int32arrow-up-right
    Rectanglearrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    ClientEventCollection
    AddClientEventListener
    HasClientEventListener
    RemoveClientEventListener
    Rectanglearrow-up-right
    Sizearrow-up-right
    Booleanarrow-up-right
    ContextMenu
    ControlCollection
    Booleanarrow-up-right
    Stringarrow-up-right
    StyleSheet
    AddCssClass
    RemoveCssClass
    HasCssClass
    Stringarrow-up-right
    Cursor
    ControlBindingsCollection
    Colorarrow-up-right
    Fontarrow-up-right
    Colorarrow-up-right
    Rectanglearrow-up-right
    Booleanarrow-up-right
    DockStyle
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Fontarrow-up-right
    Colorarrow-up-right
    IntPtrarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    UserData
    Int32arrow-up-right
    Stringarrow-up-right
    #qxarrow-up-right
    wisej-jsarrow-up-right
    ClientEvents
    AddClientEventListener
    HasClientEventListener
    RemoveClientEventListener
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    LayoutEnginearrow-up-right
    Int32arrow-up-right
    Pointarrow-up-right
    Padding
    Sizearrow-up-right
    Sizearrow-up-right
    Keys
    MouseButtons
    Pointarrow-up-right
    Booleanarrow-up-right
    Stringarrow-up-right
    Padding
    Control
    Sizearrow-up-right
    AnchorStyles
    ResponsiveProfileCollection
    Int32arrow-up-right
    RightToLeft
    Inherit
    Inherit
    Booleanarrow-up-right
    Selectable
    Focusable
    Selectable
    Booleanarrow-up-right
    Sizearrow-up-right
    String[]arrow-up-right
    AddState
    RemoveState
    HasState
    Int32arrow-up-right
    Booleanarrow-up-right
    Focusable
    Objectarrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    ToolTipText
    ToolTip
    ToolTipText
    ForeColor
    AutomaticDelay
    InitialDelay
    AutoPopDelay
    ToolTipText
    ToolTip
    ToolTipText
    Int32arrow-up-right
    Control
    Form
    Form
    Objectarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    Int32arrow-up-right
    Int32arrow-up-right
    Int32arrow-up-right
    RemoveClientEventListener
    GetClientEventListener
    CssClass
    Stringarrow-up-right
    CssClass
    String[]arrow-up-right
    States
    States
    IAsyncResultarrow-up-right
    IAsyncResultarrow-up-right
    BeginInvoke
    IAsyncResultarrow-up-right
    IAsyncResultarrow-up-right
    Taskarrow-up-right
    Task<Object>arrow-up-right
    Taskarrow-up-right
    Booleanarrow-up-right
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    DragDropEffects
    Objectarrow-up-right
    Taskarrow-up-right
    Task<Object>arrow-up-right
    Taskarrow-up-right
    Form
    Page
    Booleanarrow-up-right
    Control
    Control
    Control
    Control
    Stringarrow-up-right
    String[]arrow-up-right
    IContainerControl
    IContainerControl
    IContainerControl
    Control
    Control
    Booleanarrow-up-right
    Booleanarrow-up-right
    CssClass
    Booleanarrow-up-right
    CssClass
    States
    Booleanarrow-up-right
    Objectarrow-up-right
    Objectarrow-up-right
    Objectarrow-up-right
    Booleanarrow-up-right
    Control
    Control
    Control
    Control
    Control
    Control
    ArgumentExceptionarrow-up-right
    ArgumentExceptionarrow-up-right
    Pointarrow-up-right
    Pointarrow-up-right
    Pointarrow-up-right
    Pointarrow-up-right
    Pointarrow-up-right
    Pointarrow-up-right
    Rectanglearrow-up-right
    Rectanglearrow-up-right
    Rectanglearrow-up-right
    Rectanglearrow-up-right
    Rectanglearrow-up-right
    Rectanglearrow-up-right
    Booleanarrow-up-right
    Booleanarrow-up-right
    CssClass
    Stringarrow-up-right
    CssClass
    String[]arrow-up-right
    States
    States
    Booleanarrow-up-right
    Booleanarrow-up-right
    Validating
    Validated
    Selectable
    Booleanarrow-up-right
    Validating
    Validated
    EventHandlerarrow-up-right
    Appear
    Disappear
    EventHandlerarrow-up-right
    AutoSize
    EventHandlerarrow-up-right
    BackColor
    EventHandlerarrow-up-right
    BackgroundImage
    EventHandlerarrow-up-right
    BackgroundImageLayout
    EventHandlerarrow-up-right
    BecomingActiveControl
    EventHandlerarrow-up-right
    BindingContext
    EventHandlerarrow-up-right
    CausesValidation
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    ClientSize
    EventHandlerarrow-up-right
    ContextMenu
    ControlEventHandler
    ControlCollection
    EventHandlerarrow-up-right
    ControlEventHandler
    ControlCollection
    EventHandlerarrow-up-right
    Cursor
    EventHandlerarrow-up-right
    Appear
    Disappear
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    Dock
    EventHandlerarrow-up-right
    DragEventHandler
    EventHandlerarrow-up-right
    DragEventHandler
    EventHandlerarrow-up-right
    DragEventHandler
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    Enabled
    EventHandlerarrow-up-right
    Movable
    Movable
    Location
    EventHandlerarrow-up-right
    ResizableEdges
    ResizableEdges
    None
    Size
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    Font
    EventHandlerarrow-up-right
    ForeColor
    EventHandlerarrow-up-right
    HelpEventHandler
    EventHandlerarrow-up-right
    KeyEventHandler
    KeyPressEventHandler
    KeyEventHandler
    LayoutEventHandler
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    Location
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    MouseEventHandler
    MouseEventHandler
    MouseEventHandler
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    MouseEventHandler
    MouseEventHandler
    MouseEventHandler
    EventHandlerarrow-up-right
    PaintEventHandler
    EventHandlerarrow-up-right
    Parent
    PinchEventHandler
    PreviewKeyDownEventHandler
    KeyDown
    QueryContinueDragEventHandler
    EventHandlerarrow-up-right
    ResponsiveProfileChangedEventHandler
    EventHandlerarrow-up-right
    RightToLeft
    RotateEventHandler
    EventHandlerarrow-up-right
    Size
    EventHandlerarrow-up-right
    Movable
    Movable
    EventHandlerarrow-up-right
    ResizableEdges
    ResizableEdges
    None
    EventHandlerarrow-up-right
    SwipeEventHandler
    EventHandlerarrow-up-right
    TabIndex
    EventHandlerarrow-up-right
    TabStop
    EventHandlerarrow-up-right
    EventHandlerarrow-up-right
    Text
    TouchEventHandler
    TouchEventHandler
    TouchEventHandler
    TouchEventHandler
    TrackEventHandler
    EventHandlerarrow-up-right
    CancelEventHandlerarrow-up-right
    EventHandlerarrow-up-right
    Visible
    WidgetEventHandler

    
      // 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;
        }
      }
    Object[]arrow-up-right
    Stringarrow-up-right
    Stringarrow-up-right
    Sizearrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Imagearrow-up-right
    Sizearrow-up-right
    Booleanarrow-up-right
    Margin
    HorizontalAlignment
    Fill
    Top
    Bottom
    VerticalAlignment
    Fill
    Left
    Right
    Int32arrow-up-right
    Controls
    Booleanarrow-up-right
    Margin
    HorizontalAlignment
    Fill
    Top
    Bottom
    VerticalAlignment
    Fill
    Left
    Right
    Int32arrow-up-right
    Controls
    Booleanarrow-up-right
    Margin
    HorizontalAlignment
    Fill
    Top
    Bottom
    VerticalAlignment
    Fill
    Left
    Right
    Rectanglearrow-up-right
    Controls
    DisplayRectangle
    Int32arrow-up-right
    Controls
    Booleanarrow-up-right
    Margin
    HorizontalAlignment
    Fill
    Top
    Bottom
    VerticalAlignment
    Fill
    Left
    Right
    Booleanarrow-up-right
    Margin
    HorizontalAlignment
    Vertical
    VerticalAlignment
    Horizontal
    Int32arrow-up-right
    Controls
    Booleanarrow-up-right
    Margin
    HorizontalAlignment
    Vertical
    VerticalAlignment
    Horizontal
    Int32arrow-up-right
    Booleanarrow-up-right
    Margin
    HorizontalAlignment
    Vertical
    VerticalAlignment
    Horizontal
    Rectanglearrow-up-right
    DisplayRectangle
    Int32arrow-up-right
    Booleanarrow-up-right
    Margin
    HorizontalAlignment
    Vertical
    VerticalAlignment
    Horizontal
    Booleanarrow-up-right
    TabStop
    Booleanarrow-up-right
    Booleanarrow-up-right
    Int32arrow-up-right
    Width
    Int32arrow-up-right
    Height
    Int32arrow-up-right
    Width
    Int32arrow-up-right
    Height
    BoundsSpecified
    BoundsSpecified
    BindingNavigator
    Button
    ButtonBase
    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
    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
    TimeSpanarrow-up-right
    TreeViewComboBox
    UserComboBox
    TreeView
    Upload
    UserComboBox
    ComboBox
    UserPopup
    Widget
    ListView
    MenuBar
    PropertyGrid
    StatusBar
    ToolBar
    TreeView
    TreeNode
    IWisejSerializable