v2.5
Wisej.Web
Wisej.Web.VisualBasic
Wisej.Core
Wisej.Base
System
Control
Wisej.Web.Control
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.5.0.0)
Base class for all Wisej controls.
C#
VB.NET
1
public class Control : IWisejControl, IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfiles
Copied!
1
Public Class Control
2
Inherits IWisejControl
3
Implements IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfiles
Copied!
Constructors
Control()
Properties
AccessibleDescription
String: Returns or sets the description that will be reported to accessibility client applications. It is assigned to the "alt" attribute of the browser element.
AccessibleName
String: Returns or sets the name of the control for use by accessibility client applications. It is assigned to the "name" attribute of the browser element.
AccessibleRole
AccessibleRole: Returns or sets the accessible role of the control that will be reported to accessibility client applications. It is assigned to the "role" attribute of the browser element.
AllowDrag
AllowDrop
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.
Anonymous
Boolean: Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents.
BackColor
BackgroundImage
BackgroundImageLayout
ImageLayout: Returns or sets the background image layout as defined in the ImageLayout enumeration.
BackgroundImageSource
BecomingActiveControl
CanExecute
CanFocus
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.
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:
ContainsFocus
ContextMenu
Controls
CssClass
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
You can use any CSS style string.
1
// set the border radius to 100% and make the control round.
2
this.button1.CssStyle = "border-radius:100%";
Copied!
Cursor
DataBindings
DefaultBackColor
DefaultFont
DefaultForeColor
DisplayRectangle
Dock
DockStyle: Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
Enabled
EnableNativeContextMenu
Focusable
Focused
Font
ForeColor
Handle
HasDataBindings
HasResponsiveProfiles
Boolean: Check if the control defines any responsive profile without forcing the creation of the collection.
HasUserData
Height
InitScript
String: Returns or sets an initialization script to execute when the widget is created (or reloaded) in the browser.
1
// change the background color of the internal label of the button widget.
2
this.button1.InitScript = "this.getChildControl('label').setBackgroundColor('red')";
3
4
// attach a JavaScript event handler.
5
this.textBox1.InitScript = @"this.addListener('keydown', function(e) {
6
if (e.getKeyIdentifier() == "PageDown") {
7
alert('You pressed PageDown.');
8
}
9
});
Copied!
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:
IsHandleCreated
IsMirrored
LayoutEngine
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
MaximumSize
MinimumSize
ModifierKeys
Keys: Returns a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
MouseButtons
MousePosition
Movable
Name
Padding
Parent
PreferredSize
ResizableEdges
RightToLeft
RightToLeft: Returns or sets whether the control's elements are aligned right-to-left to support RTL languages.
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.
ShowLoader
Size
States
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.
1
// force the widget to update the UI as if it was hovered and focused.
2
this.button1.States = new [] { "hovered", "focused" };
3
4
// apply a custom state defined in a custom theme or theme mixing.
5
this.panel1.States = new [] { "alert" };
Copied!
In addition to setting this property directly, you can also manage it using the related methods:
TabIndex
TabStop
Tag
Text
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 "
".
ToolTipText
When using ToolTipText property you can only set the ToolTip text and cannot change the default ToolTip icon set in the theme. To change the ToolTip icon you can either create a custom theme, or a theme mixin, or use the ToolTip extender and the ToolTip property added by the extender. You can change the default ForeColor, AutomaticDelay, InitialDelay, AutoPopDelay, or enable HTML in ToolTipText by using a ToolTip extender also without setting the ToolTip property added by the extender.
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.
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.
ValidationCancelled
Visible
WheelDelta
Width
Methods
AddClientEventListener(name, script)
Adds a new listener script to the event name to the client widget.
Returns: Int32. An integer id that you can use to remove the listener from the event using RemoveClientEventListener or to retrieve the listener script code using GetClientEventListener.
The script will execute in the browser when the event name occurs. You can attach multiple listeners to the same event.
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
AddState(state)
Adds the specified theme state to the widget.
Parameter
Type
Description
BeginInvoke(method, args)
Executes the specified delegate asynchronously.
BringToFront()
Brings the control to the front of the z-order.
Call(function, args)
Runs the JavaScript function within the component's context in the browser.
Call(function, callback, args)
Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.
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.
CenterToParent()
Centers the position of the control within the bounds of the parent.
CenterToParent(horizontal, vertical)
Centers the position of the control within the bounds of the parent either horizontally, vertically or both.
Contains(control)
Indicates whether the specified control is a child of this control.
CreateControl()
Creates and register this control and all its children.
DoDragDrop(data, allowedEffects)
Begins a drag-and-drop operation.
Parameter
Type
Description
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
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
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
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
Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.
Eval(javaScript)
Runs the javaScript code within the component's context in the browser.
Parameter
Type
Description
Eval(javaScript, callback)
Runs the javaScript code within the component's context in the browser and returns the value to the callback method.
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
FindForm()
Retrieves the form that the control is on.
FindPage()
Retrieves the page that the control is on.
Focus()
Sets input focus to the control.
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
A Point that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.
skipValue
One of the values of GetChildAtPointSkip, determining whether to ignore child controls of a certain type.
GetChildAtPoint(pt)
Retrieves the child control that is located at the specified coordinates.
GetClientEventListener(id)
Returns the script associated to the listener identified by id .
Parameter
Type
Description
GetClientEventListener(name)
Returns the scripts for all the listeners attached to the event name .
Parameter
Type
Description
GetContainerControl()
GetNextControl(control, forward)
Retrieves the next control forward or back in the tab order of child controls.
GetStyle(flag)
Retrieves the value of the specified control style bit for the control.
Parameter
Type
Description
HasClientEventListener(name)
Checks whether the specified event name has any listener attached.
Parameter
Type
Description
HasCssClass(name)
Parameter
Type
Description
HasState(state)
Parameter
Type
Description
Hide()
Conceals the control from the user.
Invalidate()
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Invalidate(invalidateChildren)
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Parameter
Type
Description
Invoke(method)
Executes the specified delegate.
Parameter
Type
Description
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, on the thread that owns the control's underlying window handle, with the specified list of arguments.
IsMnemonic(charCode, text)
Determines whether the specified character is the mnemonic character.
PointToClient(point)
Computes the location of the specified screen point into client coordinates.
PointToScreen(point)
Computes the location of the specified client point into screen coordinates.
RectangleToClient(rect)
Computes the size and location of the specified screen rectangle in client coordinates.
RectangleToScreen(rect)
Computes the size and location of the specified client rectangle 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 corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.
Parameter
Type
Description
RemoveClientEventListener(id)
Detaches and removes the listener identified by id .
Parameter
Type
Description
Returns: 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
RemoveCssClass(name)
Parameter
Type
Description
RemoveState(state)
Removes the specified theme state from the widget.
Parameter
Type
Description
ResetBindings()
Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values.
ResumeLayout()
Resumes layout logic.
ResumeLayout(performLayout)
Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.
Parameter
Type
Description
ScrollControlIntoView(alignX, alignY)
Scrolls the control into view in the container using the specified alignX and alignY preferences.
Parameter
Type
Description
alignX
Indicates the HorizontalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Center will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement.
alignY
Indicates the VerticalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Middle will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement.
ScrollControlIntoView()
Scrolls the child control into view.
Select()
Activates a control.
SelectNextControl(control, forward, tabStopOnly, nested, wrap)
Activates the next control in the list according to the specified selection rules.
Parameter
Type
Description
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.
SendToBack()
Sends the control to the back of the z-order.