Control
Wisej.Web.Control
Last updated
Was this helpful?
v4.0
Wisej.Web.Control
Last updated
Was this helpful?
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Base class for all Wisej controls.
Initializes 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. (Default: null)
: Returns or sets the name of the control for use by accessibility client applications. It is assigned to the "name" attribute of the browser element. (Default: null)
You can use this collection at design time or in code or through the listener methods:
You can use any CSS style string.
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:
When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with "<BR/>".
Adds a new listener script to the event name to the client widget.
name
Name of the client event to attach the listener to.
script
JavaScript code to execute when the event occurs.
The script will execute in the browser when the event name occurs. You can attach multiple listeners to the same event.
name
Name of the css class to add.
Adds the specified theme state to the widget.
state
Name of the custom state to add to the widget.
Adds the specified theme state to the widget and optionally propagates it to the child components when forward is true.Since 3.5.5
state
Name of the custom state to add to the widget.
forward
true to propagate the state to the widget's child components.
Executes the specified delegate asynchronously, in the context of the session that owns the control.
method
A delegate to a method that takes no parameters.
Executes the specified delegate asynchronously, in the context of the session that owns the control, with the specified list of arguments.
method
A delegate to a method that takes no parameters.
args
An optional array of objects to pass as arguments to the specified method.
Brings the control to the front of the z-order.
Runs the JavaScript function within the component's context in the browser.
function
The name of the JavaScript function to execute.
args
The arguments to pass to the function.
Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.
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.
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.
horizontal
Center horizontally.
vertical
Center vertically.
Indicates whether the specified control is a child of this control.
control
Creates and register this control and all its children.
Creates a new instance of the control collection for the control.
Disposes the control.
disposing
true when this method is called by the application rather than a finalizer.
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
imageSource
The name or URL for an image to use as the drag cursor.
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
imageSource
The name or URL for an image to use as the drag cursor.
imageSize
The size of the drag image specified in imageSource.
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
image
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
image
imageSize
The size of the drag image specified in image.
Retrieves the return value from the asynchronous operation represented by asyncResult .
asyncResult
Runs the javaScript code within the component's context in the browser.
javaScript
The JavaScript code to run on the client.
Runs the javaScript code within the component's context in the browser and returns the value to the callback method.
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.
Sets input focus to the control.
Returns how a control will behave when its AutoSize property is enabled.
Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.
pt
skipValue
Retrieves the child control that is located at the specified coordinates.
pt
Returns the script associated to the listener identified by id .
id
Id of the listener to retrieve the script for.
Returns the scripts for all the listeners attached to the event name .
name
Name of the event.
Converts ContentAlignment to the equivalent iconAlign value.
alignment
Retrieves the next control forward or back in the tab order of child controls.
control
forward
true to search forward in the tab order; false to search backward.
Retrieves the value of the specified control style bit for the control.
flag
Determines if the control is a top-level control.
Checks whether the specified event name has any listener attached.
name
Name of the client event to verify.
name
Css class name to verify.
state
Name of the state to check.
To check only if a propagated state is present, use HasState("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.
invalidateChildren
When true, invalidates all the children of the control.
Executes the specified delegate, in the context of the session that owns the control.
method
A delegate that contains a method to be called in the control's session context.
Executes the specified delegate, in the context of the session that owns the control, with the specified list of arguments.
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.
control
Control to invoke the event on.
e
Event data.
Determines whether a character is an input character.
charCode
The character to test.
Determines whether the specified key is a regular input key.
keyData
Determines whether the specified character is the mnemonic character.
charCode
The character to test.
text
The string to search.
dock
dock
viewArea
controls
List of child controls to arrange. If null, all the children will be arranged.
dock
controls
List of child controls to arrange. If null, all the children will be arranged.
dock
viewArea
direction
direction
viewArea
Arranges the specified child controls in the specified direction , spaced by spacing pixels.
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 between the controls .
Throws:
Arranges the specified child controls in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .
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
Spacing between the controls .
Throws:
Adds references components to the list. Referenced components can be added individually or as a reference to a collection.
items
Container for the referenced components or collections.
e
e
e
e
e
e
e
e
e
e
e
e
e
e
e
e
e
e
e
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.
e
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.
e
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.
e
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.
e
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.
e
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.
e
e
e
e
e
e
e
e
e
e
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.
e
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.
e
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.
e
e
e
e
e
e
e
e
e
e
e
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.
e
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.
e
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.
e
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.
e
e
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.
e
e
e
e
e
e
e
e
e
e
e
e
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.
e
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.
e
e
e
e
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.
e
e
e
e
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.
e
e
e
e
e
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.
e
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.
e
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.
e
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.
e
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.
e
e
e
Processes the event from the client.
e
Event arguments.
Allows the control to paint itself.
g
Renders the client component.
config
Dynamic configuration object.
Updates the client component using the state information.
state
Dynamic state object.
e
Forces the control to apply layout logic to all its child controls.
Forces the control to apply layout logic to all its child controls.
affectedControl
affectedProperty
The name of the recently changed property on the control that caused the layout to change.
Computes the location of the specified screen point into client coordinates.
point
Computes the location of the specified client point into screen coordinates.
point
Processes a command key.
keyData
Processes a dialog character.
charCode
The character to process.
Processes a dialog key.
keyData
Processes a key event before the KeyDown and KeyUp events.
e
Computes the size and location of the specified screen rectangle in client coordinates.
rect
Computes the size and location of the specified client rectangle in screen coordinates.
rect
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 the corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.
refreshChildren
True to also refresh all the children of this control.
Detaches and removes the listener identified by id .
id
Id of the listener to remove.
Removes all the listeners attached to the event name .
name
Name of the event.
name
The css class name to remove.
Removes the specified theme state from the widget.
state
Name of the state to remove.
Removes the specified theme state from the widget.Since 3.5.5
state
Name of the state to remove.
forward
true to remove the state to the widget's child components.
Removes all the data bindings from the control.
Resolves the named or themed color to an actual usable color value.
color
The color to resolve.
Resumes layout logic.
Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.
performLayout
true to apply all pending layout requests; otherwise, false.
Scrolls the control into view in the container using the specified alignX and alignY preferences.
alignX
alignY
Scrolls the child control into view.
Activates, including setting the focus, a control.
Activates a child control. Optionally specifies the direction in the tab order to select the control from.
directed
true to specify the direction of the control to select; otherwise, false.
forward
true to move forward in the tab order; false to move backward in the tab order.
Activates the next control in the list according to the specified selection rules.
control
forward
true to move forward in the tab order; false to move backward in the tab order.
tabStopOnly
nested
true to include nested (children of child controls) child controls; otherwise, false.
wrap
true to continue searching from the first control in the tab order after the last control has been reached; otherwise, false.
Sends the control to the back of the z-order.
Sets a value indicating how a control will behave when its AutoSize property is enabled.
mode
Sets the bounds of the control to the specified location and size.
x
y
width
height
Sets the specified bounds of the control to the specified location and size.
x
y
width
height
specified
Sets the client size of the control.
width
The client width, in pixels.
height
The client height, in pixels.
Sets the control as the top-level control.
value
true to set the control as the top-level control; otherwise, false.
Throws:
Sets the control to the specified visible state.
value
Displays the control to the user.
Converts the client size into the window size.
clientSize
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 the current control.
Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .
flags
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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:
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.
Implements the basic functionality common to button controls.
Represents a check box control.
Represents a combo box control.
Provides focus-management functionality for controls that can function as a container for other controls.
Represents a control that allows the user to select or type a date and a time.
Represents a spinner control that displays string values.
Represents a panel that dynamically arranges its controls horizontally or vertically in automatic rows or columns.
Represents a window or dialog box that makes up an application's user interface.
Represents a Wisej control that displays a frame around a group of controls with an optional caption.
Represents a label control.
Represents an hyper-link control.
Represents a control to display a list of items.
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.
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.
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 data grid control.
Displays data in a customizable list format.
Represents a desktop container that can host floating windows.
Represents a control that can host ASP.NET or MVC pages within a Wisej application.
Represents the HTML5 canvas element.
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.
Base implementation for media controls.
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 text box control that allows the user to enter a typed value.
Represent an upload widget. Allows users to selected one or more files and upload them to the server.
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.
Provides access to the UserData and Tag properties associated to the component implementing this interface.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
Allows an object to serialize itself.
: Returns or sets the accessible role of the control that will be reported to accessibility client applications. It is assigned to the "role" attribute of the browser element. (Default: Default)
: Returns or sets whether the control can initiate a drag-drop operation. (Default: False)
: Returns or sets whether the control can accept data that the user drags onto it. (Default: False)
: Returns or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. (Default: Top, Left)
: Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents. (Default: False)
: Sets the appearance key for the theme engine. (Default: null)
: Returns or sets the background color for the control.
: Returns or sets the background image displayed in the control. (Default: null)
: Returns or sets the background image layout as defined in the enumeration. (Default: None)
: Returns or sets the background image displayed in the control. (Default: null)
: 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. (Default: True)
: Returns a collection of client events and JavaScript listeners. You may attach multiple listeners to same event.
: 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. (Default: null)
: 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.
: Returns or sets the cursor that is displayed when the mouse pointer is over the control. (Default: null)
: Returns the data bindings for the control.
: Returns the default background color of the control.
: Returns or sets the default cursor for the control.
: Returns the default font of the control.
: Returns the default background color of the control.
: Returns the default value for the property.
: Returns the length and height, in pixels, that is specified as the default maximum size of a control.
: Returns the length and height, in pixels, that is specified as the default minimum size of a control.
: Returns the internal spacing, in pixels, of the contents of a control.
: Returns the default size 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. (Default: None)
: 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. (Default: True)
: 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 height of the font of 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 true when this control belogs to a session different than the currently executing thread.
: 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 (Default: False)
Not to be confused with , which corresponds to the property. When is set to true, the text of the control (i.e. a label or a button) can be highlighted in the browser and copied to the clipboard. It will also make the widget "focusable" but only in the browser.
: Returns or sets whether the control is blocked by the ajax loader. (Default: False)
: Returns or sets the height and width of the control.
: Returns or sets additional theme states to the client widget.
Since 3.5.5 Add a + after the name of the state to propagate the state to the child controls of the widget. See also .
: 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. (Default: True)
: Returns or sets the object that contains data about the control. (Default: null)
: Returns or sets the text associated with this control. (Default: "")
: Returns or sets the tooltip text to show for this control. (Default: "")
When using property you can only set the ToolTip text and cannot change the default ToolTip icon set in the theme. To change the ToolTip icon you can either create a custom theme, or a theme mixin, or use the extender and the property added by the extender. You can change the default , , , , or enable HTML in by using a extender also without setting the property added by the extender.
: 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. (Default: False)
: 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.
Returns: . An integer id that you can use to remove the listener from the event using or to retrieve the listener script code using .
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.
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
Returns: . An that represents the result of the operation.
Returns: . An that represents the result of the asynchronous call.
Returns: .
Returns: . this control
Returns: . this control
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.
Returns: . this control
Returns: . this control
The child to find.
Returns: . true if the specified control is a child of the control; otherwise, false.
Returns: .
Returns: . An instance of .
One of the values.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
One of the values.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
One of the values.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
One of the values.
An to use as the drag cursor.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
One of the values.
An to use as the drag cursor.
Returns: . A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation.
An that represents a operation started on a control.
Returns: . The return value from the asynchronous operation.
Returns: . this control
Returns: . this control
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 that contains the control.
Returns: .
Retrieves the that contains the control.
Returns: .
Returns: . true if the input focus request was successful; otherwise, false.
Returns: . One of the values.
A 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.
One of the values of , determining whether to ignore child controls of a certain type.
Returns: . The child at the specified coordinates.this control
A 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.
Returns: . A that represents the control that is located at the specified point.
Returns: . JavaScript associated with the listener.
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 .
Returns: .
The to start the search with.
Returns: . The next in the tab order.
The bit to return the value from.
Returns: . true if the specified control style bit is set to true; otherwise, false.
Returns: . true if the control is a top-level container: , , .
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 .
Returns: .
Returns: . The return value from the delegate being invoked, or null if the delegate has no return value.
Returns: . An that contains the return value from the delegate being invoked, or null if the delegate has no return value.
Raises the event for the specified control.
Returns: . true if the character is an input character; otherwise, false.
One of the values.
Returns: . true if the specified key is a regular input key; otherwise, false.
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.
Indicates whether to arrange the horizontally or vertically.
spacing
Spacing between the .
useMargins
When true (default), it will also use the to arrange the controls.
hAlign
Horizontal alignment when using dock = , or , or .
vAlign
Vertical alignment when using dock = , or , .
Arranges all the child using the specified dock style, spaced by spacing pixels.
Indicates whether to arrange the horizontally or vertically.
Rectangle limiting the area to arrange the in. If empty, it will use .
spacing
Spacing between the .
useMargins
When true (default), it will also use the to arrange the controls.
hAlign
Horizontal alignment when using dock = , or , or .
vAlign
Vertical alignment when using dock = , or , .
Arranges all the child using the specified dock style, spaced by spacing pixels.
Indicates whether to arrange the horizontally or vertically.
spacing
Spacing between the .
useMargins
When true (default), it will also use the to arrange the controls.
hAlign
Horizontal alignment when using dock = , or , or .
vAlign
Vertical alignment when using dock = , or , .
Arranges all the child using the specified dock style, spaced by spacing pixels.
Indicates whether to arrange the horizontally or vertically.
Rectangle limiting the area to arrange the in. If empty, it will use .
spacing
Spacing between the .
useMargins
When true (default), it will also use the to arrange the controls.
hAlign
Horizontal alignment when using dock = , or , or .
vAlign
Vertical alignment when using dock = , or , .
Arranges all the child in the specified direction , spaced by spacing pixels.
Indicates whether to arrange the horizontally or vertically.
spacing
Spacing between the .
useMargins
When true (default), it will also use the to arrange the controls.
hAlign
Horizontal alignment when using direction = .
vAlign
Vertical alignment when using direction = .
Arranges all the child in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .
Indicates whether to arrange the horizontally or vertically.
Rectangle limiting the area to arrange the in. If empty, it will use .
spacing
Spacing between the .
useMargins
When true (default), it will also use the to arrange the controls.
hAlign
Horizontal alignment when using direction = .
vAlign
Vertical alignment when using direction = .
spacing
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 = .
One of the controls is not a child of this control.
Rectangle limiting the area to arrange the controls in. If empty, it will use .
spacing
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 = .
One of the controls is not a child of this control.
Fires the event.
An that contains the event data.
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.
Raises the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
An that contains the event data.
Raises the event.
An that contains the event data.
Fires the event.
An that contains the event data.
Raises the event.
An that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
An that contains the event data.
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.
Fires the event.
An that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event when the property value of the control's container changes.
An that contains the event data.
Fires the event when the property value of the control's container changes.
An that contains the event data.
Fires the event when the property value of the control's container changes.
An that contains the event data.
Fires the event.
An that contains the event data.
Fires the event when the property of the control's container changes.
An that contains the event data.
Fires the event when the property value of the control's container changes.
An that contains the event data.
Fires the event when the property value of the control's container changes.
An that contains the event data.
Fires the event when the property value of the control's container changes.
An that contains the event data.
Fires the event when the property value of the control's container changes.
An that contains the event data.
Fires the event when the property value of the control's container changes.
An that contains the event data.
Fires the event.
An instance of that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
An instance of that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An instance of that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
An instance of that contains the event data.
Fires the event.
An instance of that contains the event data.
Fires the event.
An instance of that contains the event data.
Fires the event.
An instance of that contains the event data.
Fires the event.
An instance of that contains the event data.
Fires the event.
An that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
A that represents the recently changed control.
The screen coordinate to convert.
Returns: . A that represents the converted , point , in client coordinates.
The client coordinate to convert.
Returns: . A that represents the converted , point , in screen coordinates.
One of the values that represents the key to process.
Returns: . true if the character was processed by the control; otherwise, false.
Returns: . true if the character was processed by the control; otherwise, false.
One of the values that represents the key to process.
Returns: . true if the key was processed by the control; otherwise, false.
A that contains the event data.
Returns: . true if the key event was processed by the control; otherwise, false.
The screen coordinate to convert.
Returns: . A that represents the converted , rect , in client coordinates.
The client coordinate to convert.
Returns: . A that represents the converted , rect , in screen coordinates.
Returns: . True if the id specified a valid lister and it was removed; otherwise false if id is invalid.
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.
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
Returns: . The new list of states stored in the property.
You can also assign a new array of states to the property.
Returns: .
Returns: .
Indicates the preference. The final location of the control depends on the scrollable range and the available space. Note that will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement.
Indicates the preference. The final location of the control depends on the scrollable range and the available space. Note that will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement.
Returns: . this control
Returns: . this control
Returns: .
Returns: . this control
The at which to start the search.
true to ignore the controls with the property set to false; otherwise, false.
Returns: . true if a control was activated; otherwise, false.
Returns: .
One of the values.
The new property value of the control.
The new property value of the control.
The new property value of the control.
The new property value of the control.
Returns: .
The new property value of the control.
The new property value of the control.
The new property value of the control.
The new property value of the control.
A bitwise combination of the values. For any parameter not specified, the current value will be used.
Returns: . this control
Returns: .
The property is not null and value is true.
Returns: .
Returns: .
allowFocusChange
Set to true if the validation fails but the container allows the focus to change when the value of is .
checkCausesValidation
Set to true if validation should be performed only when the value of is true. The default is true.
Returns: . true if the active control is validated.
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.
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.
Fired when a drag-drop operation is terminated either by a drop or canceled.
Fired when an object is dragged into the control's bounds.
Fired when an object is dragged out of the control's bounds.
Fired when an object is dragged over the control's bounds.
Fired when a drag-drop operation is started by the user.
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.
Staring from version 3.5.18, the event parameter e is of type which carries additional information about the control that lost the focus and the one that received the focus. To use the new data check the type and cast to .
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.
Fired when a key is pressed while the control has focus.
Fired when a key is released while the control has focus.
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.
Staring from version 3.5.18, the event parameter e is of type which carries additional information about the control that lost the focus and the one that received the focus. To use the new data check the type and cast to .
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.
Fired when the mouse pointer rests on the control.
Fired when the mouse pointer leaves the control.
Fired when the mouse pointer is moved over the control.
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.
Fired when the control's padding changes.
Fired when a UserPaint control needs to redraw itself.
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.
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.
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.
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.
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).
Fired when a touch point is removed from the touch surface.
Fired when a touch point is moved along the touch surface.
Fired when a touch point is placed on the touch surface.
Fired when a pointer grabs an item and moves the pointer on it.
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.
Displays a in which a check box is displayed to the left of each item.
Provides a common implementation of members for the and classes.
Enables the user to select a single option from a group of choices when paired with other controls.
Creates a panel that is associated with a .
Manages a related set of pages.
Represents a single tab page in a .
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 .
Used by the control to display data at run time.
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 display flash applications.
The TreeViewComboBox control represents a control with a as the drop down panel.
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 spinner control that displays values.
The TreeViewComboBox control represents a control with a as the drop down panel.
The UserComboBox control represents a control with a custom panel that drops down when the user clicks the down arrow.
Displays a hierarchical collection of labeled items, each represented by a .
All wisej controls derived from the class must implement this interface.
