ComboBox
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.0.0.0)
Represents a combo box control.
- C#
- VB.NET
public class ComboBox : ListControl, IModified, ILabel, IReadOnly
Public Class ComboBox
Inherits ListControl
Implements IModified, ILabel, IReadOnly
Constructors
ComboBox()
Initializes an instance of ComboBox.
Properties
AllowHtml
Boolean: Returns or sets a value indicating that the control can display html in the Text property.
AutoCompleteMode
AutoCompleteMode: Returns or sets how automatic completion works for the ComboBox.
AutoSize
Boolean: Returns or sets whether the height of the control is set automatically.
CharacterCasing
CharacterCasing: Returns or sets whether the ComboBox control modifies the case of characters as they are typed.
DropDownHeight
Int32: Returns or sets the maximum height in pixels of the drop-down portion of the ComboBox.
Throws:
- ArgumentException The specified value is less than one.
DropDownStyle
ComboBoxStyle: Returns or sets the drop down style of the combo box.
DropDownWidth
Int32: Returns or sets the maximum width in pixels of the drop-down list of the ComboBox. When the value is 0, the drop-down list will grow to fit the largest item.
Throws:
- ArgumentException The specified value is less than one.
DroppedDown
Boolean: Returns or sets whether the combo box is displaying its drop-down portion.
EnableNativeContextMenu
Boolean: Enables or disables the browser's context menu.
IncrementalSelection
Boolean: Returns or sets whether items are selected incrementally as the user types within a timeout of 1 second.
ItemHeight
Int32: Gets or sets the height of the list items in the drop-down list. When the value is -1, uses the value set in the theme.
Throws:
- ArgumentOutOfRangeException The assigned value is less than -1; or the assigned value is greater than 500.
Items
ObjectCollection: Returns the collection of the items contained in this ComboBox.
Label
LabelWrapper: Provides a label related to the control.
LabelText
String: Returns or sets the localizable label associated with this control.
LazyLoading
Boolean: Returns or sets whether the items are sent to the client the first time the list is opened and enables the Load event.
MaxLength
Int32: Returns or sets the number of characters a user can type into the ComboBox.
Throws:
- ArgumentOutOfRangeException The value is less than 0.
ReadOnly
Boolean: Returns or sets whether the control is read-only.
SelectedIndex
Int32: Returns or sets the index of the currently selected item.
Throws:
- ArgumentOutOfRangeException The specified index is less than -1; o the specified index is greater than the number of items in the combo box.
SelectedItem
Object: Returns or sets currently selected item in the ComboBox.
SelectedText
String: Returns or sets the text that is selected in the editable portion of a ComboBox.
SelectionLength
Int32: Returns or sets the number of characters selected in the editable portion of the combo box.
Throws:
- ArgumentException The value was less than zero.
SelectionStart
Int32: Returns or sets the starting index of text selected in the combo box.
Throws:
- ArgumentException The value is less than zero.
Sorted
Boolean: Returns or sets whether the items in the combo box are sorted.
Throws:
- ArgumentException An attempt was made to sort a ComboBox that is attached to a data source.
SpellCheck
Boolean: Returns or sets whether the text in the ComboBox is spell checked by the browser.
Text
String: Returns or sets the text associated with this control.
Tools
ComponentToolCollection: Returns the instance of ComponentToolContainer associated with this control.
Watermark
String: Returns or sets the text to show when the control is empty.
Methods
BeginUpdate()
Not used. Kept for compatibility.
Copy()
Copies the current selection in the text box to the Clipboard.
Cut()
Moves the current selection in the text box to the Clipboard.
EndUpdate()
Not used. Kept for compatibility.
FindString(text)
Returns the index of the first item in the ComboBox that starts with the specified string.
| Parameter | Type | Description |
|---|---|---|
| text | String | The String to search for. |
Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found.
FindString(text, startIndex)
Returns the index of the first item in the ComboBox beyond the specified index that contains the specified string. The search is not case sensitive.
| Parameter | Type | Description |
|---|---|---|
| text | String | The String to search for. |
| startIndex | Int32 | The zero-based index of the item before the first item to be searched. Set to -1 to search from the beginning of the control. |
Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies Empty.
FindStringExact(text)
Finds the first item in the combo box that matches the specified string.
| Parameter | Type | Description |
|---|---|---|
| text | String | The String to search for. |
Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies Empty.
FindStringExact(text, startIndex)
Finds the first item after the specified index that matches the specified string.
| Parameter | Type | Description |
|---|---|---|
| text | String | The String to search for. |
| startIndex | Int32 | The zero-based index of the item before the first item to be searched. Set to -1 to search from the beginning of the control. |
Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies Empty.
Paste()
Replaces the current selection in the text box with the contents of the Clipboard.
Select(start, length)
Selects a range of text in the editable portion of the ComboBox.
| Parameter | Type | Description |
|---|---|---|
| start | Int32 | The position of the first character in the current text selection within the text box. |
| length | Int32 | The number of characters to select. |
SelectAll()
Selects all the text in the editable portion of the ComboBox.
Events
AutoComplete
HandledEventHandler Fired when before the Validating event when the DropDownStyle is set to DropDown or Simple.
The application may implement a different way to select the item when the user types a text and the ComboBox is validated. Set e.Handled to true to override the standard behavior.
this.comboBox1.AutoComplete += (s, e) =>
{
if (this.comboBox1.Text == "T")
{
this.compoBox1.SelectedIndex = 1;
e.Handled = true;
}
}
DropDown
EventHandler Fired when the drop-down portion of a ComboBox is shown.
DropDownClosed
EventHandler Fired when the drop-down portion of the ComboBox is no longer visible.
DropDownStyleChanged
EventHandler Fired when the DropDownStyle property has changed.
Load
EventHandler Fired when the drop-down list is first opened and the LazyLoading property is true.
When LazyLoading is true An application may fill the items at any time prior to the drop-down list being opened, or while processing the DropDown or Load event.
ReadOnlyChanged
EventHandler Fired when the value of the ReadOnly property has changed.
SelectedIndexChanged
EventHandler Fired when the SelectedIndex property has changed.
SelectedItemChanged
EventHandler Fired when the SelectedItem property has changed.
SelectionChangeCommitted
EventHandler Fired when the selected item has changed and that change is displayed in the ComboBox.
SortedChanged
EventHandler Fired when the Sorted property has changed.
ToolClick
ToolClickEventHandler Fired when a ComponentTool is clicked.
Inherited
Properties
| Name | Description | From |
|---|---|---|
| AccessibleDescription | Returns or sets the description that will be reported to accessibility client applications. It is assigned to the "alt" attribute of the browser element. | Control |
| AccessibleName | 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. | Control |
| 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. | Control |
| AllowDrag | Returns or sets whether the control can initiate a drag-drop operation. | Control |
| AllowDrop | Returns or sets whether the control can accept data that the user drags onto it. | Control |
| Anchor | Returns or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. | Control |
| Anonymous | Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents. | Control |
| AppearanceKey | Sets the appearance key for the theme engine. | Control |
| BackColor | Returns or sets the background color for the control. | Control |
| BackgroundImage | Returns or sets the background image displayed in the control. | Control |
| BackgroundImageLayout | Returns or sets the background image layout as defined in the ImageLayout enumeration. | Control |
| BackgroundImageSource | Returns or sets the background image displayed in the control. | Control |
| BecomingActiveControl | Returns a flag indicating that the control is becoming the active control. | Control |
| BindingContext | Returns or sets the BindingContext for the control. | Control |
| BorderStyle | Returns or sets the type of border that is drawn around the ListControl. | ListControl |
| Bottom | Returns the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. | Control |
| Bounds | Returns or sets the size and location of the control including its non-client area, in pixels and relative to the parent control. | Control |
| CanExecute | Determines whether the control can execute a command. | Control |
| CanFocus | Returns whether the control can receive focus. | Control |
| CanSelect | Returns whether the control can be selected. | Control |
| Capture | Returns or sets whether the control has captured the mouse. | Control |
| CausesValidation | Returns or sets whether the control causes validation to be performed on controls that require to be validated when this control receives focus. | Control |
| ClientEvents | Returns a collection of client events and JavaScript listeners. You may attach multiple listeners to same event. | Control |
| ClientRectangle | Returns the client rectangle of the control. | Control |
| ClientSize | Returns or sets the height and width of the client area. | Control |
| ContainsFocus | Indicates whether the control, or one of its child controls, has the input focus. | Control |
| ContextMenu | Returns or sets the shortcut menu associated with the control. | Control |
| Controls | Returns the collection of controls contained within the control. | Control |
| Created | Returns a value indicating whether the control has been created. | Control |
| CssClass | Returns or sets additional CSS class names to add to the widget. | Control |
| CssStyle | Returns or sets the custom CSS styles to add to the widget. | Control |
| Cursor | Returns or sets the cursor that is displayed when the mouse pointer is over the control. | Control |
| DataBindings | Returns the data bindings for the control. | Control |
| DataSource | Returns or sets the data source for this ListControl. | ListControl |
| DisplayMember | Returns or sets the property to display for this ListControl. | ListControl |
| DisplayRectangle | Returns the rectangle that represents the virtual display area of the control. | Control |
| Disposing | Returns whether the control is in the process of disposing itself and child controls. | Control |
| Dock | Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent. | Control |
| Enabled | Returns or sets whether the control can respond to user interaction. | Control |
| Focusable | Returns or sets whether the control can gain the focus. | Control |
| Focused | Returns a value indicating whether the control has input focus. | Control |
| Font | Gets or sets the font of the text displayed by the control. | Control |
| ForeColor | Returns or sets the text color of the control. | Control |
| FormatInfo | Returns or sets the IFormatProvider that provides custom formatting behavior. | ListControl |
| FormatString | Returns or sets the format-specifier characters that indicate how a value is to be displayed. | ListControl |
| FormattingEnabled | Returns or sets whether formatting is applied to the DisplayMember property of the ListControl. | ListControl |
| Handle | Returns the unique server-side id (handle) for this component. | Control |
| HasChildren | Returns whether the control contains any child control. | Control |
| HasDataBindings | Returns whether the control specifies data bindings. | Control |
| HasResponsiveProfiles | Check if the control defines any responsive profile without forcing the creation of the collection. | Control |
| HasUserData | Checks if the UserData dynamic object was created and has any value. | Control |
| Height | Returns or sets the height of the control. | Control |
| IconMember | Returns or sets the property to use as the icon for the items in the ListControl. | ListControl |
| InitScript | Returns or sets an initialization script to execute when the widget is created (or reloaded) in the browser. | Control |
| Invalid | Returns or sets a value that indicates that the control is invalid. | ListControl |
| InvalidMessage | Returns or sets the invalid message that is shown in the invalid tooltip. | ListControl |
| IsDisposed | Returns whether the control has been disposed. | Control |
| IsHandleCreated | Returns if the control has a server-side component id (handle) associated with it. | Control |
| IsMirrored | Returns whether the control is mirrored. | Control |
| LayoutEngine | Returns the control's layout engine. | Control |
| Left | Returns or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area. | Control |
| Location | Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. | Control |
| Margin | Returns or sets the space between controls. | Control |
| MaximumSize | Returns or sets the maximum size for the control. | Control |
| MinimumSize | Returns or sets the minimum size for the control. | Control |
| Modified | Returns or sets a value that indicates that the control has been modified by the user since the control was created or its contents were last set. | ListControl |
| Movable | Returns or sets whether the control can be moved by dragging. | Control |
| Name | Gets or sets the name of the control. | Control |
| Parent | Returns or sets the parent container of the control. | Control |
| PreferredSize | Returns the preferred size in which the control can fit. | Control |
| PrefetchItems | Returns or sets the number of items to prefetch outside of the visible area when VirtualScroll is set to true. The default is 0 (disabled). | ListControl |
| ResizableEdges | Returns or sets the edges of the control that can be dragged to resize the control. | Control |
| ResponsiveProfiles | Returns the collection of responsive properties that have been set for this control. | Control |
| Right | Return the distance, in pixels, between the right edge of the control and the left edge of its container's client area. | Control |
| RightToLeft | Returns or sets whether the control's elements are aligned right-to-left to support RTL languages. | Control |
| SelectedValue | Returns or sets the value of the member property specified by the ValueMember property. | ListControl |
| ShowLoader | Returns or sets whether the control is blocked by the ajax loader. | Control |
| ShowToolTips | Returns or sets whether to show tooltips (set using ToolTipMember) for the list items. | ListControl |
| Size | Returns or sets the height and width of the control. | Control |
| States | Returns or sets additional theme states to the client widget. | Control |
| TabIndex | Returns or sets the tab order of the control within its container. | Control |
| TabStop | 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. | Control |
| Tag | Returns or sets the object that contains data about the control. | Control |
| ToolTipMember | Returns or sets the property to use as the tooltip for the items in the ListControl, when the property ShowToolTips is set to true. | ListControl |
| ToolTipText | Returns or sets the tooltip text to show for this control. | Control |
| Top | Returns or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area. | Control |
| TopLevelControl | Returns the parent control that is not parented by another Form. Typically, this is the outermost Form that the control is contained in. | Control |
| UserData | Returns a dynamic object that can be used to store custom data in relation to this control. | Control |
| UseWaitCursor | Returns or sets whether to use the wait cursor for the current control and all child controls. | Control |
| ValidationCancelled | Returns a flag indicating that the validation has been canceled. | Control |
| ValueMember | Returns or sets the property to use as the actual value for the items in the ListControl. | ListControl |
| VirtualScroll | Enables or disables virtual scrolling for the ListControl. When virtual scrolling is enabled, only the visible items are rendered in the browser allowing the ListControl to host virtually unlimited items without any performance loss. | ListControl |
| Visible | Returns or sets whether the control and all its child controls are displayed. | Control |
| Width | Returns or sets the width of the control. | Control |
Methods
| Name | Description | From |
|---|---|---|
| AddClientEventListener(name, script) | Adds a new listener script to the event name to the client widget. | Control |
| AddCssClass(name) | Adds the CSS class name to the widget element. If the class already exists in the CssClass it's not added. | Control |
| AddState(state) | Adds the specified theme state to the widget. | Control |
| Append(data) | Populates the ListControl from the data appending the items to the existing items. | ListControl |
| BeginInvoke(method) | Executes the specified delegate asynchronously. | Control |
| BeginInvoke(method, args) | Executes the specified delegate asynchronously. | Control |
| BringToFront() | Brings the control to the front of the z-order. | Control |
| Call(function, args) | Runs the JavaScript function within the component's context in the browser. | 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. | 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. | Control |
| CenterToParent() | Centers the position of the control within the bounds of the parent. | Control |
| CenterToParent(horizontal, vertical) | Centers the position of the control within the bounds of the parent either horizontally, vertically or both. | Control |
| Contains(control) | Indicates whether the specified control is a child of this control. | Control |
| CreateControl() | Creates and register this control and all its children. | Control |
| DoDragDrop(data, allowedEffects) | Begins a drag-and-drop operation. | Control |
| DoDragDrop(data, allowedEffects, imageSource) | Begins a drag-and-drop operation. | Control |
| DoDragDrop(data, allowedEffects, imageSource, imageSize) | Begins a drag-and-drop operation. | Control |
| DoDragDrop(data, allowedEffects, image) | Begins a drag-and-drop operation. | Control |
| DoDragDrop(data, allowedEffects, image, imageSize) | Begins a drag-and-drop operation. | Control |
| EndInvoke(asyncResult) | Retrieves the return value from the asynchronous operation represented by asyncResult . | Control |
| Eval(javaScript) | Runs the javaScript code within the component's context in the browser. | Control |
| Eval(javaScript, callback) | Runs the javaScript code within the component's context in the browser and returns the value to the callback method. | 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. | Control |
| Fill(data) | Populates the ListControl from the data . | ListControl |
| FindForm() | Retrieves the form that the control is on. | Control |
| FindPage() | Retrieves the page that the control is on. | Control |
| Focus() | Sets input focus to the control. | 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. | Control |
| GetChildAtPoint(pt) | Retrieves the child control that is located at the specified coordinates. | Control |
| GetClientEventListener(id) | Returns the script associated to the listener identified by id . | Control |
| GetClientEventListener(name) | Returns the scripts for all the listeners attached to the event name . | Control |
| GetContainerControl() | Returns the next IContainerControl up the control's chain of parents. | Control |
| GetItemIcon(item) | Returns the icon object, either an instance of Image or a String representing the icon name or URL, of the specified item. | ListControl |
| GetItemText(item) | Returns the text representation of the specified item. | ListControl |
| GetItemToolTip(item) | Returns the tooltip text related to the object. | ListControl |
| GetNextControl(control, forward) | Retrieves the next control forward or back in the tab order of child controls. | Control |
| GetStyle(flag) | Retrieves the value of the specified control style bit for the control. | Control |
| HasClientEventListener(name) | Checks whether the specified event name has any listener attached. | Control |
| HasCssClass(name) | Returns true if the property CssClass contains the specified class name . | Control |
| HasState(state) | Checks whether the specified theme state is present in the States property. | Control |
| Hide() | Conceals the control from the user. | 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. | Control |
| 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. | Control |
| Invoke(method) | Executes the specified delegate. | Control |
| Invoke(method, args) | Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. | Control |
| LayoutChildren(dock, spacing, useMargins, hAlign, vAlign) | Arranges all the child Control using the specified dock style, spaced by spacing pixels. | Control |
| LayoutChildren(dock, viewArea, spacing, useMargins, hAlign, vAlign) | Arranges all the child Control using the specified dock style, spaced by spacing pixels. | Control |
| LayoutChildren(controls, dock, spacing, useMargins, hAlign, vAlign) | Arranges all the child Control using the specified dock style, spaced by spacing pixels. | Control |
| LayoutChildren(controls, dock, viewArea, spacing, useMargins, hAlign, vAlign) | Arranges all the child Control using the specified dock style, spaced by spacing pixels. | Control |
| LayoutChildren(direction, spacing, useMargins, hAlign, vAlign) | Arranges all the child Control in the specified direction , spaced by spacing pixels. | Control |
| 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 . | Control |
| LayoutChildren(controls, direction, spacing, useMargins, hAlign, vAlign) | Arranges the specified child controls in the specified direction , spaced by spacing pixels. | 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 . | Control |
| PerformLayout() | Forces the control to apply layout logic to all its child controls. | Control |
| PerformLayout(affectedControl, affectedProperty) | Forces the control to apply layout logic to all its child controls. | Control |
| PointToClient(point) | Computes the location of the specified screen point into client coordinates. | Control |
| PointToScreen(point) | Computes the location of the specified client point into screen coordinates. | Control |
| RectangleToClient(rect) | Computes the size and location of the specified screen rectangle in client coordinates. | Control |
| RectangleToScreen(rect) | Computes the size and location of the specified client rectangle in screen coordinates. | Control |
| 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. | Control |
| 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. | Control |
| RemoveClientEventListener(id) | Detaches and removes the listener identified by id . | Control |
| RemoveClientEventListener(name) | Removes all the listeners attached to the event name . | Control |
| RemoveCssClass(name) | Removes the specified css class name from the control's CssClass property. | Control |
| RemoveState(state) | Removes the specified theme state from the widget. | Control |
| ResetBindings() | Removes all the data bindings from the control. | Control |
| ResumeLayout() | Resumes layout logic. | Control |
| ResumeLayout(performLayout) | Resumes layout logic, optionally forcing an immediate layout of all pending layout requests. | Control |
| ScrollControlIntoView(alignX, alignY) | Scrolls the control into view in the container using the specified alignX and alignY preferences. | Control |
| ScrollControlIntoView() | Scrolls the child control into view. | Control |
| Select() | Activates a control. | Control |
| SelectNextControl(control, forward, tabStopOnly, nested, wrap) | Activates the next control in the list according to the specified selection rules. | Control |
| SendToBack() | Sends the control to the back of the z-order. | Control |
| SetBounds(x, y, width, height) | Sets the bounds of the control to the specified location and size. | Control |
| SetBounds(x, y, width, height, specified) | Sets the specified bounds of the control to the specified location and size. | Control |
| Show() | Displays the control to the user. | Control |
| SuspendLayout() | Suspends the layout logic for the control. | 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. | Control |
| ValidateChildren(flags) | Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags . | Control |
| 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. | Control |
Events
| Name | Description | From |
|---|---|---|
| Appear | Fired after the control has been fully rendered on the client. | Control |
| AutoSizeChanged | Fired when the AutoSize property value changes. | Control |
| BackColorChanged | Fired when the value of the BackColor property changes. | Control |
| BackgroundImageChanged | Fired when the value of the BackgroundImage property changes. | Control |
| BackgroundImageLayoutChanged | Fired when the BackgroundImageLayout property changes. | Control |
| BecomingActiveControlChanged | Fired when the value of the BecomingActiveControl property changes. | Control |
| BindingContextChanged | Occurs when the value of the BindingContext property changes. | Control |
| CausesValidationChanged | Fired when the value of the CausesValidation property changes. | Control |
| Click | Fired when the control is clicked. | Control |
| ClientSizeChanged | Fired when the ClientSize property value changes. | Control |
| ContextMenuChanged | Fired when the value of the ContextMenu property changes. | Control |
| ControlAdded | Fired when a new control is added to the ControlCollection. | Control |
| ControlCreated | Fired when a control is made visible the first time, fully created and sent to the client. | Control |
| ControlRemoved | Fired when a control is removed from the ControlCollection. | Control |
| CursorChanged | Fired when the value of the Cursor property changes. | Control |
| DataSourceChanged | Fired when the DataSource changes. | ListControl |
| Disappear | Fired after the control is no longer visible on the client. | Control |
| DisplayMemberChanged | Fired when the DisplayMember property changes. | ListControl |
| Disposed | Fired when the component is disposed. | Control |
| DockChanged | Fired when the value of the Dock property changes. | Control |
| DoubleClick | Fired when the control is double-clicked. | Control |
| DragDrop | Fired when a drag-and-drop operation is completed. | Control |
| DragEnd | Fired when a drag-drop operation is terminated either by a drop or canceled. | Control |
| DragEnter | Fired when an object is dragged into the control's bounds. | Control |
| DragLeave | Fired when an object is dragged out of the control's bounds. | Control |
| DragOver | Fired when an object is dragged over the control's bounds. | Control |
| DragStart | Fired when a drag-drop operation is started by the user. | Control |
| EnabledChanged | Fired when the Enabled property value has changed. | Control |
| EndMove | Fired when a control is Movable and the user ends the move operation. | Control |
| EndResize | Fired when a control has ResizableEdges and the user ends the resize operation. | Control |
| Enter | Fired when the control gains the input focus. | Control |
| FontChanged | Fired when the Font property value changes. | Control |
| ForeColorChanged | Fired when the ForeColor property value changes. | Control |
| Format | Fired when the control is bound to a data value. | ListControl |
| FormatInfoChanged | Fired when the value of the FormatInfo property changes. | ListControl |
| FormatStringChanged | Fired when value of the FormatString property changes. | ListControl |
| FormattingEnabledChanged | Fired when the value of the FormattingEnabled property changes. | ListControl |
| GotFocus | Fired when the control gains the focus. | Control |
| HelpRequested | Fired when the user requests help for a control by pressing F1. | Control |
| IconMemberChanged | Fired when the IconMember property changes. | ListControl |
| ImeModeChanged | Fired when the ImeMode property has changed. | Control |
| KeyDown | Fired when a key is pressed while the control has focus. | Control |
| KeyPress | Fired when a key is pressed while the control has focus. | Control |
| KeyUp | Fired when a key is released while the control has focus. | Control |
| Layout | Fired when a control should reposition its child controls. | Control |
| Leave | Fired when the control loses the input focus. | Control |
| LocationChanged | Fired when the Location property value has changed. | Control |
| LongTap | Fired when a pointer holds on the screen. | Control |
| LostFocus | Fired when the control loses focus. | Control |
| MarginChanged | Fired when the control's margin changes. | Control |
| ModifiedChanged | Fired when the value of the Modified property has changed. | ListControl |
| MouseCaptureChanged | Fired when the control loses mouse capture. | Control |
| MouseClick | Fired when the control is clicked by the mouse. | Control |
| MouseDoubleClick | Fired when the control is double clicked by the mouse. | Control |
| MouseDown | Fired when the mouse pointer is over the control and a mouse button is pressed. | Control |
| MouseEnter | Fired when the mouse pointer enters the control. | Control |
| MouseHover | Fired when the mouse pointer rests on the control. | Control |
| MouseLeave | Fired when the mouse pointer leaves the control. | Control |
| MouseMove | Fired when the mouse pointer is moved over the control. | Control |
| MouseUp | Fired when the mouse pointer is over the control and a mouse button is released. | Control |
| MouseWheel | Fired when the mouse wheel moves while the control has focus. | Control |
| Paint | Fired when a UserPaint control needs to redraw itself. | Control |
| ParentChanged | Fired when the Parent property value changes. | Control |
| Pinch | Fired when two finger moved towards or away from each other. It contains the scaling factor of the pinch. | Control |
| PreviewKeyDown | Fired before the KeyDown event when a key is pressed while focus is on this control. | Control |
| QueryContinueDrag | Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. | Control |
| Resize | Fired when the control is resized. | Control |
| ResponsiveProfileChanged | Fired when the active responsive profile is changed. | Control |
| RightToLeftChanged | Fired when the RightToLeft property value changes. | Control |
| Rotate | Fired when two finger moved around a single point. It contains the angle of the rotation. | Control |
| SelectedValueChanged | Fired when the SelectedValue property changes. | ListControl |
| SizeChanged | Fired when the Size property value changes. | Control |
| StartMove | Fired when a control is Movable and the user begins the move operation. | Control |
| StartResize | Fired when a control has ResizableEdges and the user begins the resize operation. | Control |
| StyleChanged | Fired when the control style changed. | Control |
| Swipe | Fired when a pointer swipes over the screen. | Control |
| TabIndexChanged | Fired when the TabIndex property value has changed. | Control |
| TabStopChanged | Fired when the value of the TabStop property changes. | Control |
| Tap | Fired when a pointer taps on the screen. | Control |
| TextChanged | Fired when the Text property value changes. | Control |
| ToolTipMemberChanged | Fired when the ToolTipMember property changes. | ListControl |
| TouchCancel | Fired when a touch point has been disrupted in an implementation-specific manner (for example, too many touch points are created). | Control |
| TouchEnd | Fired when a touch point is removed from the touch surface. | Control |
| TouchMove | Fired when a touch point is moved along the touch surface. | Control |
| TouchStart | Fired when a touch point is placed on the touch surface. | Control |
| Track | Fired when a pointer grabs an item and moves the pointer on it. | Control |
| Validated | Fired when the control is finished validating. | Control |
| Validating | Fired when the control is validating. | Control |
| ValueMemberChanged | Fired when the ValueMember property changes. | ListControl |
| VisibleChanged | Fired when the Visible property value changes. | Control |
| WidgetEvent | Fired when the control receives a custom event from the client. | Control |
Extension Methods
| Name | Description | From |
|---|---|---|
| Beep(Target, AudioBase64) | Sounds a tone through the computer's speaker. | Interaction |
| InputBox(Target, Prompt, Title, DefaultResponse, XPos, YPos, CloseCallback) | Displays a prompt in a dialog box, waits for the user to input text or click a button, and then returns a string containing the contents of the text box. | Interaction |
| InputBoxAsync(Target, Prompt, Title, DefaultResponse, XPos, YPos) | Asynchronous displays a prompt in a dialog box, waits for the user to input text or click a button, and then returns a string containing the contents of the text box. | Interaction |
| MsgBox(Target, Prompt, Buttons, Title, CloseCallback) | Displays a message in a dialog box, waits for the user to click a button, and then returns an integer indicating which button the user clicked. | Interaction |
| MsgBoxAsync(Target, Prompt, Buttons, Title) | Asynchronously displays a message in a dialog box, waits for the user to click a button, and then returns an integer indicating which button the user clicked. | Interaction |
| ToJSON(obj, formatted) | Serializes the object to a JSON string. | JSON |
| ToJSON(obj, options) | Serializes the object to a JSON string. | JSON |
Inherited By
| Name | Description |
|---|---|
| DataGridViewComboBoxEditingControl | Represents a ComboBox control that can be hosted in a DataGridViewComboBoxCell. |
| ListViewComboBox | The TreeViewComboBox control represents a UserComboBox control with a ListView as the drop down panel. |
| TreeViewComboBox | The TreeViewComboBox control represents a UserComboBox control with a TreeView as the drop down panel. |
| UserComboBox | The UserComboBox control represents a ComboBox control with a custom panel that drops down when the user clicks the down arrow. |
Implements
| Name | Description |
|---|---|
| IBindableComponent | Bindable components implement this interface. |
| ILabel | Provides access to the LabelWrapper associated with the controls that implement this interface. |
| IReadOnly | Provides access to the ReadOnly property for coontrols that support the read-only mode. |
| IModified | Provides access to the Modified property and ModifiedChanged event for controls that 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. |