1 of 100

v2.2

Welcome

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

Legend

Icon

Description

Concepts & Reference

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

Skills

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

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

Wisej.Web

General

Application

Wisej.Web.Application

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

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

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

Manage cookies. Use to manage browser's cookies.
Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.
Read the application's URL. Use , , , and .
Read the applications's system information. Use , , , etc.
Listen to the application's global events. See , , , , , , and many more.
Retrieve browser related information. Use the to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The object is updated automatically when the user resizes the browser or the page is reloaded.
Control the client browser. Start a , execute JavaScript functions or scriptlets using or . Make the browser navigate to a different URL using or simply the page.
Manage the main page or current desktop. lets you change the object that fills the browser and "navigate" from page to page. lets you change the active object on the client browser.
Manage all live components in the session. Through the class you can find, iterate, inspect all live components of any type. See for all the currently created (visible or invisible) instances of . returns all the created objects. and 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. 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 to load a Wisej theme into the application. Or use the object to read all sorts of information from the current .
Terminate the application without waiting for the session to timeout. Use to terminate the current session and free all the related memory.

Properties

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

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

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.

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

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

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

Methods

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

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

Executes the JavaScript function on the client.

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

Cancels the fullscreen mode.

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.

Terminates the application and the corresponding session.

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

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.

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

Loads an assembly given the file name or path.

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.

Changes the current theme.

Returns the full file path in relation to the application's project 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 window.

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

Prints the entire browser window.

Causes the application to reload on the browser.

Removes the filter from the list of registered event filters.

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

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

Throws:

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.

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:

Events

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.

Implements

Application.FormCollection

Wisej.Web.Application FormCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Holds the collection of all top-level application forms.

public class FormCollection : ICollection, IEnumerable

Public Class FormCollection
    Inherits ICollection
    Implements IEnumerable

Properties

Count

Int32: Returns the total number of currently open forms.

Item(index)

Form: Returns the form at the specified index.

Item(name)

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

Methods

GetEnumerator()

Returns an enumerator that iterates through the open forms.

Returns: IEnumerator.

Application.PageCollection

Wisej.Web.Application PageCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Holds the collection of all top-level application pages.

Properties

Count

: Returns the total number of currently open pages.

Item(index)

: Returns the page at the specified index.

Item(name)

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

Methods

GetEnumerator()

Returns an enumerator that iterates through the open pages.

HashChangedEventArgs

Wisej.Web.HashChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the HashChanged event.

public class HashChangedEventArgs : EventArgs

Public Class HashChangedEventArgs
    Inherits EventArgs

Constructors

HashChangedEventArgs(value)

Initializes a new instance of the HashChangedEventArgs class.

Name

Type

Description

Properties

Hash

String: The hash string from the client.

Used By

Name

Description

HashChangedEventHandler

Wisej.Web.HashChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the HashChanged event.

public delegate void HashChangedEventHandler(Object sender, HashChangedEventArgs e)

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

Parameters

Name

Type

Description

Fired By

Name

Description

ResponsiveProfileChangedEventArgs

Wisej.Web.ResponsiveProfileChangedEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the ResponsiveProfileChanged event.

public class ResponsiveProfileChangedEventArgs : EventArgs

Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs

Constructors

ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the ResponsiveProfileChangedEventArgs class.

Name

Type

Description

Properties

CurrentProfile

ClientProfile: The new active profile.

PreviousProfile

ClientProfile: The previously active profile.

Used By

ResponsiveProfileChangedEventHandler

Wisej.Web.ResponsiveProfileChangedEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Parameters

Name

Type

Description

Fired By

Name

Description

Component

Wisej.Web.Component

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Constructors

Component()

Default constructor

Methods

Update()

Updates the component on the client.

Inherited By

Implements

Control.ControlCollection

Wisej.Web.Control ControlCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents a collection of objects.

Constructors

ControlCollection(owner)

Initializes a new instance of the class.

Name

Type

Description

Properties

IsDisposed

: Returns whether the owner control has already been disposed.

Item(index)

: Returns the at the specified indexed location.

Item(key)

Methods

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.

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

Throws:

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

Throws:

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.

Throws:

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

Retrieves the index of the first occurrence of the specified item within 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.

Buttons

Common Dialogs

Containers

Application

Wisej.Web.Application

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

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

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

Manage cookies. Use to manage browser's cookies.
Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.
Read the application's URL. Use , , , and .
Read the applications's system information. Use , , , etc.
Listen to the application's global events. See , , , , , , and many more.
Retrieve browser related information. Use the to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The object is updated automatically when the user resizes the browser or the page is reloaded.
Control the client browser. Start a , execute JavaScript functions or scriptlets using or . Make the browser navigate to a different URL using or simply the page.
Manage the main page or current desktop. lets you change the object that fills the browser and "navigate" from page to page. lets you change the active object on the client browser.
Manage all live components in the session. Through the class you can find, iterate, inspect all live components of any type. See for all the currently created (visible or invisible) instances of . returns all the created objects. and 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. 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 to load a Wisej theme into the application. Or use the object to read all sorts of information from the current .
Terminate the application without waiting for the session to timeout. Use to terminate the current session and free all the related memory.

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

Properties

ActiveProfile

: Returns or sets the current client responsive profile.

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

Browser

: Returns or sets the client browser information.

ClientFingerprint

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

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

CommonAppDataPath

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

CommonAppDataRegistry

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

CompanyName

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

Configuration

: Returns the current .

Cookies

: Collection of cookies.

Current

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

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

CurrentCulture

: Returns or sets the current for the session.

Desktop

: Returns or sets the current Desktop.

EnableUnloadConfirmation

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

ExecutablePath

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

FavIcon

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

FavIconSource

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

Hash

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

IsAuthenticated

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

IsDisposed

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

IsExpired

: Returns true when the current session has expired.

IsSecure

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

IsTerminated

: Returns true when the current session has been terminated.

IsWebSocket

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

LicenseKey

: Returns or sets the runtime server license key.

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

MainPage

: Returns or sets the current full page window.

OpenForms

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

OpenPages

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

Platform

: The name of the currently loaded platform.

ProductName

: Returns the product name associated with this application.

ProductVersion

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

QueryString

: Returns the parameters used to launch the application.

RightToLeft

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

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

RuntimeMode

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

ServerName

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

ServerPort

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

ServerVariables

: Returns the server variables.

Session

: Provides a generic storage for session-based objects.

SessionCount

: Returns the total number of currently active sessions.

SessionId

: Returns the unique current session ID.

ShowConsole

: Shows or hides the debug console on the browser.

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

ShowLoader

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

StartupPath

: Returns the root path of the web application.

StartupUri

: Returns the URI used to start the application.

StartupUrl

: Returns the URL used to start the application.

Theme

: Returns or sets the current .

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

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

Title

: Returns or sets the page title in the browser.

Uri

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

Url

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

User

: Returns the security information for the current request.

UserAgent

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

UserHostAddress

: Returns the IP host address of the remote client.

UserHostName

: Gets the DNS name of the remote client.

UserIdentity

: Returns the type for the current user.

UserLanguages

: Gets a sorted string array of client language preferences.

Methods

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

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

Executes the JavaScript function on the client.

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

Cancels the fullscreen mode.

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.

Terminates the application and the corresponding session.

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

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.

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

Loads an assembly given the file name or path.

Creates an instance of the specified component from the assembly.

Changes the current theme.

Returns the full file path in relation to the application's project 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 window.

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

Prints the entire browser window.

Causes the application to reload on the browser.

Removes the filter from the list of registered event filters.

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

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

Throws:

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.

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

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

Events

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.

Implements

Clipboard

Wisej.Web.Clipboard

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public class Clipboard

Public Class Clipboard

Methods

Clear()

Removes all data from the Clipboard.

ContainsAudio()

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

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

ContainsData(format)

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

Parameter

Type

Description

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

ContainsFileDropList()

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

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

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.

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.

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.

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

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

Throws:

ArgumentNullException audioBytes is null.

Saves the Stream in the WaveAudio format to the clipboard.

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();

Throws:

ArgumentNullException text is null.

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

Throws:

ArgumentNullException data is null.

Saves the specified data to the clipboard.

Throws:

ArgumentNullException The value of data is null.

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

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.

Saves the Image in the Bitmap format to the clipboard

Throws:

ArgumentNullException image is null.

Saves the text data in the UnicodeText format 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.

Throws:

ArgumentNullException text is null.

Control

Wisej.Web.Control

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Base class for all Wisej controls.

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

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

Constructors

Control()

Initializes a new instance of the Control class.

Properties

AccessibleDescription

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

AccessibleName

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

AccessibleRole

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

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

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

AnchorStyles: Returns or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.

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

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

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

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

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

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

Boolean: Determines whether the control can execute a command.

Boolean: Returns whether the control can receive focus.

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

ClientEventCollection: Returns a collection of client events and JavaScript listeners. You may attach multiple listeners to same event.

You can use this collection at design time or in code or through the listener methods:

AddClientEventListener
HasClientEventListener
RemoveClientEventListener
RemoveClientEventListener
GetClientEventListener

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

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

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

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

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

AddCssClass
RemoveCssClass
HasCssClass

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

You can use any CSS style string.


  // set the border radius to 100% and make the control round.
  this.button1.CssStyle = "border-radius:100%";

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

ControlBindingsCollection: Returns the data bindings for the control.

Color: Returns the default background color of the control.

Font: Returns the default font of the control.

Color: Returns the default background color of the control.

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

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

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

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

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

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

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

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

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

Boolean: Returns whether the control specifies data bindings.

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

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

Int32: Returns or sets the height of the control.

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

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

  // change the background color of the internal label of the button widget.
  this.button1.InitScript = "this.getChildControl('label').setBackgroundColor('red')";

  // attach a JavaScript event handler.
  this.textBox1.InitScript = @"this.addListener('keydown', function(e) {
    if (e.getKeyIdentifier() == "PageDown") {
      alert('You pressed PageDown.');
    }
  });

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

AddClientEventListener
HasClientEventListener
RemoveClientEventListener
RemoveClientEventListener
GetClientEventListener

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

Boolean: Returns whether the control is mirrored.

LayoutEngine: Returns the control's layout engine.

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

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

Padding: Returns or sets the space between controls.

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

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

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

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

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

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

String: Gets or sets the name of the control.

Padding: Returns or sets padding within the control.

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

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

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

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

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

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

The behavior of this property is configurable in Default.json setting the "rightToLeft" property to "true", "false", or "auto". The default is "auto", causing the value to be retrieved from the current language.

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

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

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

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

  // force the widget to update the UI as if it was hovered and focused.
  this.button1.States = new [] { "hovered", "focused" };

  // apply a custom state defined in a custom theme or theme mixing.
  this.panel1.States = new [] { "alert" };

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

AddState
RemoveState
HasState

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

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

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

String: Returns or sets the text associated with this control.

When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with " ".

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

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

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

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

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

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

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

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

Int32: Returns or sets the width of the control.

Methods

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

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

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

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

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

Adds the specified theme state to the widget.

Returns: String[]. The new list of states stored in the States property.

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

Executes the specified delegate asynchronously.

Returns: IAsyncResult. An IAsyncResult 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 Task containing the value returned by the remote call.

Returns: Task<Object>. An awaitable Task 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: Boolean. 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: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

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

Begins a drag-and-drop operation.

Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop 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 Task that contains the value returned by the remote call.

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

Retrieves the form that the control is on.

Returns: Form.

Retrieves the page that the control is on.

Returns: Page.

Sets input focus to the control.

Returns: Boolean. 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: Control. The child Control at the specified coordinates.

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

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

Returns the script associated to the listener identified by id .

Returns: String. JavaScript associated with the listener.

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

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

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

Returns: IContainerControl. The parent IContainerControl.

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

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

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

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

Checks whether the specified event name has any listener attached.

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

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

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

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

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

Executes the specified delegate.

Returns: Object. 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: Object. An Object 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: Boolean. true if the charCode character is the mnemonic character; otherwise, false.

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

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

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

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

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

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

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

Returns: Rectangle. A Rectangle that represents the converted Rectangle, 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: Boolean. 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: Boolean. True if the event name has any listener that was removed.

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

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

Removes the specified theme state from the widget.

Returns: String[]. The new list of states stored in the States property.

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

Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values.

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: Boolean. 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 selectable child controls in the container, including descendants. This is equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See Selectable for details of exactly which child controls will be validated.

Returns: Boolean.

Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .

Returns: Boolean.

Events

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

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

EventHandler Fired when the AutoSize property value changes.

EventHandler Fired when the value of the BackColor property changes.

EventHandler Fired when the value of the BackgroundImage property changes.

EventHandler Fired when the BackgroundImageLayout property changes.

EventHandler Occurs when the value of the BindingContext property changes.

EventHandler Fired when the value of the CausesValidation property changes.

EventHandler Fired when the control is clicked.

EventHandler Fired when the ClientSize property value changes.

EventHandler Fired when the value of the ContextMenu property changes.

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

EventHandler Fired when the value of the Cursor property changes.

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

EventHandler Fired when the component is disposed.

EventHandler Fired when the value of the Dock property changes.

EventHandler Fired when the control is double-clicked.

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

This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

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

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

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

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

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

EventHandler Fired when the Enabled property value has changed.

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

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

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

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

EventHandler Fired when the control gains the input focus.

EventHandler Fired when the Font property value changes.

EventHandler Fired when the ForeColor property value changes.

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

EventHandler Fired when the ImeMode property has changed.

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

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

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

LayoutEventHandler Fired when a control should reposition its child controls.

EventHandler Fired when the control loses the input focus.

EventHandler Fired when the Location property value has changed.

EventHandler Fired when a pointer holds on the screen.

EventHandler Fired when the control's margin changes.

EventHandler Fired when the control loses mouse capture.

MouseEventHandler Fired when the control is clicked by the mouse.

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

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

EventHandler Fired when the mouse pointer enters the control.

EventHandler Fired when the mouse pointer rests on the control.

EventHandler Fired when the mouse pointer leaves the control.

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

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

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

EventHandler Fired when the control's padding changes.

PaintEventHandler Fired when a UserPaint control needs to redraw itself.

EventHandler Fired when the Parent property value changes.

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

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

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

EventHandler Fired when the control is resized.

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

EventHandler Fired when the RightToLeft property value changes.

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

EventHandler Fired when the Size property value changes.

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

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

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

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

EventHandler Fired when the control style changed.

SwipeEventHandler Fired when a pointer swipes over the screen.

EventHandler Fired when the TabIndex property value has changed.

EventHandler Fired when the value of the TabStop property changes.

EventHandler Fired when a pointer taps on the screen.

EventHandler Fired when the Text property value changes.

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

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

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

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

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

EventHandler Fired when the control is finished validating.

CancelEventHandler Fired when the control is validating.

EventHandler Fired when the Visible property value changes.

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

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

  this.fireWidgetEvent("myevent", {x:1, y:2, name:'test'});

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

  
  private void control_WidgetEvent(object sender, WidgetEventArgs e) {
    
    switch (e.Type) {
    
      case "myevent":
        var data = e.Data;
        Alert.Show($"x={data.x}, y={data.y}, name={data.name}");
        break;
    }
  }

Inherited By

Implements

DataObject

Wisej.Web.DataObject

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Implements a basic data transfer mechanism.

public class DataObject : IDataObject

Public Class DataObject
    Inherits IDataObject

Constructors

DataObject()

Initializes a new instance of the DataObject class.

DataObject(data)

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

Name

Type

Description

DataObject(format, data)

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

Name

Type

Description

Methods

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.

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.

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

Returns the data associated with the specified data format.

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.

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.

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.

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.

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

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.

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.

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

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

Throws:

ArgumentNullException audioBytes is null.

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

Throws:

ArgumentNullException audioStream is null.

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

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

Adds the specified object to the DataObject using the specified format.

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

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

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

Throws:

ArgumentNullException filePaths is null.

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

Throws:

ArgumentNullException image is null.

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

Throws:

ArgumentNullException textData is null or Empty.

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

Throws:

ArgumentNullException textData is null or Empty.

Implements

FileDialog

Wisej.Web.FileDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

CommonDialog
- FileDialog

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

public class FileDialog : CommonDialog

Public Class FileDialog
    Inherits CommonDialog

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

Override PromptFileNotFound. It's called when the specified file doesn't exist and the property CheckFileExists is true.
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.

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

Constructors

FileDialog()

Initializes a new instance of FileDialog.

FileDialog(roots)

Initializes a new instance of FileDialog using the initial roots .

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

Properties

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

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

String: Returns or sets the default file name extension.

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

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

IFileSystemProvider: Returns the IFileSystemProvider that contains the selected FileName.

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

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

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

FileDialogRootCollection: List of root IFileSystemProvider file systems displayed by the FileDialog.

The Roots collection and the IFileSystemProvider 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.

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

String: Returns or sets the file dialog box title.

Methods

Returns the IFileSystemProvider that contains the specified path .

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

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

Returns: String. The physical path for the IFileSystemProvider implementation.

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

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

Events

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

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

Inherited By

DataRepeater

Wisej.Web.DataRepeater

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Control
- ScrollableControl
  - ContainerControl
    DataRepeater

Displays data in a customizable list format.

public class DataRepeater : ContainerControl, ISupportInitialize

Public Class DataRepeater
    Inherits ContainerControl
    Implements ISupportInitialize

Constructors

DataRepeater()

Initializes a new instance of the DataRepeater class.

Properties

AllowUserToAddItems

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

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

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

DataRepeaterItem: Returns the current DataRepeaterItem in the DataRepeater control.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Boolean: Returns or sets whether the scrollbar is visible. When the scrollbar is hidden, the user can still scroll using touch events, the keyboard, or the wheel.

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

Methods

Adds a new DataRepeaterItem to the DataRepeater control.

Throws:

ReadOnlyException The AllowUserToAddItems property is set to False.

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

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

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

Throws:

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

Resets the value of ItemBorderStyle to the original value.

Resets the value of ItemHeaderSize to the original value.

Resets the value of ItemHeaderVisible to the original value.

Scrolls the specified DataRepeaterItem into view.

Throws:

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

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

Throws:

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

Events

EventHandler Fired when the AllowUserToAddItems property changes.

EventHandler Fired when the AllowUserToDeleteItems property changes.

EventHandler Fired when the property CurrentItemIndex changes.

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

EventHandler Fired when the DataMember property changes.

EventHandler Fired when the DataSource property changes.

DataRepeaterItemEventHandler Fired after the DataRepeaterItem and its controls are cloned from the ItemTemplate.

DataRepeaterItemCloneEventHandler Fired before the DataRepeaterItem and its controls are cloned from the ItemTemplate.

DataRepeaterAddRemoveItemsEventHandler Fired when a new DataRepeaterItem is added to the DataRepeater control.

DataRepeaterItemEventHandler Fired after the DataRepeaterItem becomes the current item.

DataRepeaterAddRemoveItemsEventHandler Fired when a DataRepeaterItem is deleted from the DataRepeater control.

DataRepeaterItemEventHandler Fired when an instance of DataRepeaterItem is updated.

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

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

EventHandler Fired when the LayoutStyle property changes.

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

DataRepeaterAddRemoveItemsEventHandler Fired when the user adds a new DataRepeaterItem.

DataRepeaterAddRemoveItemsEventHandler Fired after the user deletes a DataRepeaterItem.

DataRepeaterAddRemoveItemsCancelEventHandler Fired when the user deletes a DataRepeaterItem.

EventHandler Fired when the VirtualMode property changes.

Implements

Accordion

Wisej.Web.Accordion

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Control
- Accordion

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

public class Accordion : Control, ISupportInitialize

Public Class Accordion
    Inherits Control
    Implements ISupportInitialize

Constructors

Accordion()

Initializes a new instance of the Accordion class.

Properties

BorderStyle

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

Collapsible

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

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

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

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

Int32: Returns the number of panels in the container.

PanelCollection: Returns the collection of panels in the container.

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

Throws:

ArgumentOutOfRangeException The value is less than -1.

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

AccordionPanel: Returns or sets the currently selected panel.

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

Methods

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

Throws:

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

Makes the AccordionPanel following the specified AccordionPanel the current panel.

Throws:

ArgumentNullException panel is null.

Makes the AccordionPanel following the AccordionPanel the specified name the current panel.

Throws:

ArgumentNullException panelName is null; or panelName does not match the Name property of any AccordionPanel in the Panels collection.

Returns the AccordionPanel panel at the specified location.

Returns: Control. The AccordionPanel at the specified location.

Throws:

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

Makes the AccordionPanel with the specified index the current AccordionPanel.

Throws:

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

Makes the specified AccordionPanel the current AccordionPanel.

Throws:

ArgumentNullException panel is null.

Makes AccordionPanel with the specified name the current AccordionPanel.

Throws:

ArgumentNullException panelName is null; or panelName does not match the Name property of any AccordionPanel in the Panels collection.

Events

AccordionEventHandler Fired when a panel is deselected.

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

AccordionEventHandler Fired when a panel is selected.

EventHandler Fired when the SelectedIndex property has changed.

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