ComponentTool

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Component
  • 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.

C#

public class ComponentTool : Component

VB.NET

Public Class ComponentTool
    Inherits Component

Constructors

ComponentTool()

Initializes a new instance of the ComponentTool class.

Properties

AutoHide

Boolean: Returns or sets whether the ComponentTool automatically hides itself when the host control loses the focus. (Default: False)

Control

Control: Returns the Control that contains this ComponentTool object.

Enabled

Boolean: Returns or sets whether the ComponentTool is enabled.

The tool can be forced enabled or disabled by assigning the Enabled property. Use ResetEnabled to reset this property to inherit from the container.

If this property is not assigned, the tool will inherit the enabled state from the container Control. By assigning this property, you can force the tool to be enabled when the container is disabled and vice versa.

Image

Image: Returns or sets the image that is displayed in a ComponentTool button.

ImageSource

String: Returns or sets the theme name or URL for the image to display in the ComponentTool button.

Name

String: Returns or sets the name to apply to the ComponentTool. (Default: "")

Position

LeftRightAlignment: Returns or sets the horizontal alignment of this ComponentTool within the parent's container. (Default: Right)

Pushed

Boolean: Returns or sets whether a toggle-style ComponentTool is currently in the pushed state. (Default: False)

ToolTipText

String: Returns or sets ToolTip text associated with the ComponentTool button. (Default: "")

Visible

Boolean: Returns or sets whether the ComponentTool is visible. (Default: True)

Methods

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.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

ResetEnabled()

Resets the Enabled property to inherit the enabled state from the container Control.

Update()

Updates the component on the client. Overridden to repaint the widget in design mode.

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.