Version: 3.5

Control

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Base class for all Wisej controls.

C#
VB.NET

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

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

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. (Default: null)

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. (Default: null)

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. (Default: Default)

AllowDrag

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

AllowDrop

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

Anchor

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. (Default: Top, Left)

Anonymous

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

AppearanceKey

String: Sets the appearance key for the theme engine. (Default: null)

BackColor

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

BackgroundImage

Image: Returns or sets the background image displayed in the control. (Default: null)

BackgroundImageLayout

ImageLayout: Returns or sets the background image layout as defined in the ImageLayout enumeration. (Default: None)

BackgroundImageSource

String: Returns or sets the background image displayed in the control. (Default: null)

BecomingActiveControl

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

BindingContext

BindingContext: Returns or sets the BindingContext for the control.

Bottom

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

Bounds

Rectangle: Returns or sets the size and location of the control including its non-client area, in pixels and relative to the parent control.

CanExecute

Boolean: Determines whether the control can execute a command.

CanFocus

Boolean: Returns whether the control can receive focus.

CanSelect

Boolean: Returns whether the control can be selected.

Capture

Boolean: Returns or sets whether the control has captured the mouse.

CausesValidation

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

ClientEvents

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:

ClientRectangle

Rectangle: Returns the client rectangle of the control.

ClientSize

Size: Returns or sets the height and width of the client area.

ContainsFocus

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

ContextMenu

ContextMenu: Returns or sets the shortcut menu associated with the control. (Default: null)

Controls

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

Created

Boolean: Returns a value indicating whether the control has been created.

CssClass

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:

CssStyle

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

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

DataBindings

ControlBindingsCollection: Returns the data bindings for the control.

DefaultBackColor

Color: Returns the default background color of the control.

DefaultFont

Font: Returns the default font of the control.

DefaultForeColor

Color: Returns the default background color of the control.

DisplayRectangle

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

Disposing

Boolean: Returns whether the control is in the process of disposing itself and child controls.

Dock

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

Enabled

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

EnableNativeContextMenu

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

Focusable

Boolean: Returns or sets whether the control can gain the focus. (Default: True)

Focused

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

Font

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

ForeColor

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

Handle

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

HasChildren

Boolean: Returns whether the control contains any child control.

HasDataBindings

Boolean: Returns whether the control specifies data bindings.

HasResponsiveProfiles

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

HasUserData

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

Height

Int32: Returns or sets the height of the control.

InitScript

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:

InvokeRequired

Boolean: Returns true when this control belogs to a session different than the currently executing thread.

IsDisposed

Boolean: Returns whether the control has been disposed.

IsHandleCreated

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

IsMirrored

Boolean: Returns whether the control is mirrored.

LayoutEngine

LayoutEngine: Returns the control's layout engine.

Left

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.

Location

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

Margin

Padding: Returns or sets the space between controls.

MaximumSize

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

MinimumSize

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

ModifierKeys

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

MouseButtons

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

MousePosition

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

Movable

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

Name

String: Gets or sets the name of the control.

Padding

Padding: Returns or sets padding within the control.

Parent

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

PreferredSize

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

ResizableEdges

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

ResponsiveProfiles

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

Right

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

RightToLeft

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.

info

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

Selectable

Boolean: 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 Selectable, which corresponds to the Focusable property. When Selectable is set to true, the text of the control (i.e. a label or a button) can be highlighted in the browser and copied to the clipboard. It will also make the widget "focusable" but only in the browser.

ShowLoader

Boolean: Returns or sets whether the control is blocked by the ajax loader. (Default: False)

Size

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

States

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:

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

TabIndex

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

TabStop

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. (Default: True)

Tag

Object: Returns or sets the object that contains data about the control. (Default: null)

Text

String: Returns or sets the text associated with this control. (Default: "")

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

ToolTipText

String: Returns or sets the tooltip text to show for this control. (Default: "")

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 ToolTipText 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 ToolTipText property added by the extender.

Top

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.

TopLevelControl

Control: Returns the parent control that is not parented by another Form. Typically, this is the outermost Form that the control is contained in.

UserData

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

UseWaitCursor

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

ValidationCancelled

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

Visible

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

WheelDelta

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

Width

Int32: Returns or sets the width of the control.

Methods

AddClientEventListener(name, script)

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

Parameter	Type	Description
name	String	Name of the client event to attach the listener to.
script	String	JavaScript code to execute when the event occurs.

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.

AddCssClass(name)

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

Parameter	Type	Description
name	String	Name of the css class to add.

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

AddState(state)

Adds the specified theme state to the widget.

Parameter	Type	Description
state	String	Name of the custom state to add 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.

AddState(state, forward)

Adds the specified theme state to the widget and optionally propagates it to the child components when forward is true. Since 3.5.5

Parameter	Type	Description
state	String	Name of the custom state to add to the widget.
forward	Boolean	true to propagate the state to the widget's child components.

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.

BeginInvoke(method)

Executes the specified delegate asynchronously, in the context of the session that owns the control.

Parameter	Type	Description
method	Delegate	A delegate to a method that takes no parameters.

Returns: IAsyncResult. An IAsyncResult that represents the result of the BeginInvoke operation.

BeginInvoke(method, args)

Executes the specified delegate asynchronously, in the context of the session that owns the control, with the specified list of arguments.

Parameter	Type	Description
method	Delegate	A delegate to a method that takes no parameters.
args	Object[]	An optional array of objects to pass as arguments to the specified method.

Returns: IAsyncResult. An IAsyncResult that represents the result of the asynchronous call.

BringToFront()

Brings the control to the front of the z-order.

Returns: Control.

Call(function, args)

Runs the JavaScript function within the component's context in the browser.

Parameter	Type	Description
function	String	The name of the JavaScript function to execute.
args	Object[]	The arguments to pass to the function.

Returns: Control. this control

Call(function, callback, args)

Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.

Parameter	Type	Description
function	String	The name of the JavaScript function to execute.
callback	Action<Object>	Asynchronous callback method that receives the return value.
args	Object[]	The arguments to pass to the function.

Returns: Control. this control

CallAsync(function, args)

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.

Parameter	Type	Description
function	String	The name of the JavaScript function to execute.
args	Object[]	The arguments to pass to the function.

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

CenterToParent()

Centers the position of the control within the bounds of the parent.

Returns: Control. this control

CenterToParent(horizontal, vertical)

Centers the position of the control within the bounds of the parent either horizontally, vertically or both.

Parameter	Type	Description
horizontal	Boolean	Center horizontally.
vertical	Boolean	Center vertically.

Returns: Control. this control

Contains(control)

Indicates whether the specified control is a child of this control.

Parameter	Type	Description
control	Control	The child Control to find.

Returns: Boolean. true if the specified control is a child of the control; otherwise, false.

CreateControl()

Creates and register this control and all its children.

Returns: Control.

DoDragDrop(data, allowedEffects)

Begins a drag-and-drop operation.

Parameter	Type	Description
data	Object	The data to drag.
allowedEffects	DragDropEffects	One of the DragDropEffects values.

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

DoDragDrop(data, allowedEffects, imageSource)

Begins a drag-and-drop operation.

Parameter	Type	Description
data	Object	The data to drag.
allowedEffects	DragDropEffects	One of the DragDropEffects values.
imageSource	String	The name or URL for an image to use as the drag cursor.

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

DoDragDrop(data, allowedEffects, imageSource, imageSize)

Begins a drag-and-drop operation.

Parameter	Type	Description
data	Object	The data to drag.
allowedEffects	DragDropEffects	One of the DragDropEffects values.
imageSource	String	The name or URL for an image to use as the drag cursor.
imageSize	Size	The size of the drag image specified in imageSource.

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

DoDragDrop(data, allowedEffects, image)

Begins a drag-and-drop operation.

Parameter	Type	Description
data	Object	The data to drag.
allowedEffects	DragDropEffects	One of the DragDropEffects values.
image	Image	An Image to use as the drag cursor.

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

DoDragDrop(data, allowedEffects, image, imageSize)

Begins a drag-and-drop operation.

Parameter	Type	Description
data	Object	The data to drag.
allowedEffects	DragDropEffects	One of the DragDropEffects values.
image	Image	An Image to use as the drag cursor.
imageSize	Size	The size of the drag image specified in image.

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

EndInvoke(asyncResult)

Retrieves the return value from the asynchronous operation represented by asyncResult .

Parameter	Type	Description
asyncResult	IAsyncResult	An IAsyncResult that represents a BeginInvoke operation started on a control.

Returns: Object. The return value from the asynchronous operation.

Eval(javaScript)

Runs the javaScript code within the component's context in the browser.

Parameter	Type	Description
javaScript	String	The JavaScript code to run on the client.

Returns: Control. this control

Eval(javaScript, callback)

Runs the javaScript code within the component's context in the browser and returns the value to the callback method.

Parameter	Type	Description
javaScript	String	The JavaScript code to evaluate on the client.
callback	Action<Object>	Asynchronous callback method that receives the return value.

Returns: Control. this control

EvalAsync(javaScript)

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.

Parameter	Type	Description
javaScript	String	The JavaScript code to evaluate on the client.

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

FindForm()

Retrieves the Form that contains the control.

Returns: Form.

FindPage()

Retrieves the Page that contains the control.

Returns: Page.

Focus()

Sets input focus to the control.

Returns: Boolean. true if the input focus request was successful; otherwise, false.

GetChildAtPoint(pt, skipValue)

Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.

Parameter	Type	Description
pt	Point	A Point that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.
skipValue	GetChildAtPointSkip	One of the values of GetChildAtPointSkip, determining whether to ignore child controls of a certain type.

Returns: Control. The child Control at the specified coordinates.this control

GetChildAtPoint(pt)

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

Parameter	Type	Description
pt	Point	A Point that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.

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

GetClientEventListener(id)

Returns the script associated to the listener identified by id .

Parameter	Type	Description
id	Int32	Id of the listener to retrieve the script for.

Returns: String. JavaScript associated with the listener.

GetClientEventListener(name)

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

Parameter	Type	Description
name	String	Name of the event.

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

GetContainerControl()

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

Returns: IContainerControl. The parent IContainerControl.

GetNextControl(control, forward)

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

Parameter	Type	Description
control	Control	The Control to start the search with.
forward	Boolean	true to search forward in the tab order; false to search backward.

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

GetStyle(flag)

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

Parameter	Type	Description
flag	ControlStyles	The ControlStyles bit to return the value from.

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

HasClientEventListener(name)

Checks whether the specified event name has any listener attached.

Parameter	Type	Description
name	String	Name of the client event to verify.

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

HasCssClass(name)

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

Parameter	Type	Description
name	String	Css class name to verify.

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

HasState(state)

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

Parameter	Type	Description
state	String	Name of the state to check.

Returns: Boolean. True if the widget already has the state .

To check only if a propagated state is present, use HasState("state+");

Hide()

Conceals the control from the user.

Returns: Control.

Invalidate()

Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

Invalidate(invalidateChildren)

Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

Parameter	Type	Description
invalidateChildren	Boolean	When true, invalidates all the children of the control.

Invoke(method)

Executes the specified delegate, in the context of the session that owns the control.

Parameter	Type	Description
method	Delegate	A delegate that contains a method to be called in the control's session context.

Returns: Object. The return value from the delegate being invoked, or null if the delegate has no return value.

Invoke(method, args)

Executes the specified delegate, in the context of the session that owns the control, with the specified list of arguments.

Parameter	Type	Description
method	Delegate	A delegate to a method that takes parameters of the same number and type that are contained in the args parameter.
args	Object[]	An array of objects to pass as arguments to the specified method. This parameter can be null if the method takes no arguments.

Returns: Object. An Object that contains the return value from the delegate being invoked, or null if the delegate has no return value.

IsMnemonic(charCode, text)

Determines whether the specified character is the mnemonic character.

Parameter	Type	Description
charCode	Char	The character to test.
text	String	The string to search.

Returns: Boolean. true if the charCode character is the mnemonic character; otherwise, false.

LayoutChildren(dock, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control using the specified dock style, spaced by spacing pixels.

Parameter	Type	Description
dock	DockStyle	Indicates whether to arrange the Controls horizontally or vertically.
spacing	Int32	Spacing between the Controls.
useMargins	Boolean	When true (default), it will also use the Margin to arrange the controls.
hAlign	HorizontalAlignment	Horizontal alignment when using dock = Fill, or Top, or Bottom.
vAlign	VerticalAlignment	Vertical alignment when using dock = Fill, or Left, Right.

LayoutChildren(dock, viewArea, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control using the specified dock style, spaced by spacing pixels.

Parameter	Type	Description
dock	DockStyle	Indicates whether to arrange the Controls horizontally or vertically.
viewArea	Rectangle	Rectangle limiting the area to arrange the Controls in. If empty, it will use DisplayRectangle.
spacing	Int32	Spacing between the Controls.
useMargins	Boolean	When true (default), it will also use the Margin to arrange the controls.
hAlign	HorizontalAlignment	Horizontal alignment when using dock = Fill, or Top, or Bottom.
vAlign	VerticalAlignment	Vertical alignment when using dock = Fill, or Left, Right.

LayoutChildren(controls, dock, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control using the specified dock style, spaced by spacing pixels.

Parameter	Type	Description
controls	ICollection<Control>	List of child controls to arrange. If null, all the children will be arranged.
dock	DockStyle	Indicates whether to arrange the Controls horizontally or vertically.
spacing	Int32	Spacing between the Controls.
useMargins	Boolean	When true (default), it will also use the Margin to arrange the controls.
hAlign	HorizontalAlignment	Horizontal alignment when using dock = Fill, or Top, or Bottom.
vAlign	VerticalAlignment	Vertical alignment when using dock = Fill, or Left, Right.

LayoutChildren(controls, dock, viewArea, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control using the specified dock style, spaced by spacing pixels.

Parameter	Type	Description
controls	ICollection<Control>	List of child controls to arrange. If null, all the children will be arranged.
dock	DockStyle	Indicates whether to arrange the Controls horizontally or vertically.
viewArea	Rectangle	Rectangle limiting the area to arrange the Controls in. If empty, it will use DisplayRectangle.
spacing	Int32	Spacing between the Controls.
useMargins	Boolean	When true (default), it will also use the Margin to arrange the controls.
hAlign	HorizontalAlignment	Horizontal alignment when using dock = Fill, or Top, or Bottom.
vAlign	VerticalAlignment	Vertical alignment when using dock = Fill, or Left, Right.

LayoutChildren(direction, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control in the specified direction , spaced by spacing pixels.

Parameter	Type	Description
direction	Orientation	Indicates whether to arrange the Controls horizontally or vertically.
spacing	Int32	Spacing between the Controls.
useMargins	Boolean	When true (default), it will also use the Margin to arrange the controls.
hAlign	HorizontalAlignment	Horizontal alignment when using direction = Vertical.
vAlign	VerticalAlignment	Vertical alignment when using direction = Horizontal.

LayoutChildren(direction, viewArea, spacing, useMargins, hAlign, vAlign)

Arranges all the child Control in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .

Parameter	Type	Description
direction	Orientation	Indicates whether to arrange the Controls horizontally or vertically.
viewArea	Rectangle	Rectangle limiting the area to arrange the Controls in. If empty, it will use DisplayRectangle.
spacing	Int32	Spacing between the Controls.
useMargins	Boolean	When true (default), it will also use the Margin to arrange the controls.
hAlign	HorizontalAlignment	Horizontal alignment when using direction = Vertical.
vAlign	VerticalAlignment	Vertical alignment when using direction = Horizontal.

LayoutChildren(controls, direction, spacing, useMargins, hAlign, vAlign)

Arranges the specified child controls in the specified direction , spaced by spacing pixels.

Parameter	Type	Description
controls	ICollection<Control>	List of child controls to arrange. If null, all the children will be arranged.
direction	Orientation	Indicates whether to arrange the controls horizontally or vertically.
spacing	Int32	Spacing between the controls .
useMargins	Boolean	When true (default), it will also use the Margin to arrange the controls.
hAlign	HorizontalAlignment	Horizontal alignment when using direction = Vertical.
vAlign	VerticalAlignment	Vertical alignment when using direction = Horizontal.

Throws:

ArgumentException One of the controls is not a child of this control.

LayoutChildren(controls, direction, viewArea, spacing, useMargins, hAlign, vAlign)

Arranges the specified child controls in the specified direction , spaced by spacing pixels, and constrained within the specified viewArea .

Parameter	Type	Description
controls	ICollection<Control>	List of child controls to arrange. If null, all the children will be arranged.
direction	Orientation	Indicates whether to arrange the controls horizontally or vertically.
viewArea	Rectangle	Rectangle limiting the area to arrange the controls in. If empty, it will use DisplayRectangle.
spacing	Int32	Spacing between the controls .
useMargins	Boolean	When true (default), it will also use the Margin to arrange the controls.
hAlign	HorizontalAlignment	Horizontal alignment when using direction = Vertical.
vAlign	VerticalAlignment	Vertical alignment when using direction = Horizontal.

Throws:

ArgumentException One of the controls is not a child of this control.

PerformLayout()

Forces the control to apply layout logic to all its child controls.

PerformLayout(affectedControl, affectedProperty)

Forces the control to apply layout logic to all its child controls.

Parameter	Type	Description
affectedControl	Control	A Control that represents the recently changed control.
affectedProperty	String	The name of the recently changed property on the control that caused the layout to change.

PointToClient(point)

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

Parameter	Type	Description
point	Point	The screen coordinate Point to convert.

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

PointToScreen(point)

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

Parameter	Type	Description
point	Point	The client coordinate Point to convert.

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

RectangleToClient(rect)

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

Parameter	Type	Description
rect	Rectangle	The screen coordinate Rectangle to convert.

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

RectangleToScreen(rect)

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

Parameter	Type	Description
rect	Rectangle	The client coordinate Rectangle to convert.

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

Refresh()

Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control, including the non-client areas such as the caption of forms or panels.

Refresh(refreshChildren)

Forces the control to update the corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.

Parameter	Type	Description
refreshChildren	Boolean	True to also refresh all the children of this control.

RemoveClientEventListener(id)

Detaches and removes the listener identified by id .

Parameter	Type	Description
id	Int32	Id of the listener to remove.

Returns: Boolean. True if the id specified a valid lister and it was removed; otherwise false if id is invalid.

RemoveClientEventListener(name)

Removes all the listeners attached to the event name .

Parameter	Type	Description
name	String	Name of the event.

Returns: Boolean. True if the event name has any listener that was removed.

RemoveCssClass(name)

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

Parameter	Type	Description
name	String	The css class name to remove.

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

RemoveState(state)

Removes the specified theme state from the widget.

Parameter	Type	Description
state	String	Name of the state to remove.

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.

RemoveState(state, forward)

Removes the specified theme state from the widget. Since 3.5.5

Parameter	Type	Description
state	String	Name of the state to remove.
forward	Boolean	true to remove the state to the widget's child components.

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.

ResetBindings()

Removes all the data bindings from the control.

Returns: Control.

ResumeLayout()

Resumes layout logic.

ResumeLayout(performLayout)

Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.

Parameter	Type	Description
performLayout	Boolean	true to apply all pending layout requests; otherwise, false.

ScrollControlIntoView(alignX, alignY)

Scrolls the control into view in the container using the specified alignX and alignY preferences.

Parameter	Type	Description
alignX	HorizontalAlignment	Indicates the HorizontalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Center will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement.
alignY	VerticalAlignment	Indicates the VerticalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Middle will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement.

Returns: Control. this control

ScrollControlIntoView()

Scrolls the child control into view.

Returns: Control. this control

Select()

Activates, including setting the focus, a control.

Returns: Control.

SelectNextControl(control, forward, tabStopOnly, nested, wrap)

Activates the next control in the list according to the specified selection rules.

Parameter	Type	Description
control	Control	The Control at which to start the search.
forward	Boolean	true to move forward in the tab order; false to move backward in the tab order.
tabStopOnly	Boolean	true to ignore the controls with the TabStop property set to false; otherwise, false.
nested	Boolean	true to include nested (children of child controls) child controls; otherwise, false.
wrap	Boolean	true to continue searching from the first control in the tab order after the last control has been reached; otherwise, false.

Returns: Boolean. true if a control was activated; otherwise, false.

SendToBack()

Sends the control to the back of the z-order.

Returns: Control.

SetBounds(x, y, width, height)

Sets the bounds of the control to the specified location and size.

Parameter	Type	Description
x	Int32	The new Left property value of the control.
y	Int32	The new Top property value of the control.
width	Int32	The new Width property value of the control.
height	Int32	The new Height property value of the control.

Returns: Control.

SetBounds(x, y, width, height, specified)

Sets the specified bounds of the control to the specified location and size.

Parameter	Type	Description
x	Int32	The new Left property value of the control.
y	Int32	The new Top property value of the control.
width	Int32	The new Width property value of the control.
height	Int32	The new Height property value of the control.
specified	BoundsSpecified	A bitwise combination of the BoundsSpecified values. For any parameter not specified, the current value will be used.

Returns: Control. this control

Show()

Displays the control to the user.

Returns: Control.

SuspendLayout()

Suspends the layout logic for the control.

Update()

Causes the control to update the corresponding client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

ValidateChildren()

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. true if all of the children validated successfully; otherwise, false. If called from the Validating or Validated event handlers, this method will always return false.

ValidateChildren(flags)

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

Parameter	Type	Description
flags	ValidationConstraints

Returns: Boolean. true if all of the children validated successfully; otherwise, false. If called from the Validating or Validated event handlers, this method will always return false.

Events

Appear

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.

AutoSizeChanged

EventHandler Fired when the AutoSize property value changes.

BackColorChanged

EventHandler Fired when the value of the BackColor property changes.

BackgroundImageChanged

EventHandler Fired when the value of the BackgroundImage property changes.

BackgroundImageLayoutChanged

EventHandler Fired when the BackgroundImageLayout property changes.

BecomingActiveControlChanged

EventHandler Fired when the value of the BecomingActiveControl property changes.

BindingContextChanged

EventHandler Occurs when the value of the BindingContext property changes.

CausesValidationChanged

EventHandler Fired when the value of the CausesValidation property changes.

Click

EventHandler Fired when the control is clicked.

ClientSizeChanged

EventHandler Fired when the ClientSize property value changes.

ContextMenuChanged

EventHandler Fired when the value of the ContextMenu property changes.

ControlAdded

ControlEventHandler Fired when a new control is added to the ControlCollection.

ControlCreated

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

ControlRemoved

ControlEventHandler Fired when a control is removed from the ControlCollection.

CursorChanged

EventHandler Fired when the value of the Cursor property changes.

Disappear

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

Disposed

EventHandler Fired when the component is disposed.

DockChanged

EventHandler Fired when the value of the Dock property changes.

DoubleClick

EventHandler Fired when the control is double-clicked.

DragDrop

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.

DragEnd

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

DragEnter

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

DragLeave

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

DragOver

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

DragStart

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

EnabledChanged

EventHandler Fired when the Enabled property value has changed.

EndMove

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.

EndResize

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.

Enter

EventHandler Fired when the control gains the input focus.

FontChanged

EventHandler Fired when the Font property value changes.

ForeColorChanged

EventHandler Fired when the ForeColor property value changes.

GotFocus

EventHandler Fired when the control gains the focus.

HelpRequested

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

ImeModeChanged

EventHandler Fired when the ImeMode property has changed.

KeyDown

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

KeyPress

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

KeyUp

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

Layout

LayoutEventHandler Fired when a control should reposition its child controls.

Leave

EventHandler Fired when the control loses the input focus.

LocationChanged

EventHandler Fired when the Location property value has changed.

LongTap

EventHandler Fired when a pointer holds on the screen.

LostFocus

EventHandler Fired when the control loses focus.

MarginChanged

EventHandler Fired when the control's margin changes.

MouseCaptureChanged

EventHandler Fired when the control loses mouse capture.

MouseClick

MouseEventHandler Fired when the control is clicked by the mouse.

MouseDoubleClick

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

MouseDown

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

MouseEnter

EventHandler Fired when the mouse pointer enters the control.

MouseHover

EventHandler Fired when the mouse pointer rests on the control.

MouseLeave

EventHandler Fired when the mouse pointer leaves the control.

MouseMove

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

MouseUp

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

MouseWheel

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

PaddingChanged

EventHandler Fired when the control's padding changes.

Paint

PaintEventHandler Fired when a UserPaint control needs to redraw itself.

ParentChanged

EventHandler Fired when the Parent property value changes.

Pinch

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

PreviewKeyDown

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

QueryContinueDrag

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

Resize

EventHandler Fired when the control is resized.

ResponsiveProfileChanged

ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.

RightToLeftChanged

EventHandler Fired when the RightToLeft property value changes.

Rotate

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

SizeChanged

EventHandler Fired when the Size property value changes.

StartMove

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.

StartResize

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.

StyleChanged

EventHandler Fired when the control style changed.

Swipe

SwipeEventHandler Fired when a pointer swipes over the screen.

TabIndexChanged

EventHandler Fired when the TabIndex property value has changed.

TabStopChanged

EventHandler Fired when the value of the TabStop property changes.

Tap

EventHandler Fired when a pointer taps on the screen.

TextChanged

EventHandler Fired when the Text property value changes.

TouchCancel

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

TouchEnd

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

TouchMove

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

TouchStart

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

Track

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

Validated

EventHandler Fired when the control is finished validating.

Validating

CancelEventHandler Fired when the control is validating.

VisibleChanged

EventHandler Fired when the Visible property value changes.

WidgetEvent

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

Name	Description
TableLayoutPanel	Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.
FileDialogUI	UI implementation for the FileDialog class.
FolderBrowserDialogUI	UI implementation for the FolderDialog class.
BindingNavigator	Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.
Button	Represents a button control.
ButtonBase	Implements the basic functionality common to button controls.
CheckBox	Represents a check box control.
CheckedListBox	Displays a ListBox in which a check box is displayed to the left of each item.
ComboBox	Represents a combo box control.
ContainerControl	Provides focus-management functionality for controls that can function as a container for other controls.
DateTimePicker	Represents a control that allows the user to select or type a date and a time.
DomainUpDown	Represents a spinner control that displays string values.
FlowLayoutPanel	Represents a panel that dynamically arranges its controls horizontally or vertically in automatic rows or columns.
Form	Represents a window or dialog box that makes up an application's user interface.
GroupBox	Represents a Wisej control that displays a frame around a group of controls with an optional caption.
Label	Represents a label control.
LinkLabel	Represents an hyper-link control.
ListBox	Represents a control to display a list of items.
ListControl	Provides a common implementation of members for the ListBox and ComboBox classes.
MaskedTextBox	Uses a mask to distinguish between proper and improper user input.
MdiClient	Represents the container for multiple-document interface (MDI) child forms.
MonthCalendar	Represents a control that enables the user to select a date using a visual monthly calendar display.
NumericUpDown	Represents a spinner control that displays numeric values.
Page	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.
Panel	Represents a collapsible panel with an optional header that contains a group of controls.
PictureBox	Represents an image control.
ProgressBar	Represents a progress control that displays a value visually as a filled bar.
RadioButton	Enables the user to select a single option from a group of choices when paired with other RadioButton controls.
ScrollableControl	Defines a base class for controls that support auto-scrolling behavior.
HScrollBar	Represents an horizontal scroll bar.
VScrollBar	Represents a vertical scroll bar.
ScrollBar	Implements the basic functionality of a scroll bar control.
SplitContainer	Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.
SplitterPanel	Creates a panel that is associated with a SplitContainer.
TabControl	Manages a related set of TabPage pages.
TabPage	Represents a single tab page in a TabControl.
TextBox	Represents a text box control that allows the user to enter any value.
TextBoxBase	Implements the basic functionality required by text controls.
TrackBar	Enables the user to choose between a range of values by sliding a small bar along another bar.
UpDownBase	Implements the basic functionality required by a spin box (also known as an up-down control).
UserControl	Provides an empty control that can be used to create other controls.
WebBrowser	Represents a web browser control that enables the user to navigate web pages inside a form or a page.
DataGridViewComboBoxEditingControl	Represents a ComboBox control that can be hosted in a DataGridViewComboBoxCell.
DataGridViewDateTimePickerEditingControl	Represents a DateTimePicker control that can be hosted in a DataGridViewDateTimePickerCell.
DataGridViewMaskedTextBoxEditingControl	Represents a MaskedTextBox control that can be hosted in a DataGridViewMaskedTextBoxCell cell.
DataGridViewNumericUpDownEditingControl	Represents a NumericUpDown control that can be hosted in a DataGridViewNumericUpDownCell.
DataGridViewTextBoxEditingControl	Represents a TextBox control that can be hosted in a DataGridViewTextBoxCell cell when the cell's WrapMode is set to False.
DataGridView	Represents a data grid control.
DataRepeater	Displays data in a customizable list format.
DataRepeaterItem	Used by the DataRepeater control to display data at run time.
Desktop	Represents a desktop container that can host floating windows.
Accordion	Displays collapsible set of AccordionPanel panels for presenting information in a limited amount of space.
AccordionPanel	Represents a panel in a Accordion control.
AspNetPanel	Represents a control that can host ASP.NET or MVC pages within a Wisej application.
Canvas	Represents the HTML5 canvas element.
FlashPlayer	Represents a FlashPlayer control that can display flash applications.
FlexLayoutPanel	Represents a panel that dynamically arranges its child controls.
HtmlPanel	Represents a control that displays any HTML file and a corresponding CSS style sheet as embedded HTML.
IFramePanel	Represents a control that displays any HTML file in an IFrame element.
Line	Represents a line control.
ListViewComboBox	The TreeViewComboBox control represents a UserComboBox control with a ListView as the drop down panel.
Media	Base implementation for media controls.
Video	Represents a Video control that displays a video file.
Audio	Represents a Audio control that plays an audio file.
PdfViewer	Represents a PdfViewer 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.
Shape	Represents a shape control. Displays an element a border in any of the four sides.
SlideBar	Displays child controls vertically or horizontally in a scrollable container.
Spacer	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.
SplitButton	Represents a split button control.
TagTextBox	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.
TimeUpDown	Represents a spinner control that displays TimeSpan values.
TreeViewComboBox	The TreeViewComboBox control represents a UserComboBox control with a TreeView as the drop down panel.
TypedTextBox	Represents a text box control that allows the user to enter a typed value.
Upload	Represent an upload widget. Allows users to selected one or more files and upload them to the server.
UserComboBox	The UserComboBox control represents a ComboBox control with a custom panel that drops down when the user clicks the down arrow.
UserPopup	Provides an popup container that can be attached to other controls.
Widget	Provides a generic widget that can use most third party javascript widgets.
ListView	Represents a list view control, which displays a collection of items that can be displayed using one of four different views.
MenuBar	Represents a menu bar component.
PropertyGrid	Provides a user interface for browsing the properties of an object.
StatusBar	Displays information to the user in a about the object being viewed, the object's components, or the object's operation.
ToolBar	Represents a toolbar component.
TreeView	Displays a hierarchical collection of labeled items, each represented by a TreeNode.

Implements

Name	Description
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.

Constructors​

Control()​

Properties​

AccessibleDescription​

AccessibleName​

AccessibleRole​

AllowDrag​

AllowDrop​

Anchor​

Anonymous​

AppearanceKey​

BackColor​

BackgroundImage​

BackgroundImageLayout​

BackgroundImageSource​

BecomingActiveControl​

BindingContext​

Bottom​

Bounds​

CanExecute​

CanFocus​

CanSelect​

Capture​

CausesValidation​

ClientEvents​

ClientRectangle​

ClientSize​

ContainsFocus​

ContextMenu​

Controls​

Created​

CssClass​

CssStyle​

Cursor​

DataBindings​

DefaultBackColor​

DefaultFont​

DefaultForeColor​

DisplayRectangle​

Disposing​

Dock​

Enabled​

EnableNativeContextMenu​

Focusable​

Focused​

Font​

ForeColor​

Handle​

HasChildren​

HasDataBindings​

HasResponsiveProfiles​

HasUserData​

Height​

InitScript​

InvokeRequired​

IsDisposed​

IsHandleCreated​

IsMirrored​

LayoutEngine​

Left​

Location​

Margin​

MaximumSize​

MinimumSize​

ModifierKeys​

MouseButtons​

MousePosition​

Movable​

Name​

Padding​

Parent​

PreferredSize​

ResizableEdges​

ResponsiveProfiles​

Right​

RightToLeft​

Selectable​

ShowLoader​

Size​

States​

Constructors

Control()

Properties

AccessibleDescription

AccessibleName

AccessibleRole

AllowDrag

AllowDrop

Anchor

Anonymous

AppearanceKey

BackColor

BackgroundImage

BackgroundImageLayout

BackgroundImageSource

BecomingActiveControl

BindingContext

Bottom

Bounds

CanExecute

CanFocus

CanSelect

Capture

CausesValidation

ClientEvents

ClientRectangle

ClientSize

ContainsFocus

ContextMenu

Controls

Created

CssClass

CssStyle

Cursor

DataBindings

DefaultBackColor

DefaultFont

DefaultForeColor

DisplayRectangle

Disposing

Dock

Enabled

EnableNativeContextMenu

Focusable

Focused

Font

ForeColor

Handle

HasChildren

HasDataBindings

HasResponsiveProfiles

HasUserData

Height

InitScript

InvokeRequired

IsDisposed

IsHandleCreated

IsMirrored

LayoutEngine

Left

Location

Margin

MaximumSize

MinimumSize

ModifierKeys

MouseButtons

MousePosition

Movable

Name

Padding

Parent

PreferredSize

ResizableEdges

ResponsiveProfiles

Right

RightToLeft

Selectable

ShowLoader

Size

States