This book covers the full API for the Wisej.Framework assembly only. For an in-depth guide of Wisej.NET features, please refer to the Concepts book. For the extensions API and concepts, please refer to the Extensions book.
Legend
Icon
Description
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.
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
ClientPlatform
Wisej.Core.ClientPlatform
Namespace: Wisej.Core
Assembly: Wisej.Framework (4.0.0.0)
Represents the client platform used to render the widgets.
LoadConfigurationEventHandler
Wisej.Core.LoadConfigurationEventHandler
Namespace: Wisej.Core
Assembly: Wisej.Framework (4.0.0.0)
Represents a method that handles the event.
Application.PageCollection
Wisej.Web.Application PageCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Holds the collection of all top-level application pages.
HashChangedEventHandler
Wisej.Web.HashChangedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the event.
Client
Wisej.Core.Client
Namespace: Wisej.Core
Assembly: Wisej.Framework (4.0.0.0)
Represents a unique client using the application.
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.
Application.FormCollection
Wisej.Web.Application FormCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Holds the collection of all top-level application forms.
RequestEventArgs
Wisej.Web.RequestEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Constructors
ClientCollection
Wisej.Core.ClientCollection
Namespace: Wisej.Core
Assembly: Wisej.Framework (4.0.0.0)
List of s using the application.
LicenseErrorEventHandler
Wisej.Web.LicenseErrorEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the event.
ResponsiveProfileChangedEventHandler
Wisej.Web.ResponsiveProfileChangedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the Application.ResponsiveProfileChanged event.
Application.RequestType
Wisej.Web.Application RequestType
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Type of incoming request. Since 3.5.5
LayoutEventHandler
Wisej.Web.LayoutEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the event of a .
KeyPressEventHandler
Wisej.Web.KeyPressEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the event of a .
PlatformProvider
Wisej.Core.PlatformProvider
Namespace: Wisej.Core
Assembly: Wisej.Framework (4.0.0.0)
Platforms supported by Wisej.
Buttons
Common Dialogs
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.
Properties
JavaScripts
String[]: List of javascript files associated with the platform.
: Returns or sets the character corresponding to the key pressed.
Used By
Name
Description
JavaScript.ClientEvent
Wisej.Web.JavaScript ClientEvent
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represent a JavaScript event and the corresponding code to execute on the client when the event is fired.
publicclassClientEvent
Public Class ClientEvent
Constructors
ClientEvent()
Initializes a new instance of .
Properties
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. (Default: null)
JavaScript
: Returns or sets the JavaScript handler for the event. (Default: "")
Public Delegate Sub WebEventHandler(ByVal sender As [Object], ByVal e As WebEventArgs)
Parameters
Name
Type
Description
PaintEventArgs
Wisej.Web.PaintEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the event.
FocusEventArgs
Wisej.Web.FocusEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the and events.Since 3.5.18
TouchEventHandler
Wisej.Web.TouchEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the , , , events.
SwipeEventArgs
Wisej.Web.SwipeEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for event.
MouseEventHandler
Wisej.Web.MouseEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the MouseDown, MouseUp, or MouseMove event of a form, control, or other component.
SwipeAxis
Wisej.Web.SwipeAxis
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Indicates the axis of the swipe gesture.
RotateEventArgs
Wisej.Web.RotateEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for event.
SwipeEventHandler
Wisej.Web.SwipeEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the event.
FocusEventHandler
Wisej.Web.FocusEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that handles these events: and .Since 3.5.18
This delegate is not used in Wisej.NET. The and events are to preserve compatibility with existing code.
Developers handling these events can simply check whether the parameter e is of type and retrieve the value by casting the event data argument.
SwipeDirection
Wisej.Web.SwipeDirection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Indicates the direction of the swipe gesture.
WebEventArgs
Wisej.Web.WebEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides data for the and events.
RequestEventHandler
Wisej.Web.RequestEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represent a method that handles the , and events. Since 3.5.5
WidgetEventHandler
Wisej.Web.WidgetEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that handles the event.
FileDialogRootCollection
Wisej.Web.FileDialogRootCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represent a collection of the root file systems shown by the implementation.
Screen
Wisej.Web.Screen
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the display on the client device.
FileDialogLoadPathEventHandler
Wisej.Web.FileDialogLoadPathEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the event.
MenuButtonItemClickedEventHandler
Wisej.Web.MenuButtonItemClickedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents the method that will handle the event of a control.
Returns the direction of the performed swipe in reference to the axis: X = Up / Down Y = Left / Right
Public Enum SwipeDirection As [Enum]
publicenumSwipeDirection:Enum
Properties
Config
Object: Returns the dynamic data object either received from the browser for the ControlUpdated event or being sent to the browser for the ControlRendered event.
Used By
Name
Description
Represents a method that handles the and events.
Since 4.0.0
Rectangle: Returns the size of the display of the client device, regardless of the orientation.
DeviceName
String: Returns the device name associated with a display.
WorkingArea
Rectangle: Returns the working area of the browser. The working area is the desktop area of the browser, excluding taskbars, docked windows, and docked tool bars.
Public Class Screen
publicclassScreen
Parameters
Name
Type
Description
sender
The source of the event.
e
A that contains the event data.
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)
Public Class FileDialogLoadPathEventArgs
Inherits CancelEventArgs
Allows an application to filter the files and folders loaded by the FileDialog and FolderBrowserDialog 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 ImageSource, CreationTime or LastWriteTime properties.
Constructors
FileDialogLoadPathEventArgs(path, isDirectory)
Constructs a new instance of .
Name
Type
Description
Properties
CreationTime
: Sets the creation DateTime of the file.
FileSize
: Sets the file size in bytes.
ImageSource
: Sets the name or path of the icon to display next to the file.
IsDirectory
: Returns true when the refers to a directory.
LastWriteTime
: Sets the last modified DateTime of the file.
Path
: Returns the full path of the file or folder being loaded.
Used By
Name
Description
BindableComponent
Wisej.Web.BindableComponent
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
JavaScript.ClientEventCollection
Wisej.Web.JavaScript ClientEventCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Represents a collection of JavaScript events and their corresponding handler code.
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.
Int32: Returns the number of times the mouse wheel has rotated.
Location
Point: Returns the location of the mouse or pointer event.
OriginalTarget
Control: Returns the original target Control when the pointer event has bubbled up because the original target was either not Enabled or Anonymous.
Role
String: Returns the internal role assigned to the element that generated the pointer event: checkbox, button, ...
The value in the Role property is taken from the "role" attribute of the clicked element inside the widget. You can detect clicks on custom HTML content by adding the role attribute to the custom element.
X
Int32: Returns the x-coordinate of the mouse or touch event.
Y
Int32: Returns the y-coordinate of the mouse or touch event.
Used By
Name
Description
Represents the method that will handle the MouseDown, MouseUp, or MouseMove event of a form, control, or other component.
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.
Properties
CultureInfo
CultureInfo: Returns the locale declared in the application configuration file or detected from the client browser.
Device
String: Device type. Can be one of "Mobile", "Tablet" or "Desktop".
Features
Object: Returns the set of features supported/not-supported by the browser. Currently we detect: geolocation, webSocket, fullScreen, speechSynthesis, speechRecognition, notification, fullScreen, browserStorage.
Size: Browser size. This is the window size, which can be different from the device (or screen) size.
TabId
String: Identifies the browser tab associated with with this ClientBrowser instance.
TimezoneId
String: Returns the current IANA time zone name. See timezone.Since 3.5.12
TimezoneInfo
TimeZoneInfo: Returns an instance of TimeZoneInfo for the current TimezoneId. May be null when the IANA time zone id cannot be resolved on the server.Since 3.5.12
TimezoneOffset
Int32: Returns the time difference between UTC time and local time, in minutes.
Type
String: Browser type. Can be one of "IE", "Edge", "Chrome", "Opera", "Firefox", "Safari", "Other".
UserAgent
String: Returns the raw user agent string of the client browser.
UserData
Object: Returns a value or map set by the client when loading the application's first HTML page.
An application can use this property to retrieve a custom value on startup. For example, in Default.html add:
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.
Initializes a new instance of the DragEventArgs class.
Name
Type
Description
allowedEffect
One of the values.
effect
One of the values.
Properties
AllowedEffect
DragDropEffects: Returns which drag-and-drop operations are allowed by the originator (or source) of the drag event.
AllowedFileTypes
String: Specify the types of files that the server accepts (that can be submitted through a file upload).
The allowed files string follows the HTML 4.01 and HTML5 specifications. You can configure only one entry in the browser's file dialog. The syntax is "file_extension|audio/|video/|image/*|media_type". Look at IANA Media Types for a complete list of standard media types.
Allows the user to select a folder from one of the .
Constructors
FolderBrowserDialog()
Initializes a new instance of .
FolderBrowserDialog(roots)
Initializes a new instance of using the initial roots .
Name
Type
Description
FolderBrowserDialog(container)
Initializes a new instance of the extender with a specified container.
Name
Type
Description
Properties
Description
: Returns or sets the description splayed above the tree view control in the dialog box. (Default: "")
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.
The deafult value is an empty
SelectedPath
: Returns sets the path selected by the user. (Default: "")
ShowHelp
: Returns or sets whether the Help button is displayed in the file dialog box. (Default: False)
Title
: Returns or sets the file dialog box title. (Default: "")
Methods
CreateUI()
Returns: .
GetRoot(path)
Returns the that contains the specified path .
Parameter
Type
Description
Returns: . The that contains the specified path or null if not found.
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.
OnLoadPath(e)
Fires the event.
Parameter
Type
Description
Reset()
Resets all properties to their default values.
Events
LoadPath
Fired when the file dialog is loading a file or folder.
Initializes a new instance of the class with specific initial settings.
Name
Type
Description
Properties
Orientation
: Returns or sets a value indicating the layout of the . When the value is set to the down arrow is places below the text, otherwise it's to the right of the text. (Default: Horizontal)
When overridden in a derived class, resets the properties of a common dialog box to their default values.
ShowDialog()
Runs a common dialog box with a default owner.
Returns:DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.
ShowDialog(onclose)
Runs a common dialog box with a default owner.
Parameter
Type
Description
onclose
Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the 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.
Returns:DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.
ShowDialog(owner)
Runs a common dialog box with the specified owner.
Parameter
Type
Description
owner
A that represents the top-level window that owns the modal dialog box. It can be null.
Returns:DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.
ShowDialog(owner, onclose)
Runs a common dialog box with the specified owner.
Parameter
Type
Description
owner
A that represents the top-level window that owns the modal dialog box. It can be null.
onclose
Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the 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.
Returns:DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.
ShowDialogAsync(owner)
Runs a common dialog box with the specified owner asynchronously.
Parameter
Type
Description
owner
A that represents the top-level window that owns the modal dialog box. It can be null.
Initializes a new instance of the SaveFileDialog extender with a specified container.
Name
Type
Description
container
An that represents the container of the component.
Properties
CreatePrompt
Boolean: 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. (Default: False)
OverwritePrompt
Boolean: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that already exists. (Default: True)
Methods
OpenFile()
Opens the file with read/write permission selected by the user.
Returns:Stream. A Stream that specifies the read/write file selected by the user.
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
child
The to search for in the control collection.
throwException
true to throw an exception if the specified in the child parameter is not a control in the ; otherwise, false.
Returns:Int32. A zero-based index value that represents the location of the specified child control within the control collection; otherwise -1 if the specified Control is not found in the ControlCollection.
Implements the basic functionality common to button controls.
Constructors
ButtonBase()
Initializes a new instance of the class.
Properties
AllowHtml
: Returns or sets a value indicating that the control can display HTML in the Text property. (Default: False)
Newlines (CRLF) are converted to <BR/> when is false, or when is true and the text doesn't contain any HTML.
AllowMarkdown
: Returns or sets a value indicating that the control can display markdown text as HTML in the Text property. (Default: False)
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. (Default: False)
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. (Default: False)
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.
AutoSize
: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: False)
CharacterCasing
: Returns or sets the case of the text to display to the user. (Default: Normal)
Command
: Returns or sets the implementation to invoke. (Default: null)
DefaultSize
:
Image
: Returns or sets the image that is displayed in a button control.
ImageAlign
: Returns or sets the alignment of the image in the button control. (Default: MiddleCenter)
ImageIndex
: Returns or sets the image list index value of the image in the displayed in the button control. (Default: -1)
Throws:
The specified index is less than -1.
ImageKey
: Returns or sets the key accessor for the image in the displayed in the button control. (Default: "")
ImageList
: Returns or sets the that contains the displayed in a button control. (Default: null)
ImageSource
: Returns or sets the theme name or URL for the image to display in the button control.
IsDefault
: Returns or sets whether the button control is the default button.
Text
: Returns or sets the text associated with this control. (Default: "")
Newlines (CRLF) are converted to <BR/> when is false, or when is true and the text doesn't contain any HTML.
TextAlign
: Returns or sets the alignment of the text in the button control. (Default: MiddleCenter)
TextImageRelation
: Returns or sets the position of text and image relative to each other. (Default: ImageBeforeText)
UseMnemonic
: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control. (Default: True)
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.
Constructors
FileDialog()
Initializes a new instance of .
FileDialog(roots)
Initializes a new instance of using the initial roots .
Name
Type
Description
FileDialog(container)
Initializes a new instance of the extender with a specified container.
Name
Type
Description
Properties
AddExtension
: Returns or sets whether the dialog box automatically adds an extension to a file name if the user omits the extension. (Default: True)
CheckFileExists
: Returns or sets whether the dialog box displays a warning if the user specifies a file name that does not exist. (Default: False)
DefaultExtension
: Returns or sets the default file name extension. (Default: "")
FileName
: Returns or sets a string containing the file name selected in the file dialog box. (Default: "")
FileNames
: Returns the file names of all selected files in the dialog box.
FileSystem
: Returns the that contains the selected .
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. (Default: "")
FilterIndex
: Returns or sets the index of the filter currently selected in the file dialog box. (Default: 1)
InitialDirectory
: Returns or sets the initial directory displayed by the file dialog box. (Default: "")
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.
ShowHelp
: Returns or sets whether the Help button is displayed in the file dialog box. (Default: False)
Title
: Returns or sets the file dialog box title. (Default: "")
Methods
CreateUI()
Returns: .
GetRoot(path)
Returns the that contains the specified path .
Parameter
Type
Description
Returns: . The that contains the specified path or null if not found.
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.
OnFileOk(e)
Fires the event.
Parameter
Type
Description
OnLoadPath(e)
Fires the event.
Parameter
Type
Description
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.
PromptFileNotFound(fileName)
Informs the user that the file specified in fileName doesn't exist. You can override this method to provide your text and localization.
Parameter
Type
Description
Reset()
Resets all properties to their default values.
Events
FileOk
Fired when the user clicks on the Open or Save button on a file dialog box.
LoadPath
Fired when the file dialog is loading a file or folder.
Inherited By
Name
Description
Configuration
Wisej.Core.Configuration
Namespace: Wisej.Core
Assembly: Wisej.Framework (4.0.0.0)
Configuration settings.
Clipboard
Wisej.Web.Clipboard
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Provides methods to place data on and retrieve data from the system Clipboard. This class cannot be inherited.
Controls that support drag & drop operations implement this interface.
Constructors
Configuration(json)
Creates a new instance from the specified json string.
Name
Type
Description
json
The json string that defines the configuration values.
Properties
AllowedRoutes
String[]: List of allowed Url routes separated by a semicolon. i.e.: "api;product;log/performance".
AutoReload
Boolean: 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.
BrowserCheck
String: The custom function used to validate the browser. If it returns false the browser is not supported and Wisej redirects to NotSupportedUrl.
Culture
String: 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.
Boolean: 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.
DisableMinification
Boolean: When true, dynamic minification is turned off also in release mode.
DropDuplicateClicks
Boolean: When true, the client drops all "execute" events triggered while there is a pending request.
EmbeddedResourcesCacheControl
String: Cache-Control for embedded resources. The default is "browser" to cache the embedded resources on the browser for 1 month. Other allowed values 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.
EnablePWA
Boolean: Enables the PWA installation of the application.
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.
InvalidSessionHttpCode
Int32: Determines the HTTP code that Wisej.NET returns to the browser when a request cannot be authenticated with a valid session. The default is 200 (OK). Set it to 401 (Not Authorized) in case a deployment requires it.
String: Full name of the first window created automatically at startup.
MaxModalStack
Int32: Returns the maximum number of nested modal loops.
MaxSessions
Int32: Returns the maximum number of active sessions before redirecting to NotAvailableUrl.
MaxSessionsPerClient
Int32: Limits the number of sessions that can be associated with a client. The default is 50. Set it to 0 for unlimited. Use this configuration option to protect again potential DoS attacks. It's supported only on professional server editions or higher.
NetworkCheckInterval
Int32: Network check interval in milliseconds. The default is 1000 (1 second). Wisej.NET will send a /healthcheck.wx request at the specified interval when the application goes offline.
NotAvailableUrl
String: The URL of the page to load when the server cannot respond to the request.
NotSupportedUrl
String: The URL of the page to load when the client browser is not supported.
OfflineUrl
String: The URL of the page to load when the connection is lost.
Int32: 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.
ResponseTimeout
Int32: The timeout for the server to respond to a Wisej request in seconds.
RightToLeft
String: 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".
Secure
Boolean: Forces the client to switch to a secure connection (HTTPS and WSS).
SessionStorage
String: 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.
SessionTimeout
Int32: The session timeout in seconds. The timeout is enforced on the client side.
Boolean: Verifies the client's unique id when retrieving a session. It prevents session hijacking over unsecured connections.
ValidateResources
Boolean: Verifies that resource requests are received from the user's authorizes browser. Prevents reusing a resource URL from an unauthorized browser.
WebSocketCompressionThreshold
Int32: Sets the response size that triggers the compression of the response over the WebSocket channel.
An application can install a custom configuration handler and return a custom Configuration object. In alternative, the handler can change the value of FilePath and let Wisej.NET load the alternative json file. This is a static event and should be attached to before the application starts. One way to do that is to register an HttpModuleStartup method with IIS when using .NET 4.8. When running on .NET Core, attach to the event in the Startup method.
Public Class Configuration
publicclassConfiguration
Methods
Clear()
Removes all data from the Clipboard.
ContainsAudio()
Indicates whether there is data on the Clipboard in the WaveAudio format.
Returns:Boolean. true if there is audio data on the Clipboard; otherwise, false.
ContainsData(format)
Indicates whether there is data on the Clipboard that is in the specified format or can be converted to that format.
Parameter
Type
Description
format
The format of the data to look for. See for predefined formats.
Returns:Boolean. true if there is data on the Clipboard that is in the specified format or can be converted to that format; otherwise, false.
ContainsFileDropList()
Indicates whether there is data on the Clipboard that is in the FileDrop format or can be converted to that format.
Returns:Boolean. true if there is a file drop list on the Clipboard; otherwise, false.
ContainsImage()
Indicates whether there is data on the Clipboard that is in the Bitmap format or can be converted to that format.
Returns:Boolean. true if there is image data on the Clipboard; otherwise, false.
ContainsText()
Indicates whether there is data on the Clipboard in the Text or UnicodeText format, depending on the operating system.
Returns:Boolean. true if there is text data on the Clipboard; otherwise, false.
ContainsText(format)
Indicates whether there is text data on the Clipboard in the format indicated by the specified TextDataFormat value.
Parameter
Type
Description
format
One of the values.
Returns:Boolean. true if there is text data on the Clipboard in the value specified for format ; otherwise, false.
GetAudioStream()
Retrieves an audio stream from the Clipboard.
Returns:Stream. A Stream containing audio data or null if the Clipboard does not contain any data in the WaveAudio format.
GetData(format)
Retrieves data from the Clipboard in the specified format.
Parameter
Type
Description
format
The format of the data to retrieve. See for predefined formats.
Returns:Object. An Object representing the Clipboard data or null if the Clipboard does not contain any data that is in the specified format or can be converted to that format.
GetDataObject()
Retrieves the data that is currently on the system Clipboard.
Returns:IDataObject. An IDataObject that represents the data currently on the Clipboard, or null if there is no data on the Clipboard.
GetFileDropList()
Retrieves a collection of file names from the Clipboard.
Returns:StringCollection. A StringCollection containing file names or null if the Clipboard does not contain any data that is in the FileDrop format or can be converted to that format.
GetImage()
Retrieves an image from the Clipboard.
Returns:Image. An Image representing the Clipboard image data or null if the Clipboard does not contain any data that is in the Bitmap format or can be converted to that format.
GetText()
Retrieves text data from the Clipboard in the Text or UnicodeText format, depending on the operating system.
Returns:String. The Clipboard text data or Empty if the Clipboard does not contain data in the Text or UnicodeText format, depending on the operating system.
GetText(format)
Retrieves text data from the Clipboard in the format indicated by the specified TextDataFormat value.
Parameter
Type
Description
format
One of the values.
Returns:String. The Clipboard text data or Empty if the Clipboard does not contain data in the specified format.
SetAudio(audioBytes)
Saves the Byte array in the WaveAudio format after converting it to a Stream to the clipboard.
Saves the text data to the client's temporary clipboard. Client side javascript code can copy the clipboard's content to the browser's clipboard calling Wisej.Core.copy();
Parameter
Type
Description
text
The text to save to the client's temporary clipboard.
ArgumentExceptionfilePaths does not contain any strings, or at least one of the strings in filePaths is empty, contains only white space, contains one or more invalid characters as defined by InvalidPathChars, is null, contains a colon (:), or exceeds the system-defined maximum length. See the InnerException property of the ArgumentException for more information.
SetImage(image)
Saves the Image in the Bitmap format to the clipboard
Initializes a new instance of the class with specific initial settings.
Name
Type
Description
Properties
Appearance
: Returns or sets the value that determines the appearance of a control. (Default: Normal)
AutoCheck
: Returns or set a value indicating whether the or values and the 's appearance are automatically changed when the is clicked. (Default: True)
AutoSize
: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: True)
AutoToolTip
: Returns or sets whether a tooltip is displayed when the text extends beyond the size of the control. (Default: False)
The auto tooltip is set on the browser using the attribute managed by the browser, does not use the themed tooltip managed by Wisej.NET.
CheckAlign
: Returns or sets the horizontal and vertical alignment of the check mark on a control. (Default: MiddleLeft)
Checked
: Gets or sets whether the control is checked. (Default: False)
CheckedForeColor
: Returns or sets the text color used when the is checked. (Default: Color [Empty])
DefaultSize
: Returns the default size of the control.
Invalid
: Returns or sets a value that indicates that the control is invalid. (Default: False)
InvalidMessage
: Returns or sets the invalid message that is shown in the invalid tooltip. (Default: "")
ReadOnly
: Returns or sets whether the control is read-only. (Default: False)
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. (Default: False)
TextAlign
: Returns or sets the alignment of the text on the control. (Default: MiddleLeft)
Methods
OnAppearanceChanged(e)
Fires the event.
Parameter
Type
Description
OnCheckedChanged(e)
Fires the event.
Parameter
Type
Description
OnClick(e)
Fires the event.
Parameter
Type
Description
OnForeColorChanged(e)
Fires the event.
Parameter
Type
Description
OnReadOnlyChanged(e)
Fires the event.
Parameter
Type
Description
OnValidating(e)
Fires the event.
Parameter
Type
Description
OnWebRender(config)
Renders the client component.
Parameter
Type
Description
PerformClick()
Generates a event for a .
Events
AppearanceChanged
Fired when the value of the property changes.
CheckedChanged
Fired when the value of the property changes.
ReadOnlyChanged
Fired when the value of the property has changed.
Implements
Name
Description
CheckBox
Wisej.Web.CheckBox
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Button
Wisej.Web.Button
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
<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());
}
}
}
}
Appearance: Returns or sets the value that determines the appearance of a CheckBox control. (Default: Normal)
AutoCheck
Boolean: 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. (Default: True)
AutoSize
Boolean: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: True)
AutoToolTip
Boolean: Returns or sets whether a tooltip is displayed when the text extends beyond the size of the control. (Default: False)
The auto tooltip is set on the browser using the title attribute managed by the browser, does not use the themed tooltip managed by Wisej.NET.
CheckAlign
ContentAlignment: Returns or sets the horizontal and vertical alignment of the check mark on a CheckBox control. (Default: MiddleLeft)
Checked
Boolean: Returns or set a value indicating whether the CheckBox is in the checked state. (Default: False)
CheckedForeColor
Color: Returns or sets the text color used when the CheckBox is checked. (Default: Color [Empty])
CheckState
CheckState: Returns or sets the state of the CheckBox. (Default: Unchecked)
Boolean: 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. (Default: False)
Shortcut
Shortcut: Returns or sets a value indicating the shortcut key associated with the button. (Default: None)
Methods
Dispose(disposing)
Disposes the control.
Parameter
Type
Description
disposing
true when this method is called by the application rather than a finalizer.
OnAddReferences(items)
Adds references components to the list. Referenced components can be added individually or as a reference to a collection.
Parameter
Type
Description
items
Container for the referenced components or collections.
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.
Constructors
ClientTheme(name)
Default private constructor.
Name
Type
Description
ClientTheme(name, json)
Constructs a new theme from the name and JSON definition.
Name
Type
Description
ClientTheme(name, baseTheme)
Constructs a new theme from the base theme.
Name
Type
Description
Properties
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.
Colors
: Theme colors.
You can add or change any color in the current theme:
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:
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.
Name
: The name of the theme.
Settings
: Theme settings.
The Settings property allows a theme to define certain internal properties. Currently these are the supported properties:
native-scrollbars Instructs Wisej.NET 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.
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.
Methods
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.
GetColor(name)
Returns the resolved theme color from the color list.
Parameter
Type
Description
Returns: . A representing the color in the theme.
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.
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.
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.
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.
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
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.
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.
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.
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.
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.
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.
Implements
Name
Description
// 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);
The name of the state to query. It's optional. The default is "default".
The name of the state to query. It's optional. The default is "default".
The name of the state to query. It's optional. The default is "default".
Whether to include padding in the insets dimension.
The name of the property to retrieve.
state
The state that defines the property. It can omitted, the default state is "default".
The name of the property to retrieve.
state
The state that defines the property. It can omitted, the default state is "default".
// 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 };"
};
Initializes a new instance of the class and adds the specified object to it.
Name
Type
Description
DataObject(format, data)
Initializes a new instance of the class and adds the specified object in the specified format.
Name
Type
Description
DataObject(format, data)
Initializes a new instance of the class and adds the specified object in the specified format.
Name
Type
Description
Methods
ContainsAudio()
Indicates whether the data object contains data in the format.
Returns: . true if the data object contains audio data; otherwise, false.
ContainsFileDropList()
Indicates whether the data object contains data that is in the format or can be converted to that format.
Returns: . true if the data object contains a file drop list; otherwise, false.
ContainsImage()
Indicates whether the data object contains data that is in the format or can be converted to that format.
Returns: . true if the data object contains image data; otherwise, false.
ContainsText()
Indicates whether the data object contains data in the format.
Returns: . true if the data object contains text data; otherwise, false.
ContainsText(format)
Indicates whether the data object contains text data in the format indicated by the specified value.
Parameter
Type
Description
Returns: . true if the data object contains text data in the specified format; otherwise, false.
GetAudioStream()
Retrieves an audio stream from the data object.
Returns: . A containing audio data or null if the data object does not contain any data in the format.
GetData(format)
Returns the data associated with the specified class type format.
Parameter
Type
Description
Returns: . The data associated with the specified format, or null.
GetData(format)
Returns the data associated with the specified data format.
Parameter
Type
Description
Returns: . The data associated with the specified format, or null.
GetData(format, autoConvert)
Returns the data associated with the specified data format, using an automated conversion parameter to determine whether to convert the data to the format.
Parameter
Type
Description
Returns: . The data associated with the specified format, or null.
GetDataPresent(format)
Determines whether data stored in this is associated with, or can be converted to, the specified format.
Parameter
Type
Description
Returns: . true if data stored in this is associated with, or can be converted to, the specified format; otherwise, false.
GetDataPresent(format)
Returns the data associated with the specified class type format.
Parameter
Type
Description
Returns: . The data associated with the specified format, or null.
GetDataPresent(format, autoConvert)
Determines whether this contains data in the specified format or, optionally, contains data that can be converted to the specified format.
Parameter
Type
Description
Returns: . true if the data is in, or can be converted to, the specified format; otherwise, false.
GetFileDropList()
Returns the list of file types from the data object.
Returns: . A string array containing the file types in the data object.
GetFiles()
Returns the of files uploaded by the client in a drag & drop operation.
Returns: . A string array containing the file types in the data object.
GetFormats()
Returns a list of all formats that data stored in this is associated with or can be converted to.
Returns: . An array of type , containing a list of all formats that are supported by the data stored in this object.
GetFormats(autoConvert)
Returns a list of all formats that data stored in this is associated with or can be converted to, using an automatic conversion parameter to determine whether to retrieve only native data formats or all formats that the data can be converted to.
Parameter
Type
Description
Returns: . An array of type , containing a list of all formats that are supported by the data stored in this object.
GetImage()
Retrieves an image from the data object.
Returns: . An representing the image data in the data object or null if the data object does not contain any data that is in the format or can be converted to that format.
GetText()
Retrieves text data from the data object in the format.
Returns: . The text data in the data object or if the data object does not contain data in the format.
GetText(format)
Retrieves text data from the data object in the format indicated by the specified value.
Parameter
Type
Description
Returns: . The text data in the data object or if the data object does not contain data in the specified format.
SetAudio(audioBytes)
Adds a array to the data object in the format after converting it to a .
Parameter
Type
Description
Throws:
audioBytes is null.
SetAudio(audioStream)
Adds a to the data object in the format.
Parameter
Type
Description
Throws:
audioStream is null.
SetData(data)
Adds the specified object to the using the object type as the data format.
Parameter
Type
Description
SetData(format, data)
Adds the specified object to the using the specified type as the format.
Parameter
Type
Description
SetData(format, data)
Adds the specified object to the using the specified format.
Parameter
Type
Description
SetData(format, autoConvert, data)
Adds the specified object to the using the specified format and indicating whether the data can be converted to another format.
Parameter
Type
Description
SetDownloadURL(url, fileName)
Adds a url using format. The specified url is parsed to compose the DownloadURL as: "mime-type:file-name:url".
Parameter
Type
Description
SetFileDropList(filePaths)
Adds a collection of file names to the data object in the format.
Parameter
Type
Description
Throws:
filePaths is null.
SetFileDropList(filePaths)
Adds a collection of file names to the data object in the format.
Parameter
Type
Description
Throws:
filePaths is null.
SetImage(image)
Adds an to the data object in the format.
Parameter
Type
Description
Throws:
image is null.
SetText(textData)
Adds text data to the data object in the format.
Parameter
Type
Description
Throws:
textData is null or .
SetText(textData, format)
Adds text data to the data object in the format indicated by the specified value.
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.
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.
Public Class Application
Inherits IWisejComponent
Implements IDisposable, IWisejSynchronized
This class provides several static methods, properties and events that allow the application to manage all sorts of features related to the current session:
Save and retrieve session variable. Use to store and retrieve session variable. The property is a dynamic object and a , therefore you can access its properties directly or through the indexer.
Manage cookies. Use to manage browser's cookies.
Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.
Read the application's URL. Use ,
There is a lot more exposed by the class. You can inspect all the properties and methods in Visual Studio through IntelliSense or online at .
Properties
ActiveProfile
: Returns or sets the current client responsive profile.
This is the profile that best matches the current browser on the client. It is updated automatically on every request.
Browser
: Returns or the client browser's information.
ClientCertificate
: EXPERIMENTAL: Provides the client certificate fields issued by the client in response to the server's request for the client's identity. Since 3.5.6
ClientId
: Returns the current unique client id.
Clients
: Returns a collection of all the unique client browsers using the application.
CommandManager
: Returns the current .
CommonAppDataPath
: Returns the path for the application data that is shared among all users.
CommonAppDataRegistry
: Returns the registry key for the application data that is shared among all users.
CompanyName
: Returns the company name associated with the application stored in the .
Configuration
: Returns the current .
Cookies
: Collection of cookies.
Current
: Returns the application component instance that an application can store and use later to restore the context when updating client widgets during an out-of-bound call using the method.
Threads that are not started using don't have any knowledge of the current session and don't have a way to communicate with the client The property returns the instance of the class that is bound to the current session. It can be used just like any other component with the method or to restore the session for the current thread. The advantage of using instead of the instance of a control or a page is to avoid to keep a reference to a component that may be disposed by the application.
CurrentCulture
: Returns or sets the current for the session.
Desktop
: Returns or sets the current Desktop.
EnableUnloadConfirmation
: Returns or sets whether the browser will ask the user to confirm unloading the current page.
This property attaches the window.onbeforeunload event. See https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onbeforeunload. It's not possible to determine whether the page is being unloaded because the user is trying to close the tab, close the browser, or is refreshing the page, or is taking any other action that may reload the page.
ExecutablePath
: Returns the path for the application's main assembly.
FavIcon
: Returns or sets the favicon to display in the browser.
FavIconSource
: Returns or sets the URL to the favicon to display in the browser.
Hash
: Returns or sets the hash part of the URL on the client.
IsAuthenticated
: Returns a value indicating whether the session has been authenticated.
IsDisposed
: Indicates that the current application instance, which corresponds to the session, has been terminated and disposed.
IsExpired
: Returns true when the current session has expired.
IsSecure
: Returns true if this session is running in secure mode (https:// and wss://)
IsTerminated
: Returns true when the current session has been terminated.
IsWebSocket
: Returns true if the current session is connected using WebSocket.
LicenseInfo
: Returns a dynamic object containing the currently loaded license information. Since 3.1.3
These are the currently available fields (may change in future releases):
Valid: Whether the license is valid. Note that a license may be expired and valid if the product release date is within the license expiration date.
LicenseKey: License key loaded from web.config or assigned to .
ProductName: Full name of the licensed product.
Retrieve the values either using a dynamic object or a property indexer:
LicenseKey
: Returns or sets the runtime server license key.
Setting the programmatically has to be done before the application is loaded. The best place is the static constructor for the Program static class, or the static constructor of the main window (if defined in Default.js).
MainPage
: Returns or sets the current full page window.
OpenForms
: Returns a collection of open forms owned by the application.
OpenPages
: Returns a collection of open pages owned by the application.
Platform
: The name of the currently loaded platform.
ProductName
: Returns the product name associated with this application.
ProductVersion
: Returns the product version associated with this application stored either in or .
QueryString
: Returns the parameters used to launch the application.
Referrer
: Returns the original URL from the first "HTTP_REFERER" header. Corresponds to the new custom server variable "ORIGINAL_REFERRER".
This value is an empty string in most cases, since it contains the URL of the first non Wisej.NET page loaded in the browser, from which a user has clicked an hyperlink to navigate to the Wisej.NET application.
RightToLeft
: Returns or sets whether all the controls in the applications should operate using the right-to-left mode.
The value of this property is updated automatically when the current language changes if the value of "rightToLeft" in the application configuration file is set to "auto".
RuntimeMode
: Returns true when the application is running in not in design, debug or test mode.
ServerName
: Returns the server's host name, DNS alias, or IP address as it would appear in self-referencing URLs.
ServerPort
: Returns the port number to which the request was sent.
ServerVariables
: Returns the server variables.
Services
: Returns the implementation used by Wisej.NET to manage Dependency Injection across the application. Since 3.1
Session
: Provides a generic storage for session-based objects.
SessionCount
: Returns the total number of currently active sessions.
SessionId
: Returns the unique current session ID.
ShowConsole
: Shows or hides the debug console on the browser.
Displays a simple HTMl only debug console. Works with any browser also when the developer tools are not available.
ShowLoader
: Returns or sets whether the browser is blocked by the Ajax loader.
StartupPath
: Returns the root path of the web application.
StartupUri
: Returns the URI used to start the application.
StartupUrl
: Returns the URL used to start the application.
Theme
: Returns or sets the current .
You can create and modify a new custom theme using the class. The new theme can be based on an existing theme, can be empty, or can be initialized from a JSON string.
You may also alter a global theme shared by all sessions.
Title
: Returns or sets the page title in the browser.
Uri
: Returns the current used either to launch or reload the application. It may be different from .
Url
: Returns the current URL used either to launch or reload the application. It may be different from .
User
: Returns the security information for the current request.
UserAgent
: Returns the raw user agent string of the client browser.
UserHostAddress
: Returns the IP host address of the remote client.
UserHostName
: Returns the DNS name of the remote client.
UserIdentity
: Returns the type for the current user.
UserLanguages
: Gets a sorted string array of client language preferences.
Methods
AddEventFilter(filter)
Adds an event filter to monitor all the incoming events before they are routed to their respective component.
Parameter
Type
Description
AddTranslation(text, translation)
Adds the text and corresponding translation to the default locale on the client.
Parameter
Type
Description
AlertAsync(message)
Instructs the browser to display a dialog with an optional message, and to wait until the user dismisses the dialog.
Parameter
Type
Description
Returns: . An awaitable that represents the asynchronous operation.
Call(function, args)
Executes the JavaScript function on the client.
Parameter
Type
Description
Call(function, callback, args)
Executes the JavaScript function on the client and receives the return value (or null) in the callback method.
Parameter
Type
Description
CallAsync(function, args)
Asynchronously executes the JavaScript function on the client and returns an awaitable with the result of the remote call.
Parameter
Type
Description
Returns: . An awaitable that represents the asynchronous operation.
CancelFullScreen()
Cancels the fullscreen mode.
ConfirmAsync(message)
Instructs the browser to display a dialog with an optional message, and to wait until the user either confirms or cancels the dialog. until the user dismisses the dialog.
Parameter
Type
Description
Returns: . An awaitable that represents the asynchronous operation.
Executes the JavaScript script on the client and receives the return value (or null) in the callback method.
Parameter
Type
Description
EvalAsync(script)
Asynchronously executes the JavaScript script on the client and returns an awaitable with the result of the remote call.
Parameter
Type
Description
Returns: . An awaitable that represents the asynchronous operation.
Exit()
Terminates the application and the corresponding session.
FindComponent(match)
Find the first component that matches the conditions defined in the predicate function.
Parameter
Type
Description
Returns: . The first qualified by the match expression.
This method lets an application find any live component in the current session.
FindComponents(match)
Finds all the components that match the conditions in the predicate function.
Parameter
Type
Description
Returns: . The list of instances qualified by the match expression.
This method lets an application iterate through all the live components in the current session.
GetInstance<T>(reference, builder)
Returns a session-static instance of T . Since 3.2.7
Parameter
Type
Description
Returns: . The singleton instance of T associated with the current session.
This utility method simplifies the management of session-static (or session singleton) instances. It should be used to convert traditional static variables to session-static instances when changing an application designed for single users to a multi-user system. The code below shows how to use this feature together with the to manage session-static instances and, at the same time, improve the speed of the code that relies on the singleton objects. Using the backing field allows the code that retrieves the session-static instance to quickly check the last instance and compare the session id and avoid accessing the dictionary for every access within the same request. Otherwise the code would have to always store a local variable in order to speed up multiple operations using the same static field.
If the class a private constructor (to simulate a static class) or required initialization code or arguments, use the optional builder method:
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.
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.
LoadPackages(packages, callback)
Loads the JavaScript files indicated in the packages list.
Parameter
Type
Description
Scripts are cached using the name specified in the item and loaded only once.
LoadPackagesAsync(packages)
Loads the JavaScript files indicated in the packages list asynchronously.
Parameter
Type
Description
Returns: .
Scripts are cached using the name specified in the item and loaded only once.
LoadTheme(name, mixins)
Changes the current theme.
Parameter
Type
Description
MapPath(path)
Returns the full file path in relation to the application's project directory.
Parameter
Type
Description
Returns: . The full path relative to the current application's root directory.
Navigate(url, target)
Navigate to the specified URL.
Parameter
Type
Description
Navigate(url, target, onclose)
Navigate to the specified URL in a new browser tab and receive an optional callback when the tab is closed.
Parameter
Type
Description
OpenWindow(url, target, windowFeatures, onclose)
Opens the specified URL in a browser's popup window and receive an optional callback when the tab is closed.
Parameter
Type
Description
Play(type)
Plays one of the built-in sounds
Parameter
Type
Description
Play(soundUrl)
Plays a sound.
Parameter
Type
Description
Post(callback)
Executes the callback method after all processing is completed and before updating the client.
Parameter
Type
Description
The Post() method is similar to the BeginInvoke() method used by desktop applications. It allows you to execute a block of code out of sync with the current execution flow.
Print(control)
Prints the specified control.
Parameter
Type
Description
The control is printed without the caption or the borders, if present.
Print()
Prints the entire browser window.
PromptAsync(message, defaultValue)
Instructs the browser to display a dialog with an optional message prompting the user to input some text, and to wait until the user either submits the text or cancels the dialog.
Parameter
Type
Description
Returns: . An awaitable that represents the asynchronous operation.
RefreshSessionId()
Generates a new session id without losing the session. Since 3.5.2
Use this method after a successful login to prevent potential session fixation attacks.
Reload()
Causes the application to reload on the browser.
RemoveEventFilter(filter)
Removes the filter from the list of registered event filters.
Parameter
Type
Description
RequestFullScreen()
Requests the browser to enable fullscreen mode if supported.
RunInContext(context, action)
Executes the callback in context.
Parameter
Type
Description
SetInstance<T>(reference, instance)
Replaces the object assigned to a session-static singleton. Since 3.5.2
Parameter
Type
Description
SetSessionTimeout(seconds)
Sets the current session timeout in seconds.
Parameter
Type
Description
StartPolling(interval)
Instructs the client to start polling the server for UI changes at the specified interval when a WebSocket connection is not available.
Parameter
Type
Description
Calling this method when is true has no effect. Use client side polling when you know that your code will start a background task that needs to update the client asynchronously (push updates) and your server or clients don't support WebSocket connections. Once the background tasks are completed call to reduce the incoming requests from the client.
Throws:
The interval specified is less than 1.
StartTask(action)
Starts a new task within the current application context and returns immediately. See also .
Parameter
Type
Description
Returns: . An awaitable .
The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the method to push the UI updates to the client browser. If you want to support background updates for clients or servers that can't use the WebSocket connection, you can either add a component to the parent container to force period requests to the server, or you can use the and methods.
StartTask<T>(action)
Starts a new task with a return value within the current application context and returns immediately. See also .
Parameter
Type
Description
Returns: .
The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the method to push the UI updates to the client browser. The generics overload of allows the task to return a value. You can use this with the async/await pattern and asynchronously wait for the task to complete. If you want to support background updates for clients or servers that can't use the WebSocket connection, you can either add a component to the parent container to force period requests to the server, or you can use the and methods.
Note that you don't have to specify the type in the angular brackets, the compiler will automatically detect the type from the return value of the asynchronous function.
StartTimer(dueTime, period, callback)
Starts a bound to the current session context.
Parameter
Type
Description
Returns: . An instance of .
You must save a reference to the returned or the Garbage Collector will stop and dispose the timer. To alter the invocation period user Timer.Changer(), or stop the timer simply use Timer.Dispose(). See .
Update(context, action)
Executes the optional callback in context and pushes all the pending updates to the client when in WebSocket mode.
Parameter
Type
Description
Use this method when you need to update the client asynchronously from an out-of-bound thread (different thread, not originating from a client request). You can call this method at the end of the code that updates the UI:
Or you can use the optional action function to enclose the code that updates the UI in a block and ensure that the client is updated when the code block exits:
Events
ActiveWindowChanged
Fired when the active window changes.
ApplicationExit
Fired when the application is about to shut down.
ApplicationRefresh
Fired when the application is reloaded in the browser because the user hit refresh or changed the URL.
ApplicationStart
Fired when the application is started, after the Main method is called.
BeforeInstallPrompt
Fired when the browser fires the "beforeinstallprompt" event. Corresponds to .
BeginRequest
Fired at the beginning of every request.
BrowserSizeChanged
Fired when the user resizes the browser.
BrowserTabActivated
Fired when the user activates the browser tab.
BrowserTabDeactivated
Fired when the user deactivates the browser tab.
CultureChanged
Fired when the changes.
EndRequest
Fired at the end of every request.
FocusedControlChanged
Fired when the focused control changes.
HashChanged
Fired when the hash part of the URL changes on the client side.
Idle
Fired when the current thread has completed processing all the events and before the response is sent back to the client.
ImpersonationBegin
Fired right after , only when is set to true, to allow user code to take over the thread impersonation operations.
Set e.Handled to true if your application takes care of impersonation; otherwise false to let the default implementation attempt to impersonate the user. This event is not related to a session. It is best to attach to this event from a static type initializer, otherwise each listener will be called for every thread, regardless of the session. The default implementation in Wisej.NET is supported only in .NET Framework and the Windows platform.
ImpersonationEnd
Fired at the end of every request when impersonation is enabled in the JSON configuration file.
Set e.Handled to true if your application takes care of impersonation; otherwise false to let the default implementation attempt to impersonate the user. This event is not related to a session. It is best to attach to this event from a static type initializer, otherwise each listener will be called for every thread, regardless of the session. The default implementation in Wisej.NET is supported only in .NET Framework and the Windows platform.
LicenseError
Fired when a license error occurs.
ResponsiveProfileChanged
Fired when the active responsive profile is changed.
RightToLeftChanged
Fired when the value changes.
SessionTimeout
Fired when the session is about to time out.
The default behavior built-in Wisej is to display a dialog asking the user to prolong the session. Set Handled to true to stop the default behavior.
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.
CustomerName: Name of the registered customer that owns the license.
ExpirationDate: Expiration date for the product free updates.
The arguments to pass to the function.
Optional callback invoked when fileName is downloaded.
Optional callback invoked when fileName is downloaded.
Optional callback invoked when fileName is downloaded.
The name of the file to save on the client.
ondownload
Optional callback invoked when fileName is downloaded.
The name of the file to save on the client.
ondownload
Optional callback invoked when fileName is downloaded.
The file name the client will use to save the stream.
ondownload
Optional callback invoked when fileName is downloaded.
Optional method for the creation of an instance of T .
Callback function invoked when the browser tab is closed. Can be null.
A string containing a comma-separated list of window features in the form name=value — or for boolean features, just name. These features include options such as the window's default size and position, whether or not to open a minimal popup window, and so forth.
onclose
Callback function invoked when the browser popup window is closed. Can be null.
New value to assign to the session-static storage.
A callback method to invoke at the specified intervals.
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);
public class MyStatics {
// Thread-static singleton.
[ThreadStatic] private static SessionReference<MyStatics> _instance;
// Previously static fields (or properties).
public int Counter;
// Session singleton.
public MyStatics Instance
=> Application.GetInstance(ref _instance);
public static void DoSomething()
{
// was MyStatics.Counter++;
MyStatics.Instance.Counter++;
}
}
public class MyStatics {
private MyStatics() { };
// Thread-static singleton.
[ThreadStatic] private static SessionReference<MyStatics> _instance;
// Previously static fields (or properties).
public int Counter;
// Session singleton.
public MyStatics Instance
=> Application.GetInstance(ref _instance, () => new MyStatics());
public static void DoSomething()
{
// was MyStatics.Counter++;
MyStatics.Instance.Counter++;
}
}
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);
}
});
});
Public Class Control
Inherits IWisejControl
Implements IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfiles, IDropTarget, IUserData
Constructors
Control()
Initializes a new instance of the class.
Properties
AccessibleDescription
: Returns or sets the description that will be reported to accessibility client applications. It is assigned to the "alt" attribute of the browser element. (Default: null)
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. (Default: null)
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. (Default: Default)
AllowDrag
: Returns or sets whether the control can initiate a drag-drop operation. (Default: False)
AllowDrop
: Returns or sets whether the control can accept data that the user drags onto it. (Default: False)
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. (Default: Top, Left)
Anonymous
: Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents. (Default: False)
AppearanceKey
: Sets the appearance key for the theme engine. (Default: null)
BackColor
: Returns or sets the background color for the control.
BackgroundImage
: Returns or sets the background image displayed in the control. (Default: null)
BackgroundImageLayout
: Returns or sets the background image layout as defined in the enumeration. (Default: None)
BackgroundImageSource
: Returns or sets the background image displayed in the control. (Default: null)
BecomingActiveControl
: Returns a flag indicating that the control is becoming the active control.
BindingContext
: Returns or sets the for the control.
Bottom
: Returns the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
Bounds
: Returns or sets the size and location of the control including its non-client area, in pixels and relative to the parent control.
CanExecute
: Determines whether the control can execute a command.
CanFocus
: Returns whether the control can receive focus.
CanSelect
: Returns whether the control can be selected.
Capture
: Returns or sets whether the control has captured the mouse.
CausesValidation
: Returns or sets whether the control causes validation to be performed on controls that require to be validated when this control receives focus. (Default: True)
ClientEvents
: Returns a collection of client events and JavaScript listeners. You may attach multiple listeners to same event.
You can use this collection at design time or in code or through the listener methods:
ClientRectangle
: Returns the client rectangle of the control.
ClientSize
: Returns or sets the height and width of the client area.
ContainsFocus
: Indicates whether the control, or one of its child controls, has the input focus.
ContextMenu
: Returns or sets the shortcut menu associated with the control. (Default: null)
Controls
: Returns the collection of controls contained within the control.
Created
: Returns a value indicating whether the control has been created.
CssClass
: Returns or sets additional CSS class names to add to the widget.
Use this property to add or remove custom CSS classes that you may add to your application as standard css files or through the extender. You can assign multiple class names separated by a space and you can manage this property using the related methods:
CssStyle
: Returns or sets the custom CSS styles to add to the widget.
You can use any CSS style string.
Cursor
: Returns or sets the cursor that is displayed when the mouse pointer is over the control. (Default: null)
DataBindings
: Returns the data bindings for the control.
DefaultBackColor
: Returns the default background color of the control.
DefaultCursor
: Returns or sets the default cursor for the control.
DefaultFont
: Returns the default font of the control.
DefaultForeColor
: Returns the default background color of the control.
DefaultMargin
: Returns the default value for the property.
DefaultMaximumSize
: Returns the length and height, in pixels, that is specified as the default maximum size of a control.
DefaultMinimumSize
: Returns the length and height, in pixels, that is specified as the default minimum size of a control.
DefaultPadding
: Returns the internal spacing, in pixels, of the contents of a control.
DefaultSize
: Returns the default size of the control.
DisplayRectangle
: Returns the rectangle that represents the virtual display area of the control.
Disposing
: Returns whether the control is in the process of disposing itself and child controls.
Dock
: Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent. (Default: None)
Enabled
: Returns or sets whether the control can respond to user interaction.
EnableNativeContextMenu
: Enables or disables the browser's context menu.
Focusable
: Returns or sets whether the control can gain the focus. (Default: True)
Focused
: Returns a value indicating whether the control has input focus.
Font
: Gets or sets the font of the text displayed by the control.
FontHeight
: Returns or sets the height of the font of the control.
ForeColor
: Returns or sets the text color of the control.
Handle
: Returns the unique server-side id (handle) for this component.
HasChildren
: Returns whether the control contains any child control.
HasDataBindings
: Returns whether the control specifies data bindings.
HasResponsiveProfiles
: Check if the control defines any responsive profile without forcing the creation of the collection.
HasUserData
: Checks if the dynamic object was created and has any value.
Height
: Returns or sets the height of the control.
InitScript
: Returns or sets an initialization script to execute when the widget is created (or reloaded) in the browser.
Use this property to add custom initialization JavaScript that is always executed when the client widget is created. The context (this) of the script is the instance of the widget. You can use the entire qooxdoo and wisej.js api. See and .
You may also use the init script to attach events to the widget or to its internal children. Event handlers can also be attached using the collection and the client events methods:
InvokeRequired
: Returns true when this control belongs to a session different than the currently executing thread.
IsDisposed
: Returns whether the control has been disposed.
IsHandleCreated
: Returns if the control has a server-side component id (handle) associated with it.
IsMirrored
: Returns whether the control is mirrored.
LayoutEngine
: Returns the control's layout engine.
Left
: Returns or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
Location
: Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
Margin
: Returns or sets the space between controls.
MaximumSize
: Returns or sets the maximum size for the control.
MinimumSize
: Returns or sets the minimum size for the control.
ModifierKeys
: Returns a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
MouseButtons
: Returns a value indicating which of the mouse buttons is in a pressed state.
MousePosition
: Returns the position of the mouse cursor in screen coordinates.
Movable
: Returns or sets whether the control can be moved by dragging.
Name
: Gets or sets the name of the control.
Padding
: Returns or sets padding within the control.
Parent
: Returns or sets the parent container of the control.
PreferredSize
: Returns the preferred size in which the control can fit.
ResizableEdges
: Returns or sets the edges of the control that can be dragged to resize the control.
ResponsiveProfiles
: Returns the collection of responsive properties that have been set for this control.
Right
: Return the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
RightToLeft
: Returns or sets whether the control's elements are aligned right-to-left to support RTL languages.
When set to , the control inherits the value of this property from its parent. However, when the control is a top-level control (i.e. Window, Page, Desktop), and the value is set to , the right-to-left mode is automatically retrieved from the current language.
The behavior of this property is configurable in Default.json setting the "rightToLeft" property to "true", "false", or "auto". The default is "auto", causing the value to be retrieved from the current language.
Selectable
: Returns or sets whether the text in the control can be selected in the browser by the user by dragging the pointer. Since 2.5.22 (Default: False)
Not to be confused with , which corresponds to the property. When is set to true, the text of the control (i.e. a label or a button) can be highlighted in the browser and copied to the clipboard. It will also make the widget "focusable" but only in the browser.
ShowLoader
: Returns or sets whether the control is blocked by the ajax loader. (Default: False)
Size
: Returns or sets the height and width of the control.
States
: Returns or sets additional theme states to the client widget.
Use this property to manage additional custom states that you may want to add to a widget. The state will update the visualization of the widget using the styles and properties set in the current theme and loaded theme mixins. You can also force the usage of built-in states. However, this property will not return the current states of the widget as updated by the client browser. It only returns the states set by the application.
In addition to setting this property directly, you can also manage it using the related methods:
Since 3.5.5 Add a + after the name of the state to propagate the state to the child controls of the widget. See also .
TabIndex
: Returns or sets the tab order of the control within its container.
TabStop
: Returns or sets whether the user can give the focus to this control using the TAB key and the property is set to true. (Default: True)
Tag
: Returns or sets the object that contains data about the control. (Default: null)
Text
: Returns or sets the text associated with this control. (Default: "")
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 "<BR/>".
ToolTipText
: Returns or sets the tooltip text to show for this control. (Default: "")
When using property you can only set the ToolTip text and cannot change the default ToolTip icon set in the theme. To change the ToolTip icon you can either create a custom theme, or a theme mixin, or use the extender and the property added by the extender. You can change the default , , , , or enable HTML in by using a extender also without setting the property added by the extender.
Top
: Returns or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
TopLevelControl
: Returns the parent control that is not parented by another . Typically, this is the outermost that the control is contained in.
UserData
: Returns a dynamic object that can be used to store custom data in relation to this control.
UseWaitCursor
: Returns or sets whether to use the wait cursor for the current control and all child controls. (Default: False)
ValidationCancelled
: Returns a flag indicating that the validation has been canceled.
Visible
: Returns or sets whether the control and all its child controls are displayed.
WheelDelta
: Returns a value indicating the wheel delta from the last wheel event.
Width
: Returns or sets the width of the control.
Methods
AddClientEventListener(name, script)
Adds a new listener script to the event name to the client widget.
Parameter
Type
Description
Returns: . An integer id that you can use to remove the listener from the event using or to retrieve the listener script code using .
The script will execute in the browser when the event name occurs. You can attach multiple listeners to the same event.
AddCssClass(name)
Adds the CSS class name to the widget element. If the class already exists in the it's not added.
Parameter
Type
Description
Returns: . The new value of the property.
AddState(state)
Adds the specified theme state to the widget.
Parameter
Type
Description
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
AddState(state, forward)
Adds the specified theme state to the widget and optionally propagates it to the child components when forward is true. Since 3.5.5
Parameter
Type
Description
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
BeginInvoke(method)
Executes the specified delegate asynchronously, in the context of the session that owns the control.
Parameter
Type
Description
Returns: . An that represents the result of the operation.
BeginInvoke(method, args)
Executes the specified delegate asynchronously, in the context of the session that owns the control, with the specified list of arguments.
Parameter
Type
Description
Returns: . An that represents the result of the asynchronous call.
BringToFront()
Brings the control to the front of the z-order.
Returns: .
Call(function, args)
Runs the JavaScript function within the component's context in the browser.
Parameter
Type
Description
Returns: . this control
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
Returns: . this control
CallAsync(function, args)
Asynchronously runs the JavaScript function within the component's context in the browser and returns an awaitable containing the value returned by the remote call.
Parameter
Type
Description
Returns: . An awaitable that represents the asynchronous operation.
CenterToParent()
Centers the position of the control within the bounds of the parent.
Returns: . this control
CenterToParent(horizontal, vertical)
Centers the position of the control within the bounds of the parent either horizontally, vertically or both.
Parameter
Type
Description
Returns: . this control
Contains(control)
Indicates whether the specified control is a child of this control.
Parameter
Type
Description
Returns: . true if the specified control is a child of the control; otherwise, false.
CreateControl()
Creates and register this control and all its children.
Returns: .
CreateControlsInstance()
Creates a new instance of the control collection for the control.
Returns: . An instance of .
Dispose(disposing)
Disposes the control.
Parameter
Type
Description
DoDragDrop(data, allowedEffects)
Begins a drag-and-drop operation.
Parameter
Type
Description
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
DoDragDrop(data, allowedEffects, imageSource)
Begins a drag-and-drop operation.
Parameter
Type
Description
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
EndInvoke(asyncResult)
Retrieves the return value from the asynchronous operation represented by asyncResult .
Parameter
Type
Description
Returns: . The return value from the asynchronous operation.
Eval(javaScript)
Runs the javaScript code within the component's context in the browser.
Parameter
Type
Description
Returns: . this control
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
Returns: . this control
EvalAsync(javaScript)
Asynchronously runs the javaScript code within the component's context in the browser and returns an awaitable that contains the value returned by the remote call.
Parameter
Type
Description
Returns: . An awaitable that represents the asynchronous operation.
FindForm()
Retrieves the that contains the control.
Returns: .
FindPage()
Retrieves the that contains the control.
Returns: .
Focus()
Sets input focus to the control.
Returns: . true if the input focus request was successful; otherwise, false.
GetAutoSizeMode()
Returns how a control will behave when its AutoSize property is enabled.
Returns: . One of the values.
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.this control
GetChildAtPoint(pt)
Retrieves the child control that is located at the specified coordinates.
Parameter
Type
Description
Returns: . A that represents the control that is located at the specified point.
GetClientEventListener(id)
Returns the script associated to the listener identified by id .
Parameter
Type
Description
Returns: . JavaScript associated with the listener.
GetClientEventListener(name)
Returns the scripts for all the listeners attached to the event name .
Parameter
Type
Description
Returns: . String array containing the scripts for the listeners attached to the event.
GetContainerControl()
Returns the next up the control's chain of parents.
Returns: . The parent .
GetIconAlign(alignment)
Converts ContentAlignment to the equivalent iconAlign value.
Parameter
Type
Description
Returns: .
GetNextControl(control, forward)
Retrieves the next control forward or back in the tab order of child controls.
Parameter
Type
Description
Returns: . The next in the tab order.
GetStyle(flag)
Retrieves the value of the specified control style bit for the control.
Parameter
Type
Description
Returns: . true if the specified control style bit is set to true; otherwise, false.
GetTopLevel()
Determines if the control is a top-level control.
Returns: . true if the control is a top-level container: , , .
HasClientEventListener(name)
Checks whether the specified event name has any listener attached.
Parameter
Type
Description
Returns: . True if the event name has any listener attached.
HasCssClass(name)
Returns true if the property contains the specified class name .
Parameter
Type
Description
Returns: . True of the css class name is already included in .
HasState(state)
Checks whether the specified theme state is present in the property.
Parameter
Type
Description
Returns: . True if the widget already has the state .
To check only if a propagated state is present, use HasState("state+");
Hide()
Conceals the control from the user.
Returns: .
Invalidate()
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Invalidate(invalidateChildren)
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Parameter
Type
Description
Invoke(method)
Executes the specified delegate, in the context of the session that owns the control.
Parameter
Type
Description
Returns: . The return value from the delegate being invoked, or null if the delegate has no return value.
Invoke(method, args)
Executes the specified delegate, in the context of the session that owns the control, 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.
InvokeOnClick(control, e)
Raises the event for the specified control.
Parameter
Type
Description
IsInputChar(charCode)
Determines whether a character is an input character.
Parameter
Type
Description
Returns: . true if the character is an input character; otherwise, false.
IsInputKey(keyData)
Determines whether the specified key is a regular input key.
Parameter
Type
Description
Returns: . true if the specified key is a regular input key; otherwise, false.
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.
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.
OnAddReferences(items)
Adds references components to the list. Referenced components can be added individually or as a reference to a collection.
Parameter
Type
Description
OnAppear(e)
Fires the event.
Parameter
Type
Description
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.
OnAutoSizeChanged(e)
Raises the event.
Parameter
Type
Description
OnBackColorChanged(e)
Fires the event.
Parameter
Type
Description
OnBackgroundImageChanged(e)
Fires the event.
Parameter
Type
Description
OnBackgroundImageLayoutChanged(e)
Fires the event.
Parameter
Type
Description
OnBecomingActiveControlChanged(e)
Raises the event.
Parameter
Type
Description
OnBindingContextChanged(e)
Fires the event.
Parameter
Type
Description
OnCausesValidationChanged(e)
Raises the event.
Parameter
Type
Description
OnClick(e)
Fires the event.
Parameter
Type
Description
OnClientSizeChanged(e)
Fires the event.
Parameter
Type
Description
OnContextMenuChanged(e)
Fires the event.
Parameter
Type
Description
OnControlAdded(e)
Fires the event.
Parameter
Type
Description
OnControlCreated(e)
Fires the event.
Parameter
Type
Description
OnControlRemoved(e)
Fires the event.
Parameter
Type
Description
OnCursorChanged(e)
Fires the event.
Parameter
Type
Description
OnDisappear(e)
Fires the event.
Parameter
Type
Description
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.
OnDockChanged(e)
Fires the event.
Parameter
Type
Description
OnDoubleClick(e)
Fires the event.
Parameter
Type
Description
OnDragDrop(e)
Fires the event.
Parameter
Type
Description
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.
OnDragEnd(e)
Fires the event.
Parameter
Type
Description
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.
OnDragEnter(e)
Fires the event.
Parameter
Type
Description
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.
OnDragLeave(e)
Fires the event.
Parameter
Type
Description
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.
OnDragOver(e)
Fires the event.
Parameter
Type
Description
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.
OnDragStart(e)
Fires the event.
Parameter
Type
Description
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.
OnEnabledChanged(e)
Fires the event.
Parameter
Type
Description
OnEndMove(e)
Fires the event.
Parameter
Type
Description
OnEndResize(e)
Fires the event.
Parameter
Type
Description
OnEnter(e)
Fires the event.
Parameter
Type
Description
OnFontChanged(e)
Fires the event.
Parameter
Type
Description
OnForeColorChanged(e)
Fires the event.
Parameter
Type
Description
OnGotFocus(e)
Fires the event.
Parameter
Type
Description
OnHelpRequested(e)
Fires the event.
Parameter
Type
Description
OnImeModeChanged(e)
Fires the event.
Parameter
Type
Description
OnKeyDown(e)
Fires the event.
Parameter
Type
Description
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.
OnKeyPress(e)
Fires the event.
Parameter
Type
Description
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.
OnKeyUp(e)
Fires the event.
Parameter
Type
Description
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.
OnLayout(e)
Fires the event.
Parameter
Type
Description
OnLeave(e)
Fires the event.
Parameter
Type
Description
OnLocationChanged(e)
Fires the event.
Parameter
Type
Description
OnLongTap(e)
Fires the event.
Parameter
Type
Description
OnLostFocus(e)
Fires the event.
Parameter
Type
Description
OnMarginChanged(e)
Fires the event.
Parameter
Type
Description
OnMouseCaptureChanged(e)
Fires the event.
Parameter
Type
Description
OnMouseClick(e)
Fires the event.
Parameter
Type
Description
OnMouseDoubleClick(e)
Fires the event.
Parameter
Type
Description
OnMouseDown(e)
Fires the event.
Parameter
Type
Description
OnMouseEnter(e)
Fires the event.
Parameter
Type
Description
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.
OnMouseHover(e)
Fires the event.
Parameter
Type
Description
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.
OnMouseLeave(e)
Fires the event.
Parameter
Type
Description
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.
OnMouseMove(e)
Fires the event.
Parameter
Type
Description
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.
OnMouseUp(e)
Fires the event.
Parameter
Type
Description
OnMouseWheel(e)
Fires the event.
Parameter
Type
Description
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.
OnPaddingChanged(e)
Fires the event.
Parameter
Type
Description
OnParentBackColorChanged(e)
Fires the event when the property value of the control's container changes.
Parameter
Type
Description
OnParentBackgroundImageChanged(e)
Fires the event when the property value of the control's container changes.
Parameter
Type
Description
OnParentBindingContextChanged(e)
Fires the event when the property value of the control's container changes.
Parameter
Type
Description
OnParentChanged(e)
Fires the event.
Parameter
Type
Description
OnParentCursorChanged(e)
Fires the event when the property of the control's container changes.
Parameter
Type
Description
OnParentEnabledChanged(e)
Fires the event when the property value of the control's container changes.
Parameter
Type
Description
OnParentFontChanged(e)
Fires the event when the property value of the control's container changes.
Parameter
Type
Description
OnParentForeColorChanged(e)
Fires the event when the property value of the control's container changes.
Parameter
Type
Description
OnParentRightToLeftChanged(e)
Fires the event when the property value of the control's container changes.
Parameter
Type
Description
OnParentVisibleChanged(e)
Fires the event when the property value of the control's container changes.
Parameter
Type
Description
OnPinch(e)
Fires the event.
Parameter
Type
Description
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.
OnPreviewKeyDown(e)
Fires the event.
Parameter
Type
Description
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.
OnResize(e)
Fires the event.
Parameter
Type
Description
OnResponsiveProfileChanged(e)
Fires the event.
Parameter
Type
Description
OnRightToLeftChanged(e)
Fires the event.
Parameter
Type
Description
OnRotate(e)
Fires the event.
Parameter
Type
Description
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.
OnSizeChanged(e)
Fires the event.
Parameter
Type
Description
OnStartMove(e)
Fires the event.
Parameter
Type
Description
OnStartResize(e)
Fires the event.
Parameter
Type
Description
OnSwipe(e)
Fires the event.
Parameter
Type
Description
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.
OnTabIndexChanged(e)
Fires the event.
Parameter
Type
Description
OnTabStopChanged(e)
Fires the event.
Parameter
Type
Description
OnTap(e)
Fires the event.
Parameter
Type
Description
OnTextChanged(e)
Fires the event.
Parameter
Type
Description
OnTouchCancel(e)
Fires the event.
Parameter
Type
Description
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.
OnTouchEnd(e)
Fires the event.
Parameter
Type
Description
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.
OnTouchMove(e)
Fires the event.
Parameter
Type
Description
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.
OnTouchStart(e)
Fires the event.
Parameter
Type
Description
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.
OnTrack(e)
Fires the event.
Parameter
Type
Description
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.
OnValidated(e)
Fires the event.
Parameter
Type
Description
OnValidating(e)
Fires the event.
Parameter
Type
Description
OnVisibleChanged(e)
Fires the event.
Parameter
Type
Description
OnWebEvent(e)
Processes the event from the client.
Parameter
Type
Description
OnWebPaint(g)
Allows the control to paint itself.
Parameter
Type
Description
OnWebRender(config)
Renders the client component.
Parameter
Type
Description
OnWebUpdate(state)
Updates the client component using the state information.
Parameter
Type
Description
OnWidgetEvent(e)
Fires the event.
Parameter
Type
Description
PerformLayout()
Forces the control to apply layout logic to all its child controls.
PerformLayout(affectedControl, affectedProperty)
Forces the control to apply layout logic to all its child controls.
Parameter
Type
Description
PointToClient(point)
Computes the location of the specified screen point into client coordinates.
Parameter
Type
Description
Returns: . A that represents the converted , point , in client coordinates.
PointToScreen(point)
Computes the location of the specified client point into screen coordinates.
Parameter
Type
Description
Returns: . A that represents the converted , point , in screen coordinates.
ProcessCmdKey(keyData)
Processes a command key.
Parameter
Type
Description
Returns: . true if the character was processed by the control; otherwise, false.
ProcessDialogChar(charCode)
Processes a dialog character.
Parameter
Type
Description
Returns: . true if the character was processed by the control; otherwise, false.
ProcessDialogKey(keyData)
Processes a dialog key.
Parameter
Type
Description
Returns: . true if the key was processed by the control; otherwise, false.
ProcessKeyPreview(e)
Processes a key event before the KeyDown and KeyUp events.
Parameter
Type
Description
Returns: . true if the key event was processed by the control; otherwise, false.
RectangleToClient(rect)
Computes the size and location of the specified screen rectangle in client coordinates.
Parameter
Type
Description
Returns: . A that represents the converted , rect , in client coordinates.
RectangleToScreen(rect)
Computes the size and location of the specified client rectangle in screen coordinates.
Parameter
Type
Description
Returns: . A that represents the converted , rect , in screen coordinates.
Refresh()
Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control, including the non-client areas such as the caption of forms or panels.
Refresh(refreshChildren)
Forces the control to update the corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.
Parameter
Type
Description
RemoveClientEventListener(id)
Detaches and removes the listener identified by id .
Parameter
Type
Description
Returns: . True if the id specified a valid lister and it was removed; otherwise false if id is invalid.
RemoveClientEventListener(name)
Removes all the listeners attached to the event name .
Parameter
Type
Description
Returns: . True if the event name has any listener that was removed.
RemoveCssClass(name)
Removes the specified css class name from the control's property.
Parameter
Type
Description
Returns: . The new value of the property.
RemoveState(state)
Removes the specified theme state from the widget.
Parameter
Type
Description
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
RemoveState(state, forward)
Removes the specified theme state from the widget. Since 3.5.5
Parameter
Type
Description
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
ResetBindings()
Removes all the data bindings from the control.
Returns: .
ResolveColor(color)
Resolves the named or themed color to an actual usable color value.
Parameter
Type
Description
Returns: .
ResumeLayout()
Resumes layout logic.
ResumeLayout(performLayout)
Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.
Parameter
Type
Description
ScrollControlIntoView(alignX, alignY)
Scrolls the control into view in the container using the specified alignX and alignY preferences.
Parameter
Type
Description
Returns: . this control
ScrollControlIntoView(alignX, alignY, behavior)
Scrolls the control into view in the container using the specified alignX and alignY preferences. Since 4.0.3
Parameter
Type
Description
Returns: . this control
ScrollControlIntoView()
Scrolls the child control into view.
Returns: . this control
ScrollControlIntoView(behavior)
Scrolls the child control into view. Since 4.0.3
Parameter
Type
Description
Returns: . this control
Select()
Activates, including setting the focus, a control.
Returns: .
Select(directed, forward)
Activates a child control. Optionally specifies the direction in the tab order to select the control from.
Activates the next control in the list according to the specified selection rules.
Parameter
Type
Description
Returns: . true if a control was activated; otherwise, false.
SendToBack()
Sends the control to the back of the z-order.
Returns: .
SetAutoSizeMode(mode)
Sets a value indicating how a control will behave when its AutoSize property is enabled.
Parameter
Type
Description
SetBounds(x, y, width, height)
Sets the bounds of the control to the specified location and size.
Parameter
Type
Description
Returns: .
SetBounds(x, y, width, height, specified)
Sets the specified bounds of the control to the specified location and size.
Parameter
Type
Description
Returns: . this control
SetClientSizeCore(width, height)
Sets the client size of the control.
Parameter
Type
Description
SetTopLevel(value)
Sets the control as the top-level control.
Parameter
Type
Description
Returns: .
Throws:
The property is not null and value is true.
SetVisibleCore(value)
Sets the control to the specified visible state.
Parameter
Type
Description
Show()
Displays the control to the user.
Returns: .
SizeFromClientSize(clientSize)
Converts the client size into the window size.
Parameter
Type
Description
Returns: .
SuspendLayout()
Suspends the layout logic for the control.
Update()
Causes the control to update the corresponding client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Returns: . true if the active control is validated.
ValidateChildren()
Validates all selectable child controls in the container, including descendants. This is equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See for details of exactly which child controls will be validated.
Returns: . true if all of the children validated successfully; otherwise, false. If called from the or event handlers, this method will always return false.
ValidateChildren(flags)
Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .
Parameter
Type
Description
Returns: . true if all of the children validated successfully; otherwise, false. If called from the or event handlers, this method will always return false.
Events
Appear
Fired after the control has been fully rendered on the client.
This is a "lazy" event. It fires only when there is an handler attached to it, otherwise the companion On{Name} protected method is not invoked. It's enough to attach to either one of or to enable both events.
AutoSizeChanged
Fired when the property value changes.
BackColorChanged
Fired when the value of the property changes.
BackgroundImageChanged
Fired when the value of the property changes.
BackgroundImageLayoutChanged
Fired when the property changes.
BecomingActiveControlChanged
Fired when the value of the property changes.
BindingContextChanged
Occurs when the value of the property changes.
CausesValidationChanged
Fired when the value of the property changes.
Click
Fired when the control is clicked.
ClientSizeChanged
Fired when the property value changes.
ContextMenuChanged
Fired when the value of the property changes.
ControlAdded
Fired when a new control is added to the .
ControlCreated
Fired when a control is made visible the first time, fully created and sent to the client.
ControlRemoved
Fired when a control is removed from the .
CursorChanged
Fired when the value of the property changes.
Disappear
Fired after the control is no longer visible on the client.
This is a "lazy" event. It fires only when there is an handler attached to it, otherwise the companion On{Name} protected method is not invoked. It's enough to attach to either one of or to enable both events.
Disposed
Fired when the component is disposed.
DockChanged
Fired when the value of the property changes.
DoubleClick
Fired when the control is double-clicked.
DragDrop
Fired when a drag-and-drop operation is completed.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
DragEnd
Fired when a drag-drop operation is terminated either by a drop or canceled.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
DragEnter
Fired when an object is dragged into the control's bounds.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
DragLeave
Fired when an object is dragged out of the control's bounds.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
DragOver
Fired when an object is dragged over the control's bounds.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
DragStart
Fired when a drag-drop operation is started by the user.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EnabledChanged
Fired when the property value has changed.
EndMove
Fired when a control is and the user ends the move operation.
This event fires only when is true and the user moves the widget on the client. It doesn't fire when the property changes.
EndResize
Fired when a control has and the user ends the resize operation.
This event fires only when the has a value different than and the user resizes the widget on the client. It doesn't fire when the of the control changes.
Enter
Fired when the control gains the input focus.
FontChanged
Fired when the property value changes.
ForeColorChanged
Fired when the property value changes.
GotFocus
Fired when the control gains the focus.
Staring from version 3.5.18, the event parameter e is of type which carries additional information about the control that lost the focus and the one that received the focus. To use the new data check the type and cast to .
HelpRequested
Fired when the user requests help for a control by pressing F1.
ImeModeChanged
Fired when the ImeMode property has changed.
KeyDown
Fired when a key is pressed while the control has focus.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
KeyPress
Fired when a key is pressed while the control has focus.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
KeyUp
Fired when a key is released while the control has focus.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
Layout
Fired when a control should reposition its child controls.
Leave
Fired when the control loses the input focus.
LocationChanged
Fired when the property value has changed.
LongTap
Fired when a pointer holds on the screen.
LostFocus
Fired when the control loses focus.
Staring from version 3.5.18, the event parameter e is of type which carries additional information about the control that lost the focus and the one that received the focus. To use the new data check the type and cast to .
MarginChanged
Fired when the control's margin changes.
MouseCaptureChanged
Fired when the control loses mouse capture.
MouseClick
Fired when the control is clicked by the mouse.
MouseDoubleClick
Fired when the control is double clicked by the mouse.
MouseDown
Fired when the mouse pointer is over the control and a mouse button is pressed.
MouseEnter
Fired when the mouse pointer enters the control.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
MouseHover
Fired when the mouse pointer rests on the control.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
MouseLeave
Fired when the mouse pointer leaves the control.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
MouseMove
Fired when the mouse pointer is moved over the control.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
MouseUp
Fired when the mouse pointer is over the control and a mouse button is released.
MouseWheel
Fired when the mouse wheel moves while the control has focus.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
PaddingChanged
Fired when the control's padding changes.
Paint
Fired when a UserPaint control needs to redraw itself.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
ParentChanged
Fired when the property value changes.
Pinch
Fired when two finger moved towards or away from each other. It contains the scaling factor of the pinch.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
PreviewKeyDown
Fired before the event when a key is pressed while focus is on this control.
QueryContinueDrag
Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
Resize
Fired when the control is resized.
ResponsiveProfileChanged
Fired when the active responsive profile is changed.
RightToLeftChanged
Fired when the property value changes.
Rotate
Fired when two finger moved around a single point. It contains the angle of the rotation.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
SizeChanged
Fired when the property value changes.
StartMove
Fired when a control is and the user begins the move operation.
This event fires only when is true and the user begins moving the widget on the client.
StartResize
Fired when a control has and the user begins the resize operation.
This event fires only when the has a value different than and the user begins resizing the widget on the client.
StyleChanged
Fired when the control style changed.
Swipe
Fired when a pointer swipes over the screen.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
TabIndexChanged
Fired when the property value has changed.
TabStopChanged
Fired when the value of the property changes.
Tap
Fired when a pointer taps on the screen.
TextChanged
Fired when the property value changes.
TouchCancel
Fired when a touch point has been disrupted in an implementation-specific manner (for example, too many touch points are created).
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
TouchEnd
Fired when a touch point is removed from the touch surface.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
TouchMove
Fired when a touch point is moved along the touch surface.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
TouchStart
Fired when a touch point is placed on the touch surface.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
Track
Fired when a pointer grabs an item and moves the pointer on it.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
Validated
Fired when the control is finished validating.
Validating
Fired when the control is validating.
VisibleChanged
Fired when the property value changes.
WidgetEvent
Fired when the control receives a custom event from the client.
JavaScript code can fire any event back to a control, including custom data, using:
On the server side, the event name and event data are available in the WidgetEvent handler:
The name or URL for an image to use as the drag cursor.
The name or URL for an image to use as the drag cursor.
imageSize
The size of the drag image specified in
imageSource.
An to use as the drag cursor.
An to use as the drag cursor.
imageSize
The size of the drag image specified in
image.
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 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 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 , .
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 , .
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 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 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 = .
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 = .
Determines whether scrolling is instant or animates smoothly.
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.
The new property value of the control.
height
The new property value of the control.
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 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 controls 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 a drawing surface for immediate-mode 2D rendering, similar to the HTML5 Canvas API.
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.
Represents a text box control that allows the user to enter a typed value.
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 .
All wisej controls derived from the class must implement this interface.
A Point that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.
A Point that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.
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.
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.
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.
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.
Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.
All wisej components implement this interface.
// 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" };
