Component

Namespace: Wisej.Base

Assembly: Wisej.Framework (4.1.0.0)

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.

C#

public class Component : IDisposable, IWisejComponent, IWisejSerializable, IUserData

VB.NET

Public Class Component
    Inherits IDisposable
    Implements IWisejComponent, IWisejSerializable, IUserData

Constructors

Component()

Default constructor

Component(embedded)

Default constructor

Name	Type	Description
embedded	Boolean	Indicates whether the component is embedded in a parent component. Embedded components don't update themselves, instead their parent is in charge of updating the corresponding client widget.

Properties

HasUserData

Boolean: Checks if the UserData dynamic object was created and has any value. (Default: False)

InClientEvent

Boolean: Returns true if the component is processing a client event.

IsDisposed

Boolean: Indicates that the component has been disposed. (Default: False)

UserData

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

Default value is {}.

Methods

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.

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.

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.

Dispose()

Releases all resources used by the Component.

Dispose(disposing)

Marks this component as disposed.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

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.

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.

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.

Finalize()

Destructor dispose pattern.

InvokeFilter(data, type)

Invokes the Filter method.

Parameter	Type	Description
data	Object	Data passed to the filter implementation.
type	String	Name of the filter being invoked.

Returns: Object.

OnAddReferences(list)

Returns a collection of referenced components or collection of components.

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

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

OnWebUpdate(state)

Updates the client component using the state information.

Parameter	Type	Description
state	Object	Dynamic state object.

Update()

Updates the component on the client.

Events

Disposed

EventHandler Fired when the component is disposed.

Inherited By

Name	Description
BindableComponent	Extends Component and enables the component to participated if data binding operations and have their own DataBindings.
Component	Extends Component and enables the components to appear on the designer surface.
MessageBox	Displays a message box that can contain text, buttons, and symbols that inform and instruct the user.
Timer	Implements a timer that raises an event at user-defined intervals.
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.
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.
Toast	Displays a toast that can contain an icon and text.
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.
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.
CheckedMenuItem	Represents an individual menu item that is displayed within a MainMenu or ContextMenu and always shows a checkbox next to the label.
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 <a> 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.
MenuItem	Represents an individual item that is displayed within a MainMenu or ContextMenu.
StatusBarControl	Represents a panel in a StatusBar control that can host any Control.
StatusBarPanel	Represents a panel in a StatusBar control.
ToolBarButton	Represents an item in the ToolBar.
TreeNode	Represents a node of a TreeView.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.