Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This book covers the full API for the Wisej.Framework assembly only. For an in-depth guide of Wisej features, please refer to the Concepts book. For the extensions API and concepts, please refer to the Extensions book.
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.
We assume that you have a good working knowledge of the following tools and technologies:
C# or VB.NET
.NET in general
Visual Studio
JavaScript
Wisej.Core.Client
Int32: Returns the total number of currently open forms.
Form: Returns the form at the specified index.
Form: Returns the first form with the specified name, the search is case insensitive.
Returns an enumerator that iterates through the open forms.
Returns: IEnumerator.
Public Class FormCollection
Inherits ICollection
Implements IEnumerablepublic class FormCollection : ICollection, IEnumerablesender
The source of the event. Always null.
args
The event data.
Fired when the system needs to load a Wisej configuration file.
Public Delegate Sub LoadConfigurationEventHandler(ByVal sender As [Object], ByVal args As LoadConfigurationEventArgs)public delegate void LoadConfigurationEventHandler(Object sender, LoadConfigurationEventArgs args)String: The full file path to the configuration file to load.
Boolean: When set to true, suppresses the caching of the custom Configuration object return by the custom handler for the LoadConfiguration event.
Represents a method that handles the event.
Public Class LoadConfigurationEventArgs
Inherits EventArgspublic class LoadConfigurationEventArgs : EventArgsClientBrowser[]: List of browser tabs (for the same browser) that are using the application at the client computer.
String: Unique client ID.
String: IP Address of the client computer.
Int32: Returns the number of sessions used by this client computer.
Public Class Clientpublic class Clientsender
The source of the event.
e
A that contains the event data.
Fired when the active responsive profile is changed.
Fired when the active responsive profile is changed.
Public Delegate Sub ResponsiveProfileChangedEventHandler(ByVal sender As [Object], ByVal e As ResponsiveProfileChangedEventArgs)public delegate void ResponsiveProfileChangedEventHandler(Object sender, ResponsiveProfileChangedEventArgs e)String[]: List of javascript files associated with the platform.
String: The name of this platform configuration.
PlatformProvider: The platform provider.
String[]: List of style sheets associated with the platform.
Version: Returns the file version of the
Public Class ClientPlatformpublic class ClientPlatformInitializes a new instance of the LicenseErrorEventArgs class.
error
License error.
String: Indicates the type of license error that has occurred.
Public Class LicenseErrorEventArgs
Inherits EventArgspublic class LicenseErrorEventArgs : EventArgsInstance method, or property, or event.
Static method or property or event.
Protected method or property or event.
Deprecated method or property or event.
Wisej.Core.ClientProfile
Namespace: Wisej.Core
Assembly: Wisej.Framework (3.0.0.0)
Definition of the client device.
public class ClientProfilePublic Class ClientProfile: Device type.
: Device landscape mode.
: Maximum screen width.
: Maximum browser width.
: Minimum screen width.
: Minimum browser width.
: Name of the profile.
: User agent string.
Wisej.Core.ClientCollection
Namespace: Wisej.Core
Assembly: Wisej.Framework (3.0.0.0)
List of Clients using the application.
public class ClientCollection : IList<Client>, ICollection<Client>, IEnumerable<Client>, IEnumerablePublic Class ClientCollection
Inherits IList(Of Client)
Implements ICollection(Of Client), IEnumerable(Of Client), IEnumerable: Returns the total number of items in the collection.
: Returns the at the specified index .
Wisej.Web.Application PageCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Holds the collection of all top-level application pages.
public class PageCollection : ICollection, IEnumerablePublic Class PageCollection
Inherits ICollection
Implements IEnumerable: Returns the total number of currently open pages.
: Returns the page at the specified index.
: Returns the first page with the specified name, the search is case insensitive.
Returns an enumerator that iterates through the open pages.
Returns: .
Wisej.Web.ControlEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the ControlAdded and ControlRemoved events.
public class ControlEventArgs : EventArgsPublic Class ControlEventArgs
Inherits EventArgsInitializes a new instance of the class for the specified control.
: Returns the control object used by this event.
Wisej.Web.HashChangedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the HashChanged event.
public delegate void HashChangedEventHandler(Object sender, HashChangedEventArgs e)Public Delegate Sub HashChangedEventHandler(ByVal sender As [Object], ByVal e As HashChangedEventArgs)Wisej.Web.ControlEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the ControlAdded and ControlRemoved events of the Control class.
public delegate void ControlEventHandler(Object sender, ControlEventArgs e)Public Delegate Sub ControlEventHandler(ByVal sender As [Object], ByVal e As ControlEventArgs)Wisej.Web.HashChangedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the HashChanged event.
public class HashChangedEventArgs : EventArgsPublic Class HashChangedEventArgs
Inherits EventArgsInitializes a new instance of the class.
: The hash string from the client.
sender
The source of the event.
e
A HashChangedEventArgs that contains the event data.
Fired when the hash part of the URL changes on the client side.
sender
The source of the event.
e
A ControlEventArgs that contains the event data.
Fired when a new control is added to the ControlCollection.
Fired when a control is removed from the ControlCollection.
Fired when a multiple-document interface (MDI) child form is added to the mdi parent.
Fired when a multiple-document interface (MDI) child form is removed from the mdi parent.
Default
Returns the default ClientProfile singleton.
control
The Control to store in this event.
Represents the method that will handle the ControlAdded and ControlRemoved events of the Control class.
value
Initial hash value.
Represents the method that will handle the HashChanged event.
Represents the method that will handle the LicenseError event.
Initializes a new instance of the ResponsiveProfileChangedEventArgs class.
oldValue
Previous .
newValue
New active .
ClientProfile: The new active profile.
ClientProfile: The previously active profile.
Represents the method that will handle the Application.ResponsiveProfileChanged event.
Public Class ResponsiveProfileChangedEventArgs
Inherits EventArgspublic class ResponsiveProfileChangedEventArgs : EventArgsQXDesktop
Desktop platform by qooxdoo.
The platform provider.
Public Enum PlatformProvider As [Enum]public enum PlatformProvider : Enumsender
The source of the event.
e
A that contains the event data.
Fired when a license error occurs.
Public Delegate Sub LicenseErrorEventHandler(ByVal sender As [Object], ByVal e As HashChangedEventArgs)public delegate void LicenseErrorEventHandler(Object sender, HashChangedEventArgs e)Wisej.Web.PaintEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the Paint event of a Control.
public delegate void PaintEventHandler(Object sender, PaintEventArgs e)Public Delegate Sub PaintEventHandler(ByVal sender As [Object], ByVal e As PaintEventArgs)Wisej.Web.PinchEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for Pinch event.
public class PinchEventArgs : EventArgsPublic Class PinchEventArgs
Inherits EventArgs: Returns the calculated scale factor.
Wisej.Web.PreviewKeyDownEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the PreviewKeyDown event.
public delegate void PreviewKeyDownEventHandler(Object sender, PreviewKeyDownEventArgs e)Public Delegate Sub PreviewKeyDownEventHandler(ByVal sender As [Object], ByVal e As PreviewKeyDownEventArgs)Wisej.Web.RotateEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for Rotate event.
public class RotateEventArgs : EventArgsPublic Class RotateEventArgs
Inherits EventArgs: Returns a number with the current calculated angle between the primary and secondary active pointers.
Wisej.Web.RotateEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the Rotate event.
public delegate void RotateEventHandler(Object sender, RotateEventArgs e)Public Delegate Sub RotateEventHandler(ByVal sender As [Object], ByVal e As RotateEventArgs)Wisej.Web.SwipeEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the Swipe event.
public delegate void SwipeEventHandler(Object sender, SwipeEventArgs e)Public Delegate Sub SwipeEventHandler(ByVal sender As [Object], ByVal e As SwipeEventArgs)Wisej.Web.WidgetEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that handles the WidgetEvent event.
public delegate void WidgetEventHandler(Object sender, WidgetEventArgs e)Public Delegate Sub WidgetEventHandler(ByVal sender As [Object], ByVal e As WidgetEventArgs)Wisej.Web.Screen
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the display on the client device.
public class ScreenPublic Class Screen: Returns the size of the display of the client device, regardless of the orientation.
: Returns the device name associated with a display.
: 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.
Wisej.Web.ServiceScope
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
EXPERIMENTAL: Specifies the scope of services added using AddService.
public enum ServiceScope : EnumPublic Enum ServiceScope As [Enum]Wisej.Web.FileDialogRootCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represent a collection of the IFileSystemProvider root file systems shown by the FileDialog implementation.
public class FileDialogRootCollection : List<>Public Class FileDialogRootCollection
Inherits List(Of )Maps the virtual path to the corresponding physical path on the specific implementation.
Returns: . The physical path for the implementation.
sender
The source of the event.
e
A PaintEventArgs that contains the event data.
Fired when a UserPaint control needs to redraw itself.
sender
The source of the event.
e
A PreviewKeyDownEventArgs that contains the event data.
Fired before the KeyDown event when a key is pressed while focus is on this control.
sender
The source of the event.
e
A RotateEventArgs that contains the event data.
Fired when two finger moved around a single point. It contains the angle of the rotation.
X
X-axis.
Y
Y-axis
Returns whether the performed swipe was on the x or y axis.
Returns the Axis of the track event.
sender
The source of the event.
e
A SwipeEventArgs that contains the event data.
Fired when a pointer swipes over the screen.
sender
The source of the event.
e
A WidgetEventArgs that contains the event data.
Fired when the control receives a custom event from the client.
Global
A single static instance of the service is available to all sessions.
Session
The registered instance is available only to the current sessions. A new session should create and register a new instance.
Transient
A new instance of the service is created every time it's needed and automatically disposed at the end of the request.
EXPERIMENTAL: Adds a scoped service to the service container.
Represents the method that will handle the Pinch event.
Represents the method that will handle the Rotate event.
filePath
Virtual path to map to the corresponding physical path.
sender
The source of the event.
e
A that contains the event data.
Fired when a drag-and-drop operation is completed.
Fired when an object is dragged into the control's bounds.
Fired when an object is dragged over the control's bounds.
Public Delegate Sub DragEventHandler(ByVal sender As [Object], ByVal e As DragEventArgs)public delegate void DragEventHandler(Object sender, DragEventArgs e)String: 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.
String: Returns or sets the JavaScript handler for the event.
Public Class ClientEventpublic class ClientEventInitializes a new instance of the KeyPressEventArgs class.
keyChar
The ASCII character corresponding to the key the user pressed.
Char: Returns or sets the character corresponding to the key pressed.
Represents the method that will handle the event of a .
Public Class KeyPressEventArgs
Inherits EventArgspublic class KeyPressEventArgs : EventArgssender
The source of the event.
e
A that contains the event data.
Fired when a control should reposition its child controls.
Public Delegate Sub LayoutEventHandler(ByVal sender As [Object], ByVal e As LayoutEventArgs)public delegate void LayoutEventHandler(Object sender, LayoutEventArgs e)sender
The source of an event.
e
A that contains the event data.
Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.
Public Delegate Sub QueryContinueDragEventHandler(ByVal sender As [Object], ByVal e As QueryContinueDragEventArgs)public delegate void QueryContinueDragEventHandler(Object sender, QueryContinueDragEventArgs e)Initializes a new instance of the ResponsiveProfileChangedEventArgs class.
oldValue
Previous .
newValue
New active .
ClientProfile: The new active profile.
ClientProfile: The previously active profile.
Represents the method that will handle the Application.ResponsiveProfileChanged event.
Public Class ResponsiveProfileChangedEventArgs
Inherits EventArgspublic class ResponsiveProfileChangedEventArgs : EventArgsSwipeAxis: Returns whether the performed swipe was on the x or y axis.
SwipeDirection: Returns the direction of the performed swipe in reference to the axis: X = Up / Down Y = Left / Right
Int32: Returns the distance of the performed swipe.
Int32: Returns the duration the performed swipe took.
Int64: Returns the start time of the performed swipe.
Double: Returns the velocity of the performed swipe.
Represents the method that will handle the event.
Public Class SwipeEventArgs
Inherits EventArgspublic class SwipeEventArgs : EventArgsDown
Direction down.
Left
Direction left.
Right
Direction right.
Up
Direction up.
Returns the direction of the performed swipe in reference to the axis: X = Up / Down Y = Left / Right
Public Enum SwipeDirection As [Enum]public enum SwipeDirection : EnumSwipeAxis: Returns the Axis of the track event.
Point: Returns the X, Y delta for the track event.
Int32: Returns the X delta of the track event.
Int32: Returns Y delta of the track event.
Represents the method that will handle the event.
Public Class TrackEventArgs
Inherits EventArgspublic class TrackEventArgs : EventArgssender
The source of the event.
e
A that contains the event data.
Fired when a pointer grabs an item and moves the pointer on it.
Public Delegate Sub TrackEventHandler(ByVal sender As [Object], ByVal e As TrackEventArgs)public delegate void TrackEventHandler(Object sender, TrackEventArgs e)Initializes a new instance of the WidgetEventArgs class.
type
The type (name) of event.
data
The data object received with the event.
Object: Returns the data object that was sent by the widget with the event.
String: Returns the type (name) of the event fired by the widget.
Represents the method that handles the event.
Public Class WidgetEventArgs
Inherits EventArgspublic class WidgetEventArgs : EventArgssender
The source of the event.
e
A that contains the event data.
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 delegate void FileDialogLoadPathEventHandler(Object sender, FileDialogLoadPathEventArgs e)sender
The source of the event.
e
A that contains the event data.
Fired when two finger moved towards or away from each other. It contains the scaling factor of the pinch.
Public Delegate Sub PinchEventHandler(ByVal sender As [Object], ByVal e As PinchEventArgs)public delegate void PinchEventHandler(Object sender, PinchEventArgs e)Wisej.Web.HelpEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the HelpRequested event of a Control.
public delegate void HelpEventHandler(Object sender, HelpEventArgs hlpevent)Public Delegate Sub HelpEventHandler(ByVal sender As [Object], ByVal hlpevent As HelpEventArgs)Wisej.Web.KeyEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the KeyUp or KeyDown event of a Control.
public delegate void KeyEventHandler(Object sender, KeyEventArgs e)Public Delegate Sub KeyEventHandler(ByVal sender As [Object], ByVal e As KeyEventArgs)Wisej.Web.KeyPressEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the KeyPress event of a Control.
public delegate void KeyPressEventHandler(Object sender, KeyPressEventArgs e)Public Delegate Sub KeyPressEventHandler(ByVal sender As [Object], ByVal e As KeyPressEventArgs)Wisej.Web.PaintEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the Paint event.
public class PaintEventArgs : EventArgsPublic Class PaintEventArgs
Inherits EventArgsInitializes a new instance of the class with the specified graphics and clipping rectangle.
: Returns the rectangle in which to paint.
: Returns the graphics used to paint.
Wisej.Web.QueryContinueDragEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the QueryContinueDrag event.
public class QueryContinueDragEventArgs : EventArgsPublic Class QueryContinueDragEventArgs
Inherits EventArgsInitializes a new instance of the class.
: Returns or sets the status of a drag-and-drop operation.
: Returns if the user pressed the ESC key.
: Returns the current state of the SHIFT, CTRL, and ALT keys.
Wisej.Web.TouchEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for Swipe event.
public class TouchEventArgs : EventArgsPublic Class TouchEventArgs
Inherits EventArgs: Returns the unique identifiers for the touch items.
: Returns whether more than one touch is associated with the event target element.
: Returns the location of the touch items in screen coordinates.
: Returns the delta of the rotation since the start of the event, in degrees.
: Returns the distance between two fingers since the start of the event.
Wisej.Web.TouchEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the TouchStart, TouchEnd, TouchMove, TouchCancel events.
public delegate void TouchEventHandler(Object sender, TouchEventArgs e)Public Delegate Sub TouchEventHandler(ByVal sender As [Object], ByVal e As TouchEventArgs)Wisej.Web.MenuButtonItemClickedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the ItemClicked event.
public class MenuButtonItemClickedEventArgs : EventArgsPublic Class MenuButtonItemClickedEventArgs
Inherits EventArgsInitializes a new instance of the class.
: Returns the clicked menu item.
Wisej.Web.AccordionAction
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Defines values representing Accordion events.
public enum AccordionAction : EnumPublic Enum AccordionAction As [Enum]Wisej.Web.HelpEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the HelpRequested event.
public class HelpEventArgs : EventArgsPublic Class HelpEventArgs
Inherits EventArgsInitializes a new instance of the class.
: Returns or sets a value indicating whether the help event was handled.
: Returns the that had the focus when the user pressed F1.
Wisej.Web.ColorDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors.
Initializes a new instance of .
Initializes a new instance of the extender with a specified container.
: Returns or sets the color selected by the user.
: Returns or sets the set of custom colors shown in the dialog box.
Resets all properties to their default values.
Wisej.Web.FileDialogLoadPathEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the LoadPath event.
Allows an application to filter the files and folders loaded by the and components and to set the icon, creation date and modified date. To skip a file or folder, set e.Cancel = true. To set a file's icon, or date, set the , or properties.
Wisej.Web.FileDialogUI
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
sender
The source of the event.
hlpevent
A HelpEventArgs object that contains the event data.
Fired when the user requests help for a control by pressing F1.
sender
The source of the event.
e
A KeyEventArgs that contains the event data.
Fired when a key is pressed while the control has focus.
Fired when a key is released while the control has focus.
sender
The source of the event.
e
A KeyPressEventArgs that contains the event data.
Fired when a key is pressed while the control has focus.
sender
The source of the event.
e
A TouchEventArgs that contains the event data.
Fired when a touch point is placed on the touch surface.
Fired when a touch point is removed from the touch surface.
Fired when a touch point has been disrupted in an implementation-specific manner (for example, too many touch points are created).
Fired when a touch point is moved along the touch surface.
Deselected
Represents the Deselected event.
Deselecting
Represents the Deselecting event.
Selected
Represents the Selected event.
Selecting
Represents the Selecting event.
Returns a value indicating which event is occurring.
Returns a value indicating which event is occurring.
graphics
The Graphics used to paint the item.
clipRect
The Rectangle that represents the rectangle in which to paint.
args
The arguments received from the client.
Represents the method that will handle the QueryContinueDrag event of a Control.
Represents the method that will handle the TouchStart, TouchEnd, TouchMove, TouchCancel events.
item
The MenuItem that was clicked.
Represents the method that will handle the ItemClicked event of a Button control.
target
The Control that had the focus when the user pressed F1.
Represents the method that will handle the HelpRequested event of a Control.
container
An IContainer that represents the container of the ColorDialog component.
Public Class ColorDialog
Inherits CommonDialogpublic class ColorDialog : CommonDialogInitializes a new instance of the LayoutEventArgs class with the specified component and property affected.
affectedComponent
The affected by the layout change.
affectedProperty
The property affected by the layout change.
Initializes a new instance of the LayoutEventArgs class with the specified control and property affected.
affectedControl
The affected by the layout change.
affectedProperty
The property affected by the layout change.
IComponent: Returns the IComponent affected by the layout change.
Control: Returns the child control affected by the change.
String: Returns the property affected by the change.
Represents the method that will handle the event of a .
Public Class LayoutEventArgs
Inherits EventArgspublic class LayoutEventArgs : EventArgssender
The source of the event.
e
A that contains the event data.
Fired when the user clicks the control with the mouse.
Fired when the control is clicked by the mouse.
Fired when the control is double clicked by the mouse.
Fired when the mouse pointer is over the control and a mouse button is pressed.
Fired when the mouse pointer is moved over the control.
Public Delegate Sub MouseEventHandler(ByVal sender As [Object], ByVal e As MouseEventArgs)public delegate void MouseEventHandler(Object sender, MouseEventArgs e)Constructs a new instance of FileDialogLoadPathEventArgs.
path
Path of the file or directory.
isDirectory
Indicates that the path is for a directory.
DateTime: Sets the creation DateTime of the file.
Int64: Sets the file size in bytes.
String: Sets the name or path of the icon to display next to the file.
DateTime: Sets the last modified DateTime of the file.
String: Returns the full path of the file or folder being loaded.
Represents the method that will handle the and events.
Public Class FileDialogLoadPathEventArgs
Inherits CancelEventArgspublic class FileDialogLoadPathEventArgs : CancelEventArgsUI implementation for the FileDialog class.
public class FileDialogUI : FormPublic Class FileDialogUI
Inherits FormfileDialog
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
All wisej top-level windows implement this interface.
sender
The source of the event.
e
A that contains the event data.
Fired when the user clicks one of the drop down menu items.
Public Delegate Sub MenuButtonItemClickedEventHandler(ByVal sender As [Object], ByVal e As MenuButtonItemClickedEventArgs)public delegate void MenuButtonItemClickedEventHandler(Object sender, MenuButtonItemClickedEventArgs e)sender
The source of the event.
e
A that contains the event data.
Fired when the active responsive profile is changed.
Fired when the active responsive profile is changed.
Public Delegate Sub ResponsiveProfileChangedEventHandler(ByVal sender As [Object], ByVal e As ResponsiveProfileChangedEventArgs)public delegate void ResponsiveProfileChangedEventHandler(Object sender, ResponsiveProfileChangedEventArgs e)sender
The source of the event.
e
A that contains the event data.
Occurs before a panel is selected, enabling a handler to cancel the panel change.
Occurs before a panel is deselected, enabling a handler to cancel the panel change.
Public Delegate Sub AccordionCancelEventHandler(ByVal sender As [Object], ByVal e As AccordionCancelEventArgs)public delegate void AccordionCancelEventHandler(Object sender, AccordionCancelEventArgs e)Wisej.Core.ClientBrowser
Namespace: Wisej.Core
Assembly: Wisej.Framework (3.0.0.0)
Properties of the client browser currently interacting with the application.
public class ClientBrowserPublic Class ClientBrowser: Returns the locale declared in the application configuration file or detected from the client browser.
: Device type. Can be one of "Mobile", "Tablet" or "Desktop".
: Returns the set of features supported/not-supported by the browser. Currently we detect: geolocation, webSocket, fullScreen, speechSynthesis, speechRecognition, notification, fullScreen, browserStorage.
: IP Address of the client computer.
: Returns true if the browser is using dark mode. [Since 3.0.10]
: Returns true if the browser is in full screen mode.
: Returns true if the connection is secure.
: Client language.
: Client OS. Can be one of "iOS", "Android", "WebOS", "BlackBerry", "MacOS", "Linux", "Windows", "Unix", "Other".
: Returns the ratio of the resolution in physical pixels to the resolution in CSS pixels for the current display device.
:
: Screen size.
: Returns the session ID associated with this .
: Browser size. This is the window size, which can be different from the device (or screen) size.
: Identifies the browser tab associated with with this instance.
: Returns the time difference between UTC time and local time, in minutes.
: Browser type. Can be one of "IE", "Edge", "Chrome", "Opera", "Firefox", "Safari", "Other".
: Returns the raw user agent string of the client browser.
: 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.
: Browser version.
Wisej.Web.KeyEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the KeyDown or KeyUp event.
public class KeyEventArgs : EventArgsPublic Class KeyEventArgs
Inherits EventArgsInitializes a new instance of the class.
: Returns whether the ALT key was pressed.
: Returns whether the CTRL key was pressed.
: Returns or sets whether the event was handled.
: Returns the keyboard code..
: Returns the key data.
: Returns the keyboard value.
: Returns the modifier flags indicating which combination of CTRL, SHIFT, and ALT keys was pressed.
: Returns a value indicating whether the SHIFT key was pressed.
Returns whether the Alt key is pressed.
Returns: .
Returns whether the Control key is pressed.
Returns: .
Returns whether the Shift key is pressed.
Returns: .
Wisej.Web.PreviewKeyDownEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the PreviewKeyDown event.
public class PreviewKeyDownEventArgs : EventArgsPublic Class PreviewKeyDownEventArgs
Inherits EventArgsInitializes a new instance of the class with the specified key.
: Returns whether the ALT key was pressed.
: Returns whether the CTRL key was pressed.
: Returns whether a key is a regular input key.
: Returns the keyboard code.
: Returns the key data.
: Returns the keyboard value.
: Returns the modifier flags indicating which combination of CTRL, SHIFT, and ALT keys was pressed.
: Returns whether the SHIFT key was pressed.
Wisej.Web.SplitButton
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents a split button control.
: 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.
Wisej.Web.AccordionEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the method that will handle the Selected or Deselected event of a Accordion control.
public delegate void AccordionEventHandler(Object sender, AccordionEventArgs e)Public Delegate Sub AccordionEventHandler(ByVal sender As [Object], ByVal e As AccordionEventArgs)Wisej.Web.FolderBrowserDialogUI
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
sender
The source of the event.
e
A AccordionEventArgs that contains the event data.
Fired when a panel is selected.
Fired when a panel is deselected.
Fired when the mouse pointer is over the control and a mouse button is released.
Fired when the mouse wheel moves while the control has focus.
keyData
keyData
One of the Keys values.
Represents the method that will handle the PreviewKeyDown event.
Allows an object to serialize itself.
CookieStorage
Returns an instance of the CookieStorage class that represents the "cookies" storage in the browser.
LocalStorage
Returns an instance of the LocalStorage class that represents the "localStorage" object in the browser.
SessionStorage
Returns an instance of the SessionStorage class that represents the "sessionStorage" object in the browser.
<script>
Wisej.userData = {
value1: 100,
someName: "test"
};
</script>
int value1 = Application.Browser.UserData.value1;
string value2 = Application.Browser.UserData.someName;
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Bindable components implement this interface.
Allows a control to act like a button on a Form.
Defines an object that can invoke a Command.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
Public Class SplitButton
Inherits Buttonpublic class SplitButton : ButtonInitializes a new instance of the AccordionCancelEventArgs class.
panel
The the event is occurring for.
panelIndex
The zero-based index of panel in the collection.
cancel
true to cancel the panel change by default; otherwise, false.
AccordionAction: Returns a value indicating which event is occurring.
AccordionPanel: Returns the AccordionPanel the event is occurring for.
Represents the method that will handle the or event of a control.
Public Class AccordionCancelEventArgs
Inherits CancelEventArgspublic class AccordionCancelEventArgs : CancelEventArgsInitializes a new instance of the AccordionEventArgs class.
panel
The the event is occurring for.
panelIndex
The zero-based index of panel in the collection.
action
One of the values.
AccordionAction: Returns a value indicating which event is occurring.
AccordionPanel: Returns the AccordionPanel the event is occurring for.
Represents the method that will handle the or event of a control.
Public Class AccordionEventArgs
Inherits EventArgspublic class AccordionEventArgs : EventArgsUI implementation for the FolderDialog class.
public class FolderBrowserDialogUI : FormPublic Class FolderBrowserDialogUI
Inherits FormfolderDialog
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
All wisej top-level windows implement this interface.
Wisej.Web.JavaScript ClientEventCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents a collection of JavaScript events and their corresponding handler code.
public class ClientEventCollection : IList, ICollection, IEnumerable, IList<ClientEvent>, ICollection<ClientEvent>, IEnumerable<ClientEvent>Public Class ClientEventCollection
Inherits IList
Implements ICollection, IEnumerable, IList(Of ClientEvent), ICollection(Of ClientEvent), IEnumerable(Of ClientEvent): Returns the number of items in the collection.
: Returns the element at the specified index .
Adds the instance to the collection.
Removes all the items from the collection.
Checks whether the specified item exists in the collection.
Returns: . True of the collection contains the specified item .
Returns the position of the specified item in the collection.
Returns: . The index of the specified item or -1 if not found.
Inserts the item into the collection at the specified index .
Removes the item from the collection.
Returns: . True of the specified item was found and removed from the collection.
Removes the item at the location index .
Fired when the collection has changed.
Wisej.Web.Cursor
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents the mouse pointer.
public class CursorPublic Class CursorCreates a new cursor using the .
Creates a new cursor using an image source: can use a themed image or URL.
Creates a new cursor using the .
Creates a new cursor using the .
Creates a new cursor using the .
Creates a new cursor using an image source: can use a themed image or URL.
: Returns the name of the cursor.
: Returns or sets the pointer's position.
Wisej.Web.Cursors
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Defines a collection of predefined Cursor objects.
public class CursorsPublic Class Cursors: Returns the "shortcut" cursor.
: Returns the "arrow" cursor.
: Returns "cell" cursor.
: Returns the clipboard "copy" cursor.
: Returns the "crosshair" cursor.
: Returns the "default" cursor, which is usually an arrow cursor.
: Returns the "grab" cursor.
: Returns the "hand" cursor, typically used when hovering over a Web link.
: Returns the "help" cursor, which is a combination of an arrow and a question mark.
: Returns the "row-resize" cursor that appears when the mouse is positioned over a horizontal splitter bar.
: Returns the "text" cursor, which is used to show where the text cursor appears when the mouse is clicked.
: Returns the "move" cursor, typically an cross shape.
: Returns the "not-allowed" cursor that indicates that a particular region is invalid for the current operation.
: Returns the "none" cursor.
: Returns the "not-allowed" cursor.
: Returns the "move" sizing cursor, which consists of four joined arrows that point north, south, east, and west.
: Returns the "ne-resize" diagonal (north/east) sizing cursor.
: Returns the "nesw-resize" diagonal (northeast/southwest) sizing cursor.
: Returns the "n-resize" vertical (north/south) sizing cursor.
: Returns the "nw-resize" diagonal (north/west) sizing cursor.
: Returns the "nwse-resize" diagonal (northwest/southeast) sizing cursor.
: Returns the "se-resize" diagonal (south/east) sizing cursor.
: Returns the "sw-resize" diagonal (south/west) sizing cursor.
: Returns the "w-resize" horizontal (west/east) sizing cursor.
: Returns the "text" cursor.
: Returns the "col-resize" cursor that appears when the mouse is positioned over a vertical splitter bar.
: Returns the "wait" cursor, typically an hourglass shape.
: Returns the "zoom-in" cursor.
: Returns the "zoom-out" cursor.
Wisej.Web.SaveFileDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Prompts the user to select a location for saving a file on the server.
You can:
Override . It's called when the specified file doesn't exist and the property is true.
Override . It's called when the specified file doesn't exist and the property is true.
Override . It's called when the specified file doesn't exist and the property is true.
You must add at least one to the collection before showing the dialog.
Initializes a new instance of .
Initializes a new instance of the extender with a specified container.
: 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.
: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that already exists.
Opens the file with read/write permission selected by the user.
Returns: . A that specifies the read/write file selected by the user.
Throws:
is empty or null.
Receives the file names selected by the user and validates them according to the properties set in the instance.
Returns: . True if the files have been validated and the dialog can close; otherwise false to keep the dialog open.
Resets all dialog box options to their default values.
Wisej.Web.Button
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
item
ClientEvent item to add to the collection.
item
ClientEvent items to find in the collection.
item
ClientEvent item to locate in the collection.
index
Position where to insert the item .
item
ClientEvent item to insert into the collection.
item
ClientEvent instance to remove from the collection.
index
Position of the item to remove from the collection.
image
An Image to use for the cursor.
source
The name of a theme image or a URL to an image resource.
stream
A Stream to use for the cursor.
image
An Image to use for the cursor.
x
x-coordinate of the hotspot location.
y
y-coordinate of the hotspot location.
stream
A Stream to use for the cursor.
x
x-coordinate of the hotspot location.
y
y-coordinate of the hotspot location.
source
The name of a theme image or a URL to an image resource.
x
x-coordinate of the hotspot location.
y
y-coordinate of the hotspot location.
action
One of the AccordionAction values.
Allows an object to serialize itself.
Override CreateUI to create your custom Form when the method ShowDialog is called.
Set the DialogTemplate to a Form class that has a constructor that accepts FileDialog as the single argument to change the User Interface (UI) of the file dialog.
Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.
container
An IContainer that represents the container of the SaveFileDialog component.
fileNames
Array containing the selected file paths.
Public Class SaveFileDialog
Inherits FileDialogpublic class SaveFileDialog : FileDialogRepresents a button control.
public class Button : ButtonBase, IButtonControl, ICommandSourcePublic Class Button
Inherits ButtonBase
Implements IButtonControl, ICommandSourceInitializes a new instance of the Button class.
AutoSizeMode: Returns or sets the mode by which the Button automatically resizes itself.
BorderStyle: Returns or sets the border style of the button control.
DialogResult: Returns or sets a value that is returned to the parent form when the button is clicked.
Display: Returns or sets the Display mode of the control to determine whether to display the icon, the text or both.
Nullable<Int32>: Returns or sets the distance in pixels between the image and the label inside the button.
MenuItemCollection: Returns the collection of MenuItem objects associated with the button.
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.
Shortcut: Returns or sets a value indicating the shortcut key associated with the button.
Generates a Click event for a button.
EventHandler Fired when the Command property value changes.
MenuButtonItemClickedEventHandler Fired when the user clicks one of the drop down menu items.
Represents a split button control.
Bindable components implement this interface.
Allows a control to act like a button on a .
Defines an object that can invoke a .
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
Wisej.Web.Component
Wisej.Web.DragEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the DragDrop, DragEnter, or DragOver event.
public class DragEventArgs : EventArgsPublic Class DragEventArgs
Inherits EventArgsInitializes a new instance of the class.
: Returns which drag-and-drop operations are allowed by the originator (or source) of the drag event.
: Specify the types of files that the server accepts (that can be submitted through a file upload).
The allowed files string follows the HTML 4.01 and HTML5 specifications. You can configure only one entry in the browser's file dialog. The syntax is "file_extension|audio/|video/|image/*|media_type". Look at for a complete list of standard media types.
: Returns the that contains the data associated with this event.
: Returns the component that started the drag operation by calling . [Since 2.5.32]
: Returns the original target of the drag operation.
: Returns or sets the target drop effect in a drag-and-drop operation.
: Returns the containing the files that have been dropped on the target, or null.
: Returns or sets the custom image displayed on the client to represent the drag action.
: Returns or sets the size in pixels of the custom image displayed on the client to represent the drag action.
: Returns or sets the custom image source displayed on the client to represent the drag action.
: Returns the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons.
: Returns the location of the mouse or pointer event, in screen coordinates.
: Returns the x-coordinate of the mouse or pointer, in screen coordinates.
: Returns the y-coordinate of the mouse or pointer, in screen coordinates.
Wisej.Web.MouseEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides data for the MouseUp, MouseDown, and MouseMove events.
public class MouseEventArgs : EventArgsPublic Class MouseEventArgs
Inherits EventArgsInitializes a new instance of the class.
Initializes a new instance of the class.
: Returns which mouse button was pressed.
: Returns the number of clicks or taps.
: Returns the number of times the mouse wheel has rotated.
: Returns the location of the mouse or pointer event.
: Returns the original target when the pointer event has bubbled up because the original target was either not or .
: 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.
: Returns the x-coordinate of the mouse or touch event.
: Returns the y-coordinate of the mouse or touch event.
Wisej.Web.CheckBox
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents a check box control.
Initializes a new instance of the class.
: Returns or sets the value that determines the appearance of a control.
: Returns or set a value indicating whether the or values and the 's appearance are automatically changed when the is clicked.
: Returns or sets a value that indicates whether the control resizes based on its contents.
: Returns or sets the horizontal and vertical alignment of the check mark on a control.
: Returns or set a value indicating whether the is in the checked state.
: Returns or sets the text color used when the is checked.
: Returns or sets the state of the .
: Returns or sets a value that indicates that the control is invalid.
: Returns or sets the invalid message that is shown in the invalid tooltip.
: Returns or sets whether the control is read-only.
: Returns or sets the alignment of the text on the control.
: Returns or sets whether the will allow three check states rather than two.
Generates a event for a .
Fired when the value of the property changes.
Fired when the value of the property changes.
Fired when the value of the property changes.
Fired when the value of the property has changed.
Wisej.Web.RadioButton
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Enables the user to select a single option from a group of choices when paired with other controls.
Initializes a new instance of the class.
: Returns or sets the value that determines the appearance of a control.
: Returns or set a value indicating whether the or values and the 's appearance are automatically changed when the is clicked.
: Returns or sets a value that indicates whether the control resizes based on its contents.
: Returns or sets the horizontal and vertical alignment of the check mark on a control.
: Gets or sets whether the control is checked.
: Returns or sets the text color used when the is checked.
: Returns or sets a value that indicates that the control is invalid.
: Returns or sets the invalid message that is shown in the invalid tooltip.
: Returns or sets whether the control is read-only.
: Returns or sets whether the user can give the focus to this control using the TAB key and the property is set to true.
: Returns or sets the alignment of the text on the control.
Generates a event for a .
Fired when the value of the property changes.
Fired when the value of the property changes.
Fired when the value of the property has changed.
Wisej.Web.AccordionPanel
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents a panel in a control.
Initializes a new instance of the class.
Initializes a new instance of the class and specifies the text to display as the title of the panel.
: Returns the parent control.
: Returns whether the is collapsed.
: Returns or sets a value indicating that the panel can show the expand button on the title bar.
: Returns or sets the text to display as the title of the .
: Returns the instance of associated with this control.
Retrieves the panel that contains the specified .
Returns: . The that contains the specified , or null if it cannot be found.
Overridden to update the parent Accordion when in design mode.
Wisej.Web.FolderBrowserDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Allows the user to select a folder from one of the Roots.
Initializes a new instance of .
Initializes a new instance of using the initial roots .
Initializes a new instance of the extender with a specified container.
: Returns or sets the description splayed above the tree view control in the dialog box.
: 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.
: Returns sets the path selected by the user.
: Returns or sets whether the Help button is displayed in the file dialog box.
: Returns or sets the file dialog box title.
Returns the that contains the specified path .
Returns: . The that contains the specified path or null if not found.
Maps the virtual path to the corresponding physical path on the specific implementation.
Returns: . The physical path for the implementation.
Resets all properties to their default values.
Fired when the file dialog is loading a file or folder.
Wisej.Web.OpenFileDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Prompts the user to open a file from the server.
You can:
Override . It's called when the specified file doesn't exist and the property is true.
Override to create your custom when the method is called.
Set the to a class that has a constructor that accepts as the single argument to change the User Interface (UI) of the file dialog.
You must add at least one to the collection before showing the dialog.
Initializes a new instance of .
Initializes a new instance of the extender with a specified container.
: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
: Returns or sets a value indicating whether the dialog box allows multiple files to be selected.
: Returns the file name and extension for the file selected in the dialog box. The file name does not include the path.
: Returns an array of file names and extensions for all the selected files in the dialog box. The file names do not include the path.
Opens the file selected by the user, with read-only permission. The file is specified by the property.
Returns: . A that specifies the read-only file selected by the user.
Throws:
is empty or null.
Resets all properties to their default values.
Wisej.Web.ButtonBase
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Implements the basic functionality common to button controls.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
text
The text for the tab.
control
The Control to look for.
Bindable components implement this interface.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
Public Class AccordionPanel
Inherits Panelpublic class AccordionPanel : Panelroots
Initial file systems to load in the FolderBrowserDialog.
container
An IContainer that represents the container of the FolderBrowserDialog component.
path
Full path of the file to locate in on of the Roots.
folderPath
Virtual path to map to the corresponding physical path.
Public Class FolderBrowserDialog
Inherits CommonDialogpublic class FolderBrowserDialog : CommonDialogOverride OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.
container
An IContainer that represents the container of the OpenFileDialog component.
Public Class OpenFileDialog
Inherits FileDialogpublic class OpenFileDialog : FileDialogProvides a user interface for indicating that a control on a form has an error associated with it.
Represents a small rectangular pop-up window that displays a brief help text next to a control when it gets activated (focused).
Allows controls to execute javascript code.
Add rotation capabilities along the X,Y,Z axis to controls.
Adds CSS styling to controls.
Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.
Provides methods to manage a collection of objects. This class cannot be inherited.
Displays a standard column header in a control.
Displays an image column header in a control.
Represents an individual menu item that is displayed within a or and always shows a checkbox next to the label.
Represents a context menu associated to a .
Represents an individual menu item that is displayed within a or rendered using the link element to let the browser process the specified URL.
Represents the main menu in a .
Represents the base functionality for all menus.
Represents an individual item that is displayed within a or .
Represents a panel in a control that can host any .
Represents a panel in a control.
Represents an item in the .
Implements a timer that raises an event at user-defined intervals.
Represents a component in the Desktop control's taskbar.
Represents a DateTime component in the Desktop control's taskbar.
Provides support for animating controls or windows using predefined animations definitions or custom animations in response to certain events.
All wisej components implement this interface.
Allows an object to serialize itself.
Public Class Component
Inherits Component
Implements IComponentpublic class Component : Component, IComponentThe that indicates the location of the drag event.
allowedEffect
One of the DragDropEffects values.
effect
One of the DragDropEffects values.
data
The data associated with this event.
location
The y-coordinate of a pointer click, in pixels.
delta
A signed count of the number of dents the wheel has rotated.
The y-coordinate of a pointer click, in pixels.
delta
A signed count of the number of dents the wheel has rotated.
role
The internal role assigned to the element that generated the pointer event.
button
One of the MouseButtons values that indicate which mouse button was pressed.
clicks
The number of times a mouse button was pressed.
x
The x-coordinate of a pointer click, in pixels.
button
One of the MouseButtons values that indicate which mouse button was pressed.
clicks
The number of times a mouse button was pressed.
x
The x-coordinate of a pointer click, in pixels.
Represents the method that will handle the MouseDown, MouseUp, or MouseMove event of a form, control, or other component.
y
y
Allows an object to serialize itself.
Bindable components implement this interface.
Provides access to common image properties across the controls that implement this interface.
Provides access to the ReadOnly property for coontrols that support the read-only mode.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Public Class CheckBox
Inherits ButtonBase
Implements IReadOnlypublic class CheckBox : ButtonBase, IReadOnlyAllows an object to serialize itself.
Bindable components implement this interface.
Provides access to common image properties across the controls that implement this interface.
Provides access to the ReadOnly property for coontrols that support the read-only mode.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Public Class RadioButton
Inherits ButtonBase
Implements IReadOnlypublic class RadioButton : ButtonBase, IReadOnlypublic class ButtonBase : Control, IImagePublic Class ButtonBase
Inherits Control
Implements IImageInitializes a new instance of the ButtonBase class.
Boolean: Returns or sets a value indicating that the control can display HTML in the Text property.
Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.
Boolean: 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.
Boolean: 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.
AutoShowLoader blocks the entire browser as soon as the button is clicked since it's implemented on the client side, while ShowLoader blocks the specific widget when returning from the request.
Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.
CharacterCasing: Returns or sets the case of the text to display to the user.
Image: Returns or sets the image that is displayed in a button control.
ContentAlignment: Returns or sets the alignment of the image in the button control.
Int32: Returns or sets the image list index value of the image in the ImageList displayed in the button control.
Throws:
ArgumentOutOfRangeException The specified index is less than -1.
String: Returns or sets the key accessor for the image in the ImageList displayed in the button control.
String: Returns or sets the theme name or URL for the image to display in the button control.
String: Returns or sets the text associated with this control.
Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.
ContentAlignment: Returns or sets the alignment of the text in the button control.
TextImageRelation: Returns or sets the position of text and image relative to each other.
Boolean: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control.
Generates a Click event for a button.
Represents a button control.
Represents a check box control.
Enables the user to select a single option from a group of choices when paired with other controls.
Represents a split button control.
Bindable components implement this interface.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.CommonDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Specifies the base class used for displaying dialog boxes on the screen.
public class CommonDialog : ComponentPublic Class CommonDialog
Inherits ComponentInitializes a new instance of .
Initializes a new instance of the extender with a specified container.
: Returns or sets the type of the common dialog UI control to show when calling the method.
: Returns or sets an object that contains data about the control.
: Returns or sets the dialog box title.
: Returns or sets the initial of the common dialog.
When overridden in a derived class, resets the properties of a common dialog box to their default values.
Runs a common dialog box with a default owner.
Returns: . if the user clicks OK in the dialog box; otherwise, .
Runs a common dialog box with a default owner.
Returns: . if the user clicks OK in the dialog box; otherwise, .
Runs a common dialog box with the specified owner.
Returns: . if the user clicks OK in the dialog box; otherwise, .
Runs a common dialog box with the specified owner.
Returns: . if the user clicks OK in the dialog box; otherwise, .
Runs a common dialog box with the specified owner asynchronously.
Returns: . if the user clicks OK in the dialog box; otherwise, .
Fired when the user clicks the Help button on a common dialog box.
container
An IContainer that represents the container of the CommonDialog component.
onclose
Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event. When the onclose event handler is specified, the modal dialog doesn't suspend the execution on the server but it's still shown as a modal dialog on the client.
owner
A Form that represents the top-level window that owns the modal dialog box. It can be null.
owner
A Form 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 event. When the onclose event handler is specified, the modal dialog doesn't suspend the execution on the server but it's still shown as a modal dialog on the client.
owner
A Form that represents the top-level window that owns the modal dialog box. It can be null.
Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors.
Displays a dialog box from which the user can select a file.
Allows the user to select a folder from one of the Roots.
Prompts the user to open a file from the server.
Prompts the user to select a location for saving a file on the server.
Wisej.Core.Configuration
Namespace: Wisej.Core
Assembly: Wisej.Framework (3.0.0.0)
Wisej configuration settings.
public class ConfigurationPublic Class ConfigurationCreates a new instance from the specified json string.
: List of allowed Url routes separated by a semicolon. i.e.: "api;product;log/performance".
: When true, the application is automatically reloaded when the session expires or is called.
The application can always override this feature by changing the Wisej.onExit method using a script.
: The custom function used to validate the browser. If it returns false the browser is not supported and Wisej redirects to NotSupportedUrl.
: 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.
: Enabled/disables debug mode.
: 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.
: When true, the client drops all "execute" events triggered while there is a pending request.
: Cache-Control for embedded resources. The default is "browser" to cache the embedded resources on the browser for 1 month. Other allowed vaues are: - "server" to cache the resources on the server using the ETag header - "private, max-age=..." to use set the standard Cache-Control header - any value Cache-Control string value.
: Enables the PWA installation of the application.
: Enabled/disables the WebSocket protocol.
: Enabled/disables gzip compression when using the WebSocket protocol.
: The full path of the configuration file.
: Enables impersonation mode.
When set to true and windows authentication is configured in web.config, every request thread and application tasks started using Application.StartTask will impersonate the current user.
: The keep-alive interval in seconds.
: The ajax loader timeout in milliseconds.
: Full name of the first window created automatically at startup.
: Returns the maximum number of nested modal loops.
: Returns the maximum number of active sessions before redirecting to .
: Network check interval in milliseconds. The default is 1000 (1 second). If this value is set, Wisej will send a /healthcheck.wx request at the specified interval when the application goes offline.
: The URL of the page to load when the server cannot respond to the request.
: The URL of the page to load when the client browser is not supported.
: The URL of the page to load when the connection is lost.
: Native client-side platform options.
: 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 and to start and terminate the automatic polling from the client. Both methods are ignored when the client is using a WebSocket connection.
: The timeout for the server to respond to a wisej request in seconds.
: 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".
: Forces the client to switch to a secure connection (HTTPS and WSS).
: 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.
: The session timeout in seconds. The timeout is enforced on the client side.
: Application settings.
: Shows the loader animated gif while initializing the application.
: Returns whether this Wisej application is running in a standalone host (Wisej.Application.exe).
: The startup Main method.
: Theme name.
: ThreadPool min/max configuration, null by default.
: Url redirection.
: Verifies the client fingerprint when retrieving a session. It prevents session hijacking over unsecured connections.
Loads or retrieves the configuration file.
Returns: .
Fired when the system needs to load a Wisej configuration file.
An application can install a custom configuration handler and return a custom object. This is a static event and should be attached to before the application starts. One way to do that is to register an HttpModul with IIS, or a middleware for .NET Core, and attach to the event there.
Wisej.Web.Padding
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents padding or margin information associated with a user interface (UI) element.
public struct Padding : ValueType, IWisejSerializablePublic Structure Padding
Implements ValueType, IWisejSerializableInitializes a new instance of the class using a separate padding size for each edge.
Initializes a new instance of the class using the supplied padding size for all edges.
: Returns or sets the padding value for all the edges.
: Returns or sets the padding value for the bottom edge.
: Returns the combined padding for the right and left edges.
: Returns if the padding is empty.
: Returns or sets the padding value for the left edge.
: Returns or sets the padding value for the right edge.
: Returns the padding information in the form of a .
: Returns or sets the padding value for the top edge.
: Returns the combined padding for the top and bottom edges.
Computes the sum of the two specified values.
Returns: . A that contains the sum of the two specified values.
Subtracts one specified value from another.
Returns: . A that contains the result of the subtraction of one specified value from another.
Wisej.Web.FileDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
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 as the single argument to change the User Interface (UI) of the file dialog.
You must add at least one to the collection before showing the dialog.
Initializes a new instance of .
Initializes a new instance of using the initial roots .
Initializes a new instance of the extender with a specified container.
: Returns or sets whether the dialog box automatically adds an extension to a file name if the user omits the extension.
: Returns or sets whether the dialog box displays a warning if the user specifies a file name that does not exist.
: Returns or sets the default file name extension.
: Returns or sets a string containing the file name selected in the file dialog box.
: Returns the file names of all selected files in the dialog box.
: Returns the that contains the selected .
: 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.
: Returns or sets the index of the filter currently selected in the file dialog box.
: Returns or sets the initial directory displayed by the file dialog box.
: 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.
: Returns or sets whether the Help button is displayed in the file dialog box.
: Returns or sets the file dialog box title.
Returns the that contains the specified path .
Returns: . The that contains the specified path or null if not found.
Maps the virtual path to the corresponding physical path on the specific implementation.
Returns: . The physical path for the implementation.
Receives the file names selected by the user and validates them according to the properties set in the instance.
Returns: . True if the files have been validated and the dialog can close; otherwise false to keep the dialog open.
Resets all properties to their default values.
Fired when the user clicks on the Open or Save button on a file dialog box.
Fired when the file dialog is loading a file or folder.
Wisej.Web.ContainerControl
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Provides focus-management functionality for controls that can function as a container for other controls.
Initializes a new instance of the class.
: Returns or sets a collection of keys that fire the Accelerator event when the user presses the accelerator key while the focus is on any child control.
: Returns or sets the active control on the container control.
Throws:
The assigned could not be activated.
: Returns or sets the BindingContext for the control.
: Returns or sets whether the container will receive key events before the event is passed to the control that has focus.
: Returns the that the container control is assigned to.
: Returns the that the container control is assigned to.
: Enables or disables right-to-left layout when the value of is
Validates the last unvalidated control and its ancestors up through, but not including the current control.
Returns: .
Validates the last unvalidated control and its ancestors up through, but not including the current control.
Returns: .
Fired when one of the key is pressed.
Fired when the value of the property changes.
Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.
roots
Initial file systems to load in the FolderBrowserDialog.
container
An IContainer that represents the container of the FileDialog component.
path
Full path of the file to locate in on of the Roots.
filePath
Virtual path to map to the corresponding physical path.
fileNames
Array containing the selected file paths.
Prompts the user to open a file from the server.
Prompts the user to select a location for saving a file on the server.
Public Class FileDialog
Inherits CommonDialogpublic class FileDialog : CommonDialogjson
The json string that defines the configuration values.
filePath
The full path to the .json file to load.
<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());
}
}
}
}The padding size, in pixels, for the bottom edge.
Returns or sets the padding inside objects in any mode.
Returns or sets padding within the statusbar panel.
Returns or sets padding within the toolbar button.
Returns or sets the space between toolbar buttons.
Computes the sum of the two specified values.
Returns the size of the inset border and padding.
left
The padding size, in pixels, for the left edge.
top
The padding size, in pixels, for the top edge.
right
The padding size, in pixels, for the right edge.
all
The number of pixels to be used for padding for all edges.
p1
A Padding.
p2
A Padding.
p1
A Padding.
p2
A Padding.
Returns or sets padding within the control.
Returns or sets the space between controls.
Returns or sets the space between the edge of a DataGridViewCell and its content.
Returns or sets the additional padding around the label. This property can be defined in the theme.
Returns or sets the offset in pixels from the calculated position of the popup.
bottom
Provides an empty control that can be used to create other controls.
Displays data in a customizable list format.
Represents a desktop container that can host floating windows.
Provides an popup container that can be attached to other controls.
checkAutoValidate
If true, the value of the AutoValidate property is used to determine if validation should be performed; if false, validation is unconditionally performed.
UI implementation for the FileDialog class.
UI implementation for the FolderDialog class.
Represents a window or dialog box that makes up an application's user interface.
Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.
Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
Public Class ContainerControl
Inherits ScrollableControl
Implements IContainerControl, IContainerControlpublic class ContainerControl : ScrollableControl, IContainerControl, IContainerControlWisej.Web.Control ControlCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents a collection of Control objects.
public class ControlCollection : ControlCollection, IList<Control>, ICollection<Control>, IEnumerable<Control>, IWisejSynchronizedPublic Class ControlCollection
Inherits ControlCollection
Implements IList(Of Control), ICollection(Of Control), IEnumerable(Of Control), IWisejSynchronizedInitializes a new instance of the class.
: Returns whether the owner control has already been disposed.
: Returns the at the specified indexed location.
: Returns the with the specified key in the collection.
: Returns the control that owns this .
Adds the specified control to the control collection.
Adds an array of control objects to the collection.
Removes all controls from the collection.
Removes and disposes all controls from the collection.
Determines whether the specified control is a member of the collection.
Returns: . true if the is a member of the collection; otherwise, false.
Determines whether the contains an item with the specified key.
Returns: . true if the contains an item with the specified key; otherwise, false.
Searches for controls by their type and builds an array of all the controls that match.
Returns: . Array of controls that are derived from the specified type .
Throws:
type is null.
Searches for controls by their name and builds an array of all the controls that match.
Returns: . Array of controls with the specified name.
Throws:
The key parameter is null or an empty string ("").
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.
Returns: . A zero-based index value that represents the location of the specified child control within the control collection; otherwise -1 if the specified is not found in the .
Throws:
The child is not in the , and the throwException parameter value is true.
Retrieves a reference to an enumerator object that is used to iterate over a .
Returns: . An .
Retrieves the index of the specified control in the control collection.
Returns: . A zero-based index value that represents the position of the specified in the .
Retrieves the index of the first occurrence of the specified item within the collection.
Returns: . The zero-based index of the first occurrence of the control with the specified name in the collection.
Removes the specified control from the control collection.
Removes the child control with the specified key.
Sets the index of the specified child control in the collection.
owner
The Control that owns this collection.
child
The Control to add.
controls
An array of Control objects to add to the collection.
dispose
Indicates whether the controls removed from the collection should be disposed.
control
The Control to locate in the collection.
key
The key to locate in the ControlCollection.
type
The type of the controls to locate in the ControlCollection.
searchAllChildren
true to search all child controls; otherwise, false.
key
The key to located in the ControlCollection.
searchAllChildren
true to search all child controls; otherwise, false.
child
The Control to search for in the control collection.
throwException
true to throw an exception if the Control specified in the child parameter is not a control in the ControlCollection; otherwise, false.
control
The Control to locate in the collection.
key
The name of the control to search for.
child
The Control to remove.
key
The name of the child control to remove.
child
The child control to search for.
newIndex
The new index value of the control.
Represents a collection of child controls in a table layout container.
Removes all data from the Clipboard.
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.
Indicates whether there is data on the Clipboard that is in the specified format or can be converted to that format.
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.
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.
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.
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.
Indicates whether there is text data on the Clipboard in the format indicated by the specified TextDataFormat value.
format
One of the values.
Returns: Boolean. true if there is text data on the Clipboard in the value specified for format ; otherwise, false.
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.
Retrieves data from the Clipboard in the specified format.
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.
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.
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.
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.
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.
Retrieves text data from the Clipboard in the format indicated by the specified TextDataFormat value.
format
One of the values.
Returns: String. The Clipboard text data or Empty if the Clipboard does not contain data in the specified format.
audioBytes
A array containing the audio data.
Throws:
ArgumentNullException audioBytes is null.
audioStream
A containing the audio data.
Throws:
ArgumentNullException audioStream is null.
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();
text
The text to save to the client's temporary clipboard.
Throws:
ArgumentNullException text is null.
Saves the specified data to the clipboard in the specified format.
format
The format of the data to set. See for predefined formats.
data
An representing the data to add.
Throws:
ArgumentNullException data is null.
Saves the specified data to the clipboard.
data
The data to place on the Clipboard.
Throws:
ArgumentNullException The value of data is null.
Saves the collection of file names in the FileDrop format to the clipboard.
filePaths
A containing the file names.
Throws:
ArgumentNullException filePaths is null.
ArgumentException filePaths does not contain any strings, or at least one of the strings in filePaths is empty, contains only white space, contains one or more invalid characters as defined by InvalidPathChars, is null, contains a colon (:), or exceeds the system-defined maximum length. See the InnerException property of the ArgumentException for more information.
image
The to add to the Clipboard.
Throws:
ArgumentNullException image is null.
Saves the text data in the UnicodeText format to the clipboard.
text
The text to add to the Clipboard.
Throws:
ArgumentNullException text is null or Empty.
Saves the text data in the format indicated by the specified TextDataFormat value to the clipboard.
text
The text to add to the Clipboard.
format
One of the values.
Throws:
ArgumentNullException text is null.
Public Class Clipboardpublic class ClipboardWisej.Web.Accordion
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Displays collapsible set of AccordionPanel panels for presenting information in a limited amount of space.
Initializes a new instance of the class.
: Returns or sets the type of border that is drawn around the panel.
: Returns or sets a value indicating whether the Accordion control collapses when all the children are collapsed.
When this property is set to false (default) one panel is always expanded.
: Returns the rectangle that represents the virtual display area of the control.
: Returns or sets the size of the header. When the header is horizontal, the size if the height; when it's vertical, the size if the width. Set it to -1 to reset to the size set in the current theme.
: Returns or sets the images to display on the panel's title bar.
: Returns the number of panels in the container.
: Returns the collection of panels in the container.
: Returns or sets the index of the currently selected panel.
Throws:
The value is less than -1.
: Returns or sets a value indicating whether the selected panel is moved to the top of the container.
: Returns or sets the currently selected panel.
: Returns or sets whether a panel's ToolTip is shown when the mouse passes over the panel's title.
Makes the following the with the specified index the current panel.
Throws:
index is less than 0 or greater than the number of controls in the collection minus 1.
Makes the following the specified the current panel.
Throws:
panel is null.
Makes the following the the specified name the current panel.
Throws:
panelName is null; or panelName does not match the property of any in the collection.
Returns the panel at the specified location.
Returns: . The at the specified location.
Throws:
index is less than 0 or greater than the number of controls in the collection minus 1.
Makes the with the specified index the current .
Throws:
index is less than 0 or greater than the number of controls in the collection minus 1.
Makes the specified the current .
Throws:
panel is null.
Makes with the specified name the current .
Throws:
panelName is null; or panelName does not match the property of any in the collection.
Fired when a panel is deselected.
Occurs before a panel is deselected, enabling a handler to cancel the panel change.
Fired when a panel is selected.
Fired when the property has changed.
Occurs before a panel is selected, enabling a handler to cancel the panel change.
index
The index in the Panels collection of the AccordionPanel to deselect.
panel
The AccordionPanel to deselect.
panelName
The Name of the panel to deselect.
index
The index of the AccordionPanel to get.
index
The index in the Panels collection of the tab to select.
panel
The AccordionPanel to select.
panelName
The Name of the tab to select.
Bindable components implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
Public Class Accordion
Inherits Control
Implements ISupportInitializepublic class Accordion : Control, ISupportInitializeWisej.Core.ClientTheme
Namespace: Wisej.Core
Assembly: Wisej.Framework (3.0.0.0)
Represents a Wisej theme.
public class ClientTheme : IWisejSerializablePublic Class ClientTheme
Inherits IWisejSerializableYou 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, Images, Fonts, Appearances, Settings, and Stylesheet. 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.
Default private constructor.
Constructs a new theme from the name and JSON definition.
Constructs a new theme from the base theme.
: 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.
: Theme colors.
You can add or change any color in the current theme:
: 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:
: 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.
: The name of the theme.
: Theme settings.
The Settings property, added in Wisej 2, allows a theme to define certain internal properties. Currently these are the supported properties:
native-scrollbars Instructs Wisej to use the native scrollbars instead of the themed scrollbars. Setting this property can have negative side effects for virtual scrolling widgets like the DataGridView. The default is false.
overlapped-scrollbars Instructs Wisej to layout the scrollbars over the content being scrolled, similar to Windows' fluent themes or mobiles. The default is false.
: 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.
Returns the resolved color defined in the theme for the specified appearance, property or style name and optionally the state.
Returns: . A representing the color in the theme.
Returns the resolved theme color from the color list.
Returns: . A representing the color in the theme.
Returns the resolved font defined in the theme for the specified appearance, property name and optionally the state.
Returns: . A representing the queried font or null if not found.
Returns the resolved font defined from the font list.
Returns: . A representing the queried font or null if not found.
Returns the resolved image defined in the theme for the specified appearance, property or style name and optionally the state.
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.
Returns the resolved image defined from the image list.
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.
Returns the size of the inset border and padding.
Returns: . Dimension of the border and optionally the padding as a value
Returns the property value for the specified name and state within the specified appearance key.
Returns: . The typed value of the requested property, or default(T) if not found.
Returns the style value for the specified name and state within the specified appearance key.
Returns: . The typed value of the requested style, or default(T) if not found.
Returns true if the color is a theme color.
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.
Returns true if the font is a theme font.
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.
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.
Returns: . A instance with the resolved RGB values.
Returns the resolved from the theme font. If the font is a theme font, the value is resolved from current theme.
Returns: . A instance that can be used directly.
// 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 state that defines the property. It can omitted, the default state is "default".
The state that defines the property. It can omitted, the default state is "default".
name
Unique name of the theme.
name
Unique name of the theme.
json
JSON definition of the theme.
name
Unique name of the theme.
baseTheme
Original theme to copy into the new theme.
appearance
The appearance path that identifies the component in the theme. Nested appearances can be specified using a forward slash: i.e. window/captionbar.
name
The name of the property or the style value to query.
state
The name of the state to query. It's optional. The default is "default".
name
The name of the color to resolve from the color list.
appearance
The appearance path that identifies the component in the theme. Nested appearances can be specified using a forward slash: i.e. window/captionbar.
name
The name of the property value to query.
state
The name of the state to query. It's optional. The default is "default".
name
appearance
The appearance path that identifies the component in the theme. Nested appearances can be specified using a forward slash: i.e. window/captionbar.
name
The name of the property or the style value to query.
state
The name of the state to query. It's optional. The default is "default".
name
appearance
The name of the appearance in the theme. Child component appearances can be specified using the forward slash, i.e. "button/icon".
state
The state that defines the property. It can omitted, the default state is "default".
includePadding
Whether to include padding in the insets dimension.
T
The Type of the value to retrieve.
appearance
The name of the appearance in the theme. Child component appearances can be specified using the forward slash, i.e. "button/icon".
name
The name of the property to retrieve.
T
The Type of the value to retrieve.
appearance
The name of the appearance in the theme. Child component appearances can be specified using the forward slash, i.e. "button/icon".
name
The name of the property to retrieve.
color
Color to check.
font
Font to check.
color
The Color to resolve to a usable value.
font
The Font to resolve to a usable instance.
Allows an object to serialize itself.
state
state
// 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 };"
};
Wisej.Web.Accordion PanelCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Contains a collection of AccordionPanel objects.
public class PanelCollection : IList, ICollection, IEnumerable, IList<AccordionPanel>, ICollection<AccordionPanel>, IEnumerable<AccordionPanel>Public Class PanelCollection
Inherits IList
Implements ICollection, IEnumerable, IList(Of AccordionPanel), ICollection(Of AccordionPanel), IEnumerable(Of AccordionPanel): Returns the number of panels in the collection.
: Returns or sets a in the collection at the specified index.
Throws:
index is less than zero or greater than the highest available index.
value is null.
: Returns the with the specified key from the collection.
Adds a to the collection.
Throws:
The specified panel is null.
Creates a with the specified text, and adds it to the collection.
Creates a with the specified key and text and adds it to the collection.
Creates a with the specified key, text, and image, and adds it to the collection.
Creates a with the specified key, text, and image, and adds it to the collection.
Adds a set of panels to the collection.
Throws:
The value of panels is null.
Removes all the panels from the collection.
Removes and disposes all panels from the collection.
Determines whether a specified is in the collection.
Returns: . true if the specified is in the collection; otherwise, false.
Throws:
The value of panel is null.
Determines whether the collection contains a with the specified key.
Returns: . true to indicate a with the specified key was found in the collection; otherwise, false.
Copies the panels in the collection to the specified array, starting at the specified index.
Throws:
array is null.
array is less than zero.
array is multidimensional or the number of elements in the is greater than the available space from index to the end of array .
Returns the index of the in the collection.
Returns: . The zero-based index of the panel; -1 if it cannot be found.
Throws:
The value of panel is null.
Returns the index of the first occurrence of the with the specified key.
Returns: . The zero-based index of the first occurrence of a with the specified key, if found; otherwise, -1.
Inserts an existing into the collection at the specified index.
Creates a new with the specified text and inserts it into the collection at the specified index.
Creates a new with the specified key and text, and inserts it into the collection at the specified index.
Creates a new with the specified key, text, and image, and inserts it into the collection at the specified index.
Creates a with the specified key, text, and image, and inserts it into the collection at the specified index.
Removes the from the collection.
Throws:
The panel parameter is null.
Removes the at the specified index from the collection.
Removes the with the specified key from the collection.
The zero-based index of the image to display on the .
The key of the image to display on the .
panel
The AccordionPanel to add.
text
The text to display on the panel.
key
The name of the AccordionPanel.
text
The text to display on the title of AccordionPanel.
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
imageIndex
The index of the image to display on the title of the AccordionPanel.
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
imageKey
The key of the image to display on the title of the AccordionPanel.
panels
An array of type AccordionPanel that contains the panels to add.
dispose
Indicates whether to dispose the AccordionPanel panels removed from the collection.
panel
The AccordionPanel to locate in the collection.
key
The name of the AccordionPanel to search for.
array
The one-dimensional array that is the destination of the AccordionPanel panels copied from the collection. The array must have zero-based indexing.
index
The zero-based index in the array at which copying begins.
panel
The AccordionPanel to locate in the collection.
key
The name of the AccordionPanel to find in the collection.
index
The zero-based index location where the AccordionPanel is inserted.
panel
The AccordionPanel to insert in the collection.
index
The zero-based index location where the AccordionPanel is inserted.
text
The text to display in the AccordionPanel.
index
The zero-based index location where the AccordionPanel is inserted.
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
index
The zero-based index location where the AccordionPanel is inserted
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
index
The zero-based index location where the AccordionPanel is inserted.
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
panel
The AccordionPanel to remove.
index
The zero-based index of the AccordionPanel to remove.
key
The name of the AccordionPanel to remove.
imageIndex
imageKey
Initializes a new instance of the DataObject class.
Initializes a new instance of the DataObject class and adds the specified object to it.
data
The data to store.
Initializes a new instance of the DataObject class and adds the specified object in the specified format.
format
The format of the specified data. See for predefined formats.
data
The data to store.
Initializes a new instance of the DataObject class and adds the specified object in the specified format.
format
A representing the format of the data.
data
The data to store.
Indicates whether the data object contains data in the WaveAudio format.
Returns: Boolean. true if the data object contains audio data; otherwise, false.
Indicates whether the data object contains data that is in the FileDrop format or can be converted to that format.
Returns: Boolean. true if the data object contains a file drop list; otherwise, false.
Indicates whether the data object contains data that is in the Bitmap format or can be converted to that format.
Returns: Boolean. true if the data object contains image data; otherwise, false.
Indicates whether the data object contains data in the UnicodeText format.
Returns: Boolean. true if the data object contains text data; otherwise, false.
Indicates whether the data object contains text data in the format indicated by the specified TextDataFormat value.
format
One of the values.
Returns: Boolean. true if the data object contains text data in the specified format; otherwise, false.
Retrieves an audio stream from the data object.
Returns: Stream. A Stream containing audio data or null if the data object does not contain any data in the WaveAudio format.
Returns the data associated with the specified class type format.
format
A representing the format of the data to retrieve.
Returns: Object. The data associated with the specified format, or null.
Returns the data associated with the specified data format.
format
The format of the data to retrieve. See for predefined formats.
Returns: Object. The data associated with the specified format, or null.
Returns the data associated with the specified data format, using an automated conversion parameter to determine whether to convert the data to the format.
format
The format of the data to retrieve. See for predefined formats.
autoConvert
true to the convert data to the specified format; otherwise, false.
Returns: Object. The data associated with the specified format, or null.
Determines whether data stored in this DataObject is associated with, or can be converted to, the specified format.
format
A representing the format to check for.
Returns: Boolean. true if data stored in this DataObject is associated with, or can be converted to, the specified format; otherwise, false.
Returns the data associated with the specified class type format.
format
A representing the format of the data to retrieve.
Returns: Boolean. The data associated with the specified format, or null.
Determines whether this DataObject contains data in the specified format or, optionally, contains data that can be converted to the specified format.
format
The format to check for. See for predefined formats.
autoConvert
true to determine whether data stored in this can be converted to the specified format; false to check whether the data is in the specified format.
Returns: Boolean. true if the data is in, or can be converted to, the specified format; otherwise, false.
Returns the list of file types from the data object.
Returns: String[]. A string array containing the file types in the data object.
Returns the HttpFileCollection of files uploaded by the client in a drag & drop operation.
Returns: HttpFileCollection. A string array containing the file types in the data object.
Returns a list of all formats that data stored in this DataObject is associated with or can be converted to.
Returns: String[]. An array of type String, containing a list of all formats that are supported by the data stored in this object.
Returns a list of all formats that data stored in this DataObject is associated with or can be converted to, using an automatic conversion parameter to determine whether to retrieve only native data formats or all formats that the data can be converted to.
autoConvert
true to retrieve all formats that data stored in this is associated with, or can be converted to; false to retrieve only native data formats.
Returns: String[]. An array of type String, containing a list of all formats that are supported by the data stored in this object.
Retrieves an image from the data object.
Returns: Image. An Image representing the image data in the data object or null if the data object does not contain any data that is in the Bitmap format or can be converted to that format.
Retrieves text data from the data object in the UnicodeText format.
Returns: String. The text data in the data object or Empty if the data object does not contain data in the UnicodeText format.
Retrieves text data from the data object in the format indicated by the specified TextDataFormat value.
format
One of the values.
Returns: String. The text data in the data object or Empty if the data object does not contain data in the specified format.
audioBytes
A array containing the audio data.
Throws:
ArgumentNullException audioBytes is null.
audioStream
A containing the audio data.
Throws:
ArgumentNullException audioStream is null.
Adds the specified object to the DataObject using the object type as the data format.
data
The data to store.
Adds the specified object to the DataObject using the specified type as the format.
format
A representing the format associated with the data.
data
The data to store.
Adds the specified object to the DataObject using the specified format.
format
The format associated with the data. See for predefined formats.
data
The data to store.
Adds the specified object to the DataObject using the specified format and indicating whether the data can be converted to another format.
format
The format associated with the data. See for predefined formats.
autoConvert
true to allow the data to be converted to another format; otherwise, false.
data
The data to store.
Adds a url using DownloadURL format. The specified url is parsed to compose the DownloadURL as: "mime-type:file-name:url".
url
The url to the file to download.
fileName
The name of the file to download from the url.
Adds a collection of file names to the data object in the FileDrop format.
filePaths
A containing the file names.
Throws:
ArgumentNullException filePaths is null.
Adds a collection of file names to the data object in the FileDrop format.
filePaths
A containing the file names.
Throws:
ArgumentNullException filePaths is null.
image
The to add to the data object.
Throws:
ArgumentNullException image is null.
Adds text data to the data object in the UnicodeText format.
textData
The text to add to the data object.
Throws:
ArgumentNullException textData is null or Empty.
Adds text data to the data object in the format indicated by the specified TextDataFormat value.
textData
The text to add to the data object.
format
One of the values.
Throws:
ArgumentNullException textData is null or Empty.
Provides a format-independent mechanism for transferring data.
Public Class DataObject
Inherits IDataObjectpublic class DataObject : IDataObjectWisej.Web.Application
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represent a Wisej application session. Provides methods and events to manage the application in the context of the current session.
public class Application : IWisejComponent, IDisposable, IWisejSynchronized, IServiceProviderPublic Class Application
Inherits IWisejComponent
Implements IDisposable, IWisejSynchronized, IServiceProviderThis class provides several static methods, properties and events that allow the application to manage all sorts of features related to the current session:
Save and retrieve session variable. Use to store and retrieve session variable. The property is a dynamic object and a , therefore you can access its properties directly or through the indexer.
Manage cookies. Use to manage browser's cookies.
Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.
Read the application's URL. Use , , , and .
There is a lot more exposed by the class. You can inspect all the properties and methods in Visual Studio through IntelliSense or online at .
: 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.
: Returns or sets the client browser information.
: Returns the current unique client id.
: Returns a collection of all the unique client browsers using the application.
: Returns the path for the application data that is shared among all users.
: Returns the registry key for the application data that is shared among all users.
: Returns the company name associated with the application stored in the .
: Returns the current .
: Collection of cookies.
: 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.
: Returns or sets the current for the session.
: Returns or sets the current Desktop.
: 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.
: Returns the path for the application's main assembly.
: Returns or sets the favicon to display in the browser.
: Returns or sets the URL to the favicon to display in the browser.
: Returns or sets the hash part of the URL on the client.
: Returns a value indicating whether the session has been authenticated.
: Indicates that the current application instance, which corresponds to the session, has been terminated and disposed.
: Returns true when the current session has expired.
: Returns true if this session is running in secure mode (https:// and wss://)
: Returns true when the current session has been terminated.
: Returns true if the current session is connected using WebSocket.
: 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).
: Returns or sets the current full page window.
: Returns a collection of open forms owned by the application.
: Returns a collection of open pages owned by the application.
: The name of the currently loaded platform.
: Returns the product name associated with this application.
: Returns the product version associated with this application stored either in or .
: Returns the parameters used to launch the application.
: 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".
: Returns true when the application is running in not in design, debug or test mode.
: Returns the server's host name, DNS alias, or IP address as it would appear in self-referencing URLs.
: Returns the port number to which the request was sent.
: Returns the server variables.
: Provides a generic storage for session-based objects.
: Returns the total number of currently active sessions.
: Returns the unique current session ID.
: 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.
: Returns or sets whether the browser is blocked by the Ajax loader.
: Returns the root path of the web application.
: Returns the URI used to start the application.
: Returns the URL used to start the application.
: 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.
: Returns or sets the page title in the browser.
: Returns the current used either to launch or reload the application. It may be different from .
: Returns the current URL used either to launch or reload the application. It may be different from .
: Returns the security information for the current request.
: Returns the raw user agent string of the client browser.
: Returns the IP host address of the remote client.
: Returns the DNS name of the remote client.
: Returns the type for the current user.
: Gets a sorted string array of client language preferences.
Adds an event filter to monitor all the incoming events before they are routed to their respective component.
EXPERIMENTAL: Adds a scoped service to the service container.
Throws:
serviceType is null.
A service of type serviceType already exists.
EXPERIMENTAL: Adds a scoped service to the service container.
Throws:
serviceType is null.
A service of type serviceType already exists.
Adds the text and corresponding translation to the default locale on the client.
Instructs the browser to display a dialog with an optional message, and to wait until the user dismisses the dialog.
Returns: . An awaitable that represents the asynchronous operation.
Executes the JavaScript function on the client and receives the return value (or null) in the callback method.
Executes the JavaScript function on the client.
Asynchronously executes the JavaScript function on the client and returns an awaitable with the result of the remote call.
Returns: . An awaitable that represents the asynchronous operation.
Cancels the fullscreen mode.
Instructs the browser to display a dialog with an optional message, and to wait until the user either confirms or cancels the dialog. until the user dismisses the dialog.
Returns: . An awaitable that represents the asynchronous operation.
Downloads the specified file on the client.
Downloads the specified image to the client.
Downloads the bytes in the stream to the client.
Downloads the specified file on the client.
Downloads the specified image to the client.
Downloads the bytes in the stream to the client.
Stops the polling requests from the client.
Executes the JavaScript script on the client.
Executes the JavaScript script on the client and receives the return value (or null) in the callback method.
Asynchronously executes the JavaScript script on the client and returns an awaitable with the result of the remote call.
Returns: . An awaitable that represents the asynchronous operation.
Terminates the application and the corresponding session.
Find the first component that matches the conditions defined in the predicate function.
Returns: . The first qualified by the match expression.
This method lets an application find any live component in the current session.
Finds all the components that match the conditions in the predicate function.
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.
EXPERIMENTAL: Returns the requested service.
Returns: . An instance of the service T or null if the service is not found.
EXPERIMENTAL: Returns the requested service.
Returns: . An instance of serviceType or null if the service is not found.
Throws:
serviceType is null.
Loads an assembly given the file name or path.
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.
Creates an instance of the specified component from the assembly.
Returns: . An instance of a Wisej component implementing the interface.
Returns: .
Changes the current theme.
Returns the full file path in relation to the application's project directory.
Returns: . The full path relative to the current application's root directory.
Navigate to the specified URL.
Plays one of the built-in sounds
Plays a sound.
Executes the callback method after all processing is completed and before updating the client.
The Post() method is similar to the BeginInvoke() method used by desktop applications. It allows you to execute a block of code out of sync with the current execution flow.
Prints the specified control.
The control is printed without the caption or the borders, if present.
Prints the entire browser window.
Instructs the browser to display a dialog with an optional message prompting the user to input some text, and to wait until the user either submits the text or cancels the dialog.
Returns: . An awaitable that represents the asynchronous operation.
Causes the application to reload on the browser.
Removes the filter from the list of registered event filters.
EXPERIMENTAL: Removes the specified service type from the service container.
Throws:
serviceType is null.
Requests the browser to enable fullscreen mode if supported.
Executes the callback in context.
Sets the current session timeout in seconds.
Instructs the client to start polling the server for UI changes at the specified interval when a WebSocket connection is not available.
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.
Starts a new task within the current application context and returns immediately. See also .
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.
Starts a new task with a return value within the current application context and returns immediately. See also .
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.
Starts a bound to the current session context.
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 .
Executes the optional callback in context and pushes all the pending updates to the client when in WebSocket mode.
Use this method when you need to update the client asynchronously from an out-of-bound thread (different thread, not originating from a client request). You can call this method at the end of the code that updates the UI:
Or you can use the optional action function to enclose the code that updates the UI in a block and ensure that the client is updated when the code block exits:
Fired when the active window changes.
Fired when the application is about to shut down.
Fired when the application is reloaded in the browser because the user hit refresh or changed the URL.
Fired when the application is started, after the Main method is called.
Fired when the browser fires the "beforeinstallprompt" event. Corresponds to .
Fired at the beginning of every request.
Fired when the user resizes the browser.
Fired when the user activates the browser tab.
Fired when the user deactivates the browser tab.
Fired when the changes.
Fired at the end of every request.
Fired when the focused control changes.
Fired when the hash part of the URL changes on the client side.
Fired when the current thread has completed processing all the events and before the response is sent back to the client.
Fired when at the beginning of every request when impersonation is enabled in the JSON configuration file.
Set Handled to true if your application takes care of impersonation. The default implementation in Wisej is supported only in .NET Framework and the Windows platform.
Fired at the end of every request when impersonation is enabled in the JSON configuration file.
Set Handled to true if your application takes care of impersonation. The default implementation in Wisej is supported only in .NET Framework and the Windows platform.
Fired when a license error occurs.
Fired when the active responsive profile is changed.
Fired when the value changes.
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.
Fired when the current theme is changed.
Fired when a thread exception is thrown.
Read the applications's system information. Use StartupPath, ProductName, ProductVersion, etc.
Listen to the application's global events. See SessionTimeout , BeginRequest, ApplicationStart, ApplicationExitApplicationRefresh, BrowserSizeChangedResponsiveProfileChanged, CultureChanged, and many more.
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.
Optional callback invoked when fileName is downloaded.
Optional callback invoked when fileName is downloaded.
Optional callback invoked when fileName is downloaded.
filter
An object that implements the IEventFilter interface to add to the filter list.
serviceType
Type of the service to add.
serviceInstance
Instance of the serviceType or null to create it on demand.
scope
Scope of the serviceInstance .
serviceType
Type of the service to add.
callback
A callback object that can create the service. This allows a service to be declared as available, but delays creation of the object until the service is requested.
scope
Scope of the service.
text
The text to translate.
translation
The translation override.
message
A string you want to display in the alert dialog.
function
The name of the function to execute.
callback
Asynchronous callback method that receives the return value.
args
The arguments to pass to the function.
function
The name of the function to execute.
args
The arguments to pass to the function.
function
The name of the function to execute.
args
The arguments to pass to the function.
message
A string you want to display in the confirm dialog.
filePath
The file to download.
fileName
The name of the file to save on the client.
ondownload
Optional callback invoked when fileName is downloaded.
image
The image to download.
fileName
The name of the file to save on the client.
ondownload
Optional callback invoked when fileName is downloaded.
stream
The stream to send to the client.
fileName
The file name the client will use to save the stream.
ondownload
Optional callback invoked when fileName is downloaded.
target
Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.
filePath
The file to download.
fileName
The name of the file to save on the client.
target
Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.
image
The image to download.
fileName
The name of the file to save on the client.
target
Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.
stream
The stream to send to the client.
fileName
The file name the client will use to save the stream.
script
The script to evaluate.
script
The script to evaluate.
callback
Asynchronous callback method that receives the return value.
script
The script to evaluate.
match
A custom Predicate expression used to match the IWisejComponent to find.
match
A custom Predicate expression used to match the list of IWisejComponent objects to find.
T
Type of the service to retrieve.
serviceType
Type of the service to add.
nameOrFile
The file name or full path for the assembly to load.
nameOrFile
The file name or full path for the assembly to load.
className
packages
callback
packages
name
Name of the theme resource. Use only the name without the path and without the extension.
mixins
Optional list of theme mixins. If null, the default theme mixins are always applied.
path
url
URL to navigate to.
target
The target browser window: _self, _blank, etc.
type
One of MessageBoxIcon value that identifies the sound to play.
soundUrl
A string representing either a sound file URL or a base64 data URL.
callback
Method to invoke after the request has completed but before sending the response to the server.
control
The control to print, can be a window, a page or a single control.
message
A string of text to display to the user.
defaultValue
An optoional string containing the default value displayed in the text input field.
filter
An object that implements the IEventFilter interface to remove from the filter list.
serviceType
Type of the service to remove.
context
The application context to update. It can be any Wisej component or the IWisejComponent returned by the property Current.
action
Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.
seconds
interval
Polling interval in milliseconds. The minimum is 1000ms.
action
Start method invoked by the new task when it starts up.
T
action
Start method invoked by the new task when it starts up.
dueTime
The amount of time, in milliseconds, to delay before invoking the callback .
period
The time interval between invocations, in milliseconds.
callback
A callback method to invoke at the specified intervals.
context
The application context to update. It can be any Wisej component or the IWisejComponent returned by the property Current.
action
Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.
All wisej components implement this interface.
ondownload
ondownload
ondownload
Application.Session.myValue = 12;
Application.Session["myValue"] = 12;
var current = Application.Current;
var thread = new Thread(() => {
Application.Update(current, () => {
// code here is running in context.
});
});static class Program
{
static Program()
{
Application.LicenseKey = "...";
}
}// create a new custom theme cloned from the current theme.
var myTheme = new ClientTheme("MyTheme", Application.Theme);
// alter the buttonFace color.
myTheme.Colors.buttonFace = "red";
// update the current session using the new custom theme.
Application.Theme = myTheme;
// change the buttonFace color in the current theme.
// if the theme is one of the global themes, i.e. it was loaded
// using Application.LoadTheme(name), then the change is also global.
Application.Theme.Colors.buttonFace = "red";
// since the theme objects are all dynamic and use a special DynamicObject
// class part of the Wisej Framework, you can also use a string indexer
// to address any field.
Application.Theme.Colors["buttonFace"] = "red";
// Find the first component that is a Button with Text = "OK"
var button = Application.FindComponent(c => c is Button && ((Button)c).Text == "OK"); // List all text boxes that are read only in all forms.
var list = Application.FindComponents(c => c is TextBox && ((TextBox)c).ReadOnly);
void Test() {
Application.Post(() => {
this.listBox.Items.Add("1");
});
this.listBox.Items.Add("2");
// The items will be added in this order: "2", "1".
}
// this has not effect when the client and server are connected using WebSocket.
Application.StartPolling(1000);
Application.StartTask(() => {
for (int i = 0; i < 100; i++) {
this.label1.Text = "Counting..." + i;
Thread.Sleep(1000);
}
// this has not effect when the client and server are NOT connected using WebSocket.
Application.Update(this);
// this has not effect when the client and server are connected using WebSocket.
Application.EndPolling();
});Application.StartTask(() => {
for (int i = 0; i < 100; i++) {
this.label1.Text = "Counting..." + i;
// just wait a bit or it's too fast.
Thread.Sleep(1000);
Application.Update(this);
}
});string text = await Application.StartTask(() => {
string value = "";
for (int i = 0; i < 100; i++) {
value += i.ToString();
// just wait a bit or it's too fast.
Thread.Sleep(100);
}
return value;
});
this.label.Text = text;
Application.Update(this);
Application.StartTask(() => {
for (int i = 0; i < 100; i++) {
this.label1.Text = "Counting..." + i;
// just wait a bit or it's too fast.
Thread.Sleep(1000);
}
Application.Update(this);
});Application.StartTask(() => {
Application.Update(this, () => {
for (int i = 0; i < 100; i++) {
this.label1.Text = "Counting..." + i;
// just wait a bit or it's too fast.
Thread.Sleep(1000);
}
});
});Wisej.Web.Control
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Base class for all Wisej controls.
public class Control : IWisejControl, IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfilesPublic Class Control
Inherits IWisejControl
Implements IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfilesInitializes a new instance of the class.
: Returns or sets the description that will be reported to accessibility client applications. It is assigned to the "alt" attribute of the browser element.
: 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.
: 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.
: Returns or sets whether the control can initiate a drag-drop operation.
: Returns or sets whether the control can accept data that the user drags onto it.
: Returns or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.
: Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents.
: Sets the appearance key for the theme engine.
: Returns or sets the background color for the control.
: Returns or sets the background image displayed in the control.
: Returns or sets the background image layout as defined in the enumeration.
: Returns or sets the background image displayed in the control.
: Returns a flag indicating that the control is becoming the active control.
: Returns or sets the for the control.
: Returns the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
: Returns or sets the size and location of the control including its non-client area, in pixels and relative to the parent control.
: Determines whether the control can execute a command.
: Returns whether the control can receive focus.
: Returns whether the control can be selected.
: Returns or sets whether the control has captured the mouse.
: Returns or sets whether the control causes validation to be performed on controls that require to be validated when this control receives focus.
: 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:
: Returns the client rectangle of the control.
: Returns or sets the height and width of the client area.
: Indicates whether the control, or one of its child controls, has the input focus.
: Returns or sets the shortcut menu associated with the control.
: Returns the collection of controls contained within the control.
: Returns a value indicating whether the control has been created.
: 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:
: Returns or sets the custom CSS styles to add to the widget.
You can use any CSS style string.
: Returns or sets the cursor that is displayed when the mouse pointer is over the control.
: Returns the data bindings for the control.
: Returns the default background color of the control.
: Returns the default font of the control.
: Returns the default background color of the control.
: Returns the rectangle that represents the virtual display area of the control.
: Returns whether the control is in the process of disposing itself and child controls.
: Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
: Returns or sets whether the control can respond to user interaction.
: Enables or disables the browser's context menu.
: Returns or sets whether the control can gain the focus.
: Returns a value indicating whether the control has input focus.
: Gets or sets the font of the text displayed by the control.
: Returns or sets the text color of the control.
: Returns the unique server-side id (handle) for this component.
: Returns whether the control contains any child control.
: Returns whether the control specifies data bindings.
: Check if the control defines any responsive profile without forcing the creation of the collection.
: Checks if the dynamic object was created and has any value.
: Returns or sets the height of the control.
: 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:
: Returns whether the control has been disposed.
: Returns if the control has a server-side component id (handle) associated with it.
: Returns whether the control is mirrored.
: Returns the control's layout engine.
: Returns or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
: Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
: Returns or sets the space between controls.
: Returns or sets the maximum size for the control.
: Returns or sets the minimum size for the control.
: Returns a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
: Returns a value indicating which of the mouse buttons is in a pressed state.
: Returns the position of the mouse cursor in screen coordinates.
: Returns or sets whether the control can be moved by dragging.
: Gets or sets the name of the control.
: Returns or sets padding within the control.
: Returns or sets the parent container of the control.
: Returns the preferred size in which the control can fit.
: Returns or sets the edges of the control that can be dragged to resize the control.
: Returns the collection of responsive properties that have been set for this control.
: Return the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
: 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.
: Returns or sets whether the text in the control can be selected in the browser by the user by dragging the pointer. [Since 2.5.22]
Not to be confused with , which corresponds to the property. When is set to true, the text of the control (i.e. a label or a button) can be highlighted in the browser and copied to the clipboard. It will also make the widget "focusable" but only in the browser.
: Returns or sets whether the control is blocked by the ajax loader.
: Returns or sets the height and width of the control.
: 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:
: Returns or sets the tab order of the control within its container.
: Returns or sets whether the user can give the focus to this control using the TAB key and the property is set to true.
: Returns or sets the object that contains data about the control.
: Returns or sets the text associated with this control.
When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with " ".
: Returns or sets the tooltip text to show for this control.
When using property you can only set the ToolTip text and cannot change the default ToolTip icon set in the theme. To change the ToolTip icon you can either create a custom theme, or a theme mixin, or use the extender and the property added by the extender. You can change the default , , , , or enable HTML in by using a extender also without setting the property added by the extender.
: Returns or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
: Returns the parent control that is not parented by another . Typically, this is the outermost that the control is contained in.
: Returns a dynamic object that can be used to store custom data in relation to this control.
: Returns or sets whether to use the wait cursor for the current control and all child controls.
: Returns a flag indicating that the validation has been canceled.
: Returns or sets whether the control and all its child controls are displayed.
: Returns a value indicating the wheel delta from the last wheel event.
: Returns or sets the width of the control.
Adds a new listener script to the event name to the client widget.
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.
Adds the CSS class name to the widget element. If the class already exists in the it's not added.
Returns: . The new value of the property.
Adds the specified theme state to the widget.
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
Executes the specified delegate asynchronously.
Returns: . An that represents the result of the operation.
Executes the specified delegate asynchronously.
Returns: . An that represents the result of the asynchronous call.
Brings the control to the front of the z-order.
Runs the JavaScript function within the component's context in the browser.
Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.
Asynchronously runs the JavaScript function within the component's context in the browser and returns an awaitable containing the value returned by the remote call.
Returns: . An awaitable that represents the asynchronous operation.
Centers the position of the control within the bounds of the parent.
Centers the position of the control within the bounds of the parent either horizontally, vertically or both.
Indicates whether the specified control is a child of this control.
Returns: . true if the specified control is a child of the control; otherwise, false.
Creates and register this control and all its children.
Begins a drag-and-drop operation.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
Begins a drag-and-drop operation.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
Begins a drag-and-drop operation.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
Begins a drag-and-drop operation.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
Begins a drag-and-drop operation.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
Retrieves the return value from the asynchronous operation represented by asyncResult .
Returns: . The return value from the asynchronous operation.
Runs the javaScript code within the component's context in the browser.
Runs the javaScript code within the component's context in the browser and returns the value to the callback method.
Asynchronously runs the javaScript code within the component's context in the browser and returns an awaitable that contains the value returned by the remote call.
Returns: . An awaitable that represents the asynchronous operation.
Retrieves the form that the control is on.
Returns: .
Retrieves the page that the control is on.
Returns: .
Sets input focus to the control.
Returns: . true if the input focus request was successful; otherwise, false.
Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.
Returns: . The child at the specified coordinates.
Retrieves the child control that is located at the specified coordinates.
Returns: . A that represents the control that is located at the specified point.
Returns the script associated to the listener identified by id .
Returns: . JavaScript associated with the listener.
Returns the scripts for all the listeners attached to the event name .
Returns: . String array containing the scripts for the listeners attached to the event.
Returns the next up the control's chain of parents.
Returns: . The parent .
Retrieves the next control forward or back in the tab order of child controls.
Returns: . The next in the tab order.
Retrieves the value of the specified control style bit for the control.
Returns: . true if the specified control style bit is set to true; otherwise, false.
Checks whether the specified event name has any listener attached.
Returns: . True if the event name has any listener attached.
Returns true if the property contains the specified class name .
Returns: . True of the css class name is already included in .
Checks whether the specified theme state is present in the property.
Returns: . True if the widget already has the state .
Conceals the control from the user.
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Executes the specified delegate.
Returns: . The return value from the delegate being invoked, or null if the delegate has no return value.
Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
Returns: . An that contains the return value from the delegate being invoked, or null if the delegate has no return value.
Determines whether the specified character is the mnemonic character.
Returns: . true if the charCode character is the mnemonic character; otherwise, false.
Arranges all the child using the specified dock style, spaced by spacing pixels.
Arranges all the child using the specified dock style, spaced by spacing pixels.
Arranges all the child using the specified dock style, spaced by spacing pixels.
Arranges all the child using the specified dock style, spaced by spacing pixels.
Arranges all the child in the specified direction , spaced by spacing pixels.
Arranges all the child in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .
Arranges the specified child controls in the specified direction , spaced by spacing pixels.
Throws:
One of the controls is not a child of this control.
Arranges the specified child controls in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .
Throws:
One of the controls is not a child of this control.
Forces the control to apply layout logic to all its child controls.
Forces the control to apply layout logic to all its child controls.
Computes the location of the specified screen point into client coordinates.
Returns: . A that represents the converted , point , in client coordinates.
Computes the location of the specified client point into screen coordinates.
Returns: . A that represents the converted , point , in screen coordinates.
Computes the size and location of the specified screen rectangle in client coordinates.
Returns: . A that represents the converted , rect , in client coordinates.
Computes the size and location of the specified client rectangle in screen coordinates.
Returns: . A that represents the converted , rect , in screen coordinates.
Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control, including the non-client areas such as the caption of forms or panels.
Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.
Detaches and removes the listener identified by id .
Returns: . True if the id specified a valid lister and it was removed; otherwise false if id is invalid.
Removes all the listeners attached to the event name .
Returns: . True if the event name has any listener that was removed.
Removes the specified css class name from the control's property.
Returns: . The new value of the property.
Removes the specified theme state from the widget.
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
Removes all the data bindings from the control.
Resumes layout logic.
Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.
Scrolls the control into view in the container using the specified alignX and alignY preferences.
Scrolls the child control into view.
Activates a control.
Activates the next control in the list according to the specified selection rules.
Returns: . true if a control was activated; otherwise, false.
Sends the control to the back of the z-order.
Sets the bounds of the control to the specified location and size.
Sets the specified bounds of the control to the specified location and size.
Displays the control to the user.
Suspends the layout logic for the control.
Causes the control to update the corresponding client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .
Returns: . true if all of the children validated successfully; otherwise, false. If called from the or event handlers, this method will always return false.
Validates all selectable child controls in the container, including descendants. This is equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See 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.
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.
Fired when the property value changes.
Fired when the value of the property changes.
Fired when the value of the property changes.
Fired when the property changes.
Fired when the value of the property changes.
Occurs when the value of the property changes.
Fired when the value of the property changes.
Fired when the control is clicked.
Fired when the property value changes.
Fired when the value of the property changes.
Fired when a new control is added to the .
Fired when a control is made visible the first time, fully created and sent to the client.
Fired when a control is removed from the .
Fired when the value of the property changes.
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.
Fired when the component is disposed.
Fired when the value of the property changes.
Fired when the control is double-clicked.
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.
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.
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.
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.
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.
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.
Fired when the property value has changed.
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.
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.
Fired when the control gains the input focus.
Fired when the property value changes.
Fired when the property value changes.
Fired when the control gains the focus.
Fired when the user requests help for a control by pressing F1.
Fired when the ImeMode property has changed.
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.
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.
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.
Fired when a control should reposition its child controls.
Fired when the control loses the input focus.
Fired when the property value has changed.
Fired when a pointer holds on the screen.
Fired when the control loses focus.
Fired when the control's margin changes.
Fired when the control loses mouse capture.
Fired when the control is clicked by the mouse.
Fired when the control is double clicked by the mouse.
Fired when the mouse pointer is over the control and a mouse button is pressed.
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.
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.
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.
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.
Fired when the mouse pointer is over the control and a mouse button is released.
Fired when the mouse wheel moves while the control has focus.
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.
Fired when the control's padding changes.
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.
Fired when the property value changes.
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.
Fired before the event when a key is pressed while focus is on this control.
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.
Fired when the control is resized.
Fired when the active responsive profile is changed.
Fired when the property value changes.
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.
Fired when the property value changes.
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.
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.
Fired when the control style changed.
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.
Fired when the property value has changed.
Fired when the value of the property changes.
Fired when a pointer taps on the screen.
Fired when the property value changes.
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.
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.
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.
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.
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.
Fired when the control is finished validating.
Fired when the control is validating.
Fired when the property value changes.
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 size of the drag image specified in imageSource.
The size of the drag image specified in image.
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 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 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 , .
Horizontal alignment when using direction = .
vAlign
Vertical alignment when using direction = .
When true (default), it will also use the to arrange the controls.
hAlign
Horizontal alignment when using direction = .
vAlign
Vertical alignment when using direction = .
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 = .
true to include nested (children of child controls) child controls; otherwise, false.
wrap
true to continue searching from the first control in the tab order after the last control has been reached; otherwise, false.
The new property value of the control.
The new property value of the control.
specified
A bitwise combination of the values. For any parameter not specified, the current value will be used.
Implements the basic functionality common to button controls.
Represents a check box control.
Displays a in which a check box is displayed to the left of each item.
Represents a combo box control.
Provides focus-management functionality for controls that can function as a container for other controls.
Represents a control that allows the user to select or type a date and a time.
Represents a spinner control that displays string values.
Represents a panel that dynamically arranges its children horizontally or vertically in automatic rows or columns.
Represents a window or dialog box that makes up an application's user interface.
Represents a Wisej control that displays a frame around a group of controls with an optional caption.
Represents a label control.
Represents an hyper-link control.
Represents a control to display a list of items.
Provides a common implementation of members for the and classes.
Uses a mask to distinguish between proper and improper user input.
Represents the container for multiple-document interface (MDI) child forms.
Represents a control that enables the user to select a date using a visual monthly calendar display.
Represents a spinner control that displays numeric values.
Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.
Represents a collapsible panel with an optional header that contains a group of controls.
Represents an image control.
Represents a progress control that displays a value visually as a filled bar.
Enables the user to select a single option from a group of choices when paired with other controls.
Defines a base class for controls that support auto-scrolling behavior.
Represents an horizontal scroll bar.
Represents a vertical scroll bar.
Implements the basic functionality of a scroll bar control.
Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.
Creates a panel that is associated with a .
Manages a related set of pages.
Represents a single tab page in a .
Represents a text box control that allows the user to enter any value.
Implements the basic functionality required by text controls.
Enables the user to choose between a range of values by sliding a small bar along another bar.
Implements the basic functionality required by a spin box (also known as an up-down control).
Provides an empty control that can be used to create other controls.
Represents a web browser control that enables the user to navigate web pages inside a form or a page.
Represents a control that can be hosted in a .
Represents a control that can be hosted in a .
Represents a control that can be hosted in a cell.
Represents a control that can be hosted in a .
Represents a control that can be hosted in a cell when the cell's is set to .
Represents a data grid control.
Displays data in a customizable list format.
Used by the control to display data at run time.
Represents a desktop container that can host floating windows.
Displays collapsible set of panels for presenting information in a limited amount of space.
Represents a panel in a control.
Represents a control that can host ASP.NET or MVC pages within a Wisej application.
Represents the HTML5 canvas element.
Represents a control that can display flash applications.
Represents a panel that dynamically arranges its child controls.
Represents a control that displays any HTML file and a corresponding CSS style sheet as embedded HTML.
Represents a control that displays any HTML file in an IFrame element.
Represents a line control.
The TreeViewComboBox control represents a control with a as the drop down panel.
Base implementation for media controls.
Represents a control that displays a video file.
Represents a control that plays an audio file.
Represents a control that can display a pdf document in the browser either using the native pdf viewer, the pdf.js viewer, Google docs, or a custom viewer.
Represents a shape control. Displays an element a border in any of the four sides.
Displays child controls vertically or horizontally in a scrollable container.
Represents a spacer control. It can be used to add a space between controls in a layout panel. It is not rendered on the client.
Represents a split button control.
Represents a data field that displays a list of selectable and removable tags. The control recognizes tags as the user types and adds in front of the editable field.
Represents a spinner control that displays values.
The TreeViewComboBox control represents a control with a as the drop down panel.
Represent an upload widget. Allows users to selected one or more files and upload them to the server.
The UserComboBox control represents a control with a custom panel that drops down when the user clicks the down arrow.
Provides an popup container that can be attached to other controls.
Provides a generic widget that can use most third party javascript widgets.
Represents a list view control, which displays a collection of items that can be displayed using one of four different views.
Represents a menu bar component.
Provides a user interface for browsing the properties of an object.
Displays information to the user in a about the object being viewed, the object's components, or the object's operation.
Represents a toolbar component.
Displays a hierarchical collection of labeled items, each represented by a .
name
Name of the client event to attach the listener to.
script
JavaScript code to execute when the event occurs.
name
Name of the css class to add.
state
Name of the custom state to add to the widget.
method
A delegate to a method that takes no parameters.
method
A delegate to a method that takes no parameters.
args
An optional array of objects to pass as arguments to the specified method.
function
The name of the JavaScript function to execute.
args
The arguments to pass to the function.
function
The name of the JavaScript function to execute.
callback
Asynchronous callback method that receives the return value.
args
The arguments to pass to the function.
function
The name of the JavaScript function to execute.
args
The arguments to pass to the function.
horizontal
Center horizontally.
vertical
Center vertically.
control
The child Control to find.
data
The data to drag.
allowedEffects
One of the DragDropEffects values.
data
The data to drag.
allowedEffects
One of the DragDropEffects values.
imageSource
The name or URL for an image to use as the drag cursor.
data
The data to drag.
allowedEffects
One of the DragDropEffects values.
imageSource
The name or URL for an image to use as the drag cursor.
data
The data to drag.
allowedEffects
One of the DragDropEffects values.
image
An Image to use as the drag cursor.
data
The data to drag.
allowedEffects
One of the DragDropEffects values.
image
An Image to use as the drag cursor.
asyncResult
An IAsyncResult that represents a BeginInvoke operation started on a control.
javaScript
The JavaScript code to run on the client.
javaScript
The JavaScript code to evaluate on the client.
callback
Asynchronous callback method that receives the return value.
javaScript
The JavaScript code to evaluate on the client.
pt
A Point that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.
skipValue
One of the values of GetChildAtPointSkip, determining whether to ignore child controls of a certain type.
pt
A Point that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.
id
Id of the listener to retrieve the script for.
name
Name of the event.
control
The Control to start the search with.
forward
true to search forward in the tab order; false to search backward.
flag
The ControlStyles bit to return the value from.
name
Name of the client event to verify.
name
Css class name to verify.
state
Name of the state to check.
invalidateChildren
When true, invalidates all the children of the control.
method
A delegate that contains a method to be called in the control's thread context.
method
A delegate to a method that takes parameters of the same number and type that are contained in the args parameter.
args
An array of objects to pass as arguments to the specified method. This parameter can be null if the method takes no arguments.
charCode
The character to test.
text
The string to search.
dock
Indicates whether to arrange the Controls horizontally or vertically.
spacing
Spacing between the Controls.
useMargins
When true (default), it will also use the Margin to arrange the controls.
dock
Indicates whether to arrange the Controls horizontally or vertically.
viewArea
Rectangle limiting the area to arrange the Controls in. If empty, it will use DisplayRectangle.
spacing
Spacing between the Controls.
controls
List of child controls to arrange. If null, all the children will be arranged.
dock
Indicates whether to arrange the Controls horizontally or vertically.
spacing
Spacing between the Controls.
controls
List of child controls to arrange. If null, all the children will be arranged.
dock
Indicates whether to arrange the Controls horizontally or vertically.
viewArea
Rectangle limiting the area to arrange the Controls in. If empty, it will use DisplayRectangle.
direction
Indicates whether to arrange the Controls horizontally or vertically.
spacing
Spacing between the Controls.
useMargins
When true (default), it will also use the Margin to arrange the controls.
direction
Indicates whether to arrange the Controls horizontally or vertically.
viewArea
Rectangle limiting the area to arrange the Controls in. If empty, it will use DisplayRectangle.
spacing
Spacing between the Controls.
controls
List of child controls to arrange. If null, all the children will be arranged.
direction
Indicates whether to arrange the controls horizontally or vertically.
spacing
Spacing between the controls .
controls
List of child controls to arrange. If null, all the children will be arranged.
direction
Indicates whether to arrange the controls horizontally or vertically.
viewArea
Rectangle limiting the area to arrange the controls in. If empty, it will use DisplayRectangle.
affectedControl
A Control that represents the recently changed control.
affectedProperty
The name of the recently changed property on the control that caused the layout to change.
point
The screen coordinate Point to convert.
point
The client coordinate Point to convert.
rect
The screen coordinate Rectangle to convert.
rect
The client coordinate Rectangle to convert.
refreshChildren
True to also refresh all the children of this control.
id
Id of the listener to remove.
name
Name of the event.
name
The css class name to remove.
state
Name of the state to remove.
performLayout
true to apply all pending layout requests; otherwise, false.
alignX
Indicates the HorizontalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Center will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement.
alignY
Indicates the VerticalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Middle will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement.
control
The Control at which to start the search.
forward
true to move forward in the tab order; false to move backward in the tab order.
tabStopOnly
true to ignore the controls with the TabStop property set to false; otherwise, false.
x
The new Left property value of the control.
y
The new Top property value of the control.
width
The new Width property value of the control.
x
The new Left property value of the control.
y
The new Top property value of the control.
width
The new Width property value of the control.
flags
Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.
UI implementation for the FileDialog class.
UI implementation for the FolderDialog class.
Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.
Represents a button control.
Bindable components implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
imageSize
imageSize
hAlign
useMargins
useMargins
spacing
hAlign
useMargins
useMargins
spacing
nested
height
height
// set the border radius to 100% and make the control round.
this.button1.CssStyle = "border-radius:100%";
// change the background color of the internal label of the button widget.
this.button1.InitScript = "this.getChildControl('label').setBackgroundColor('red')";
// attach a JavaScript event handler.
this.textBox1.InitScript = @"this.addListener('keydown', function(e) {
if (e.getKeyIdentifier() == "PageDown") {
alert('You pressed PageDown.');
}
});
// force the widget to update the UI as if it was hovered and focused.
this.button1.States = new [] { "hovered", "focused" };
// apply a custom state defined in a custom theme or theme mixing.
this.panel1.States = new [] { "alert" }; this.fireWidgetEvent("myevent", {x:1, y:2, name:'test'});
private void control_WidgetEvent(object sender, WidgetEventArgs e) {
switch (e.Type) {
case "myevent":
var data = e.Data;
Alert.Show($"x={data.x}, y={data.y}, name={data.name}");
break;
}
}