IWisejComponent

Wisej.Core.IWisejComponent

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

All wisej components implement this interface.

C#

public interface IWisejComponent : IDisposable

VB.NET

Public Interface IWisejComponent
    Inherits IDisposable

Properties

Configuration

Object: Stores the last configuration for the component.

DesignMode

Boolean: Indicates that the control is being rendered in the designer.

DesignRect

Rectangle: Returns or sets the design rectangle for the component when it is used as a child widget in a designable control.

Filter

Func<IWisejComponent, Object, String, Object>: Allows an external component to hook a filter method.

Components decides what filter to call and when and filter implementations must know what filter to process. There is no predefined list of filters, it's dynamic and it can change depending on the needs of the implementation. Currently there are these built in filters:

• type = "Render" Invoked by Component after the configuration object has been filled. The return value is ignored. A filter can modify the passed in data dynamic object.

• type = "GetPreferredSize" Invoked by Control after it has calculated the preferred size of the control with the property AutoSize set to true. The data object is a Size and the return value is the new preferred Size.

Handle

Int32: The unique server handle of the component.

Id

String: The unique client id of the component.

IsDirty

Boolean: Indicates that the component needs to be updated on the client.

IsDisposed

Boolean: Indicates that the component has been disposed.

IsNew

Boolean: Returns or sets the new status.

IsTopLevel

Boolean: Indicates that the component is rendered at the top level on the client: the parent is the root.

Locked

Boolean: Locks UI updates to the control.

Session

Object: Holds a reference to the session where this component lives.

Methods

Event(e)

Processes the event.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

Reference(list)

Returns a collection of referenced components or collection of components.

Parameter	Type	Description
list	IList	List of referenced components or collection of components.

Render(config)

Renders the component into the config definition.

Parameter	Type	Description
config	Object	Dynamic configuration object.

UpdateComponent(state)

Updates the server component using the state information.

Parameter	Type	Description
state	Object	Dynamic state object.

UpdateWidget()

Updates the client widget.

Events

Updated

EventHandler Fired after the component has been updated.

Implemented By

Name	Description
FileDialogUI	UI implementation for the FileDialog class.
FolderBrowserDialogUI	UI implementation for the FolderDialog class.
Control	Base class for all Wisej controls.
DataRepeater	Displays data in a customizable list format.
DataRepeaterItem	Used by the DataRepeater control to display data at run time.
Toast	Displays a toast that can contain an icon and text.
Shape	Represents a shape control. Displays an element a border in any of the four sides.
FlexLayoutPanel	Represents a panel that dynamically arranges its child controls.
TimeUpDown	Represents a spinner control that displays TimeSpan values.
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.
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.
SlideBar	Displays child controls vertically or horizontally in a scrollable container.
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.
Component	Extends Component and enabled the components to appear on the designer surface.
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 children 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.
MessageBox	Displays a message box that can contain text, buttons, and symbols that inform and instruct the user.
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.
StatusBar	Displays information to the user in a about the object being viewed, the object's components, or the object's operation.
StatusBarPanel	Represents a panel in a StatusBar control. Although the StatusStrip control replaces and adds functionality to the StatusBar control of previous versions, StatusBar is retained for both backward compatibility and future use if you choose.
TabControl	Manages a related set of TabPage pages.
TableLayoutPanel	Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.
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.
Timer	Implements a timer that raises an event at user-defined intervals.
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.
DataGridViewButtonColumn	Represents a DataGridView column that contains a collection of DataGridViewButtonCell cells.
DataGridViewCheckBoxColumn	Represents a DataGridView column that contains a collection of DataGridViewCheckBoxCell cells.
DataGridViewColumn	Represents a column in a DataGridView control.
DataGridViewComboBoxColumn	Represents a DataGridView column that contains a collection of DataGridViewComboBoxCell cells.
DataGridViewComboBoxEditingControl	Represents a ComboBox control that can be hosted in a DataGridViewComboBoxCell.
DataGridViewDateTimePickerColumn	Represents a DataGridView column that contains a collection of DataGridViewDateTimePickerCell cells.
DataGridViewDateTimePickerEditingControl	Represents a DateTimePicker control that can be hosted in a DataGridViewDateTimePickerCell.
DataGridViewImageColumn	Represents a DataGridView column that contains a collection of DataGridViewImageCell cells.
DataGridViewLinkColumn	Represents a DataGridView column that contains a collection of DataGridViewLinkCell cells.
DataGridViewMaskedTextBoxColumn	Represents a DataGridView column that contains a collection of DataGridViewTextBoxCell cells.
DataGridViewMaskedTextBoxEditingControl	Represents a MaskedTextBox control that can be hosted in a DataGridViewMaskedTextBoxCell cell.
DataGridViewNumericUpDownColumn	Represents a DataGridView column that contains a collection of DataGridViewNumericUpDownCell cells.
DataGridViewNumericUpDownEditingControl	Represents a NumericUpDown control that can be hosted in a DataGridViewNumericUpDownCell.
DataGridViewTextBoxColumn	Represents a DataGridView column that contains a collection of DataGridViewTextBoxCell cells.
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.
Desktop	Represents a desktop container that can host floating windows.
DesktopTaskBarItem	Represents a component in the Desktop control's taskbar.
DesktopTaskBarItemControl	Represents a component in the Desktop control's taskbar that can host any Control.
DesktopTaskBarItemDateTime	Represents a DateTime component in the Desktop control's taskbar.
Animation	Provides support for animating controls or windows using predefined animations definitions or custom animations in response to certain events.
ErrorProvider	Provides a user interface for indicating that a control on a form has an error associated with it.
HelpTip	Represents a small rectangular pop-up window that displays a brief help text next to a control when it gets activated (focused).
JavaScript	Allows controls to execute javascript code.
Rotation	Add rotation capabilities along the X,Y,Z axis to Control controls.
StyleSheet	Adds CSS styling to controls.
ToolTip	Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.
Accordion	Displays collapsible set of AccordionPanel panels for presenting information in a limited amount of space.
AccordionPanel	Represents a panel in a Accordion control.
AlertBox	Displays an alert box that can contain an icon and text that inform and instruct the user. Alert boxes are not modal and can disappear automatically.
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.
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.
SplitButton	Represents a split button control.
ComponentTool	Represent a tool widget that can be displayed inside another control. A tool widget is different from other child controls: it's displayed inside the parent's layout. For example, the Form control shows tool widgets inside the caption bar. When a tool widget is pressed, it fires the toolClicked event on the container.
TreeViewComboBox	The TreeViewComboBox control represents a UserComboBox control with a TreeView as the drop down panel.
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.
ImageList	Provides methods to manage a collection of Image objects. This class cannot be inherited.
ColumnHeader	Displays a standard column header in a ListView control.
ImageColumnHeader	Displays an image column header in a ListView control.
ListView	Represents a list view control, which displays a collection of items that can be displayed using one of four different views.
ContextMenu	Represents a context menu associated to a Control.
LinkMenuItem	Represents an individual menu item that is displayed within a MainMenu or ContextMenu rendered using the link element to let the browser process the specified HRef URL.
MainMenu	Represents the main menu in a Form.
Menu	Represents the base functionality for all menus.
MenuBar	Represents a menu bar component.
MenuItem	Represents an individual item that is displayed within a MainMenu or ContextMenu.
PropertyGrid	Provides a user interface for browsing the properties of an object.
ToolBar	Represents a toolbar component.
ToolBarButton	Represents a button in the ToolBar.
TreeNode	Represents a node of a TreeView.
TreeView	Displays a hierarchical collection of labeled items, each represented by a TreeNode.
Application	Represent a Wisej application session. Provides methods and events to manage the application in the context of the current session.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejHandler	Represents a Wisej component that is capable of handling postback requests from the client.
IWisejWindow	All wisej top-level windows implement this interface.
Component	The base class for Wisej components that are not controls. Wisej components are still managed on the client and the server but are not present on the designer surface. Examples of wisej components are: menu items, image lists, tree nodes, list items.