Component Properties

Top  Previous  Next

Each component has several properties. These may be referred in bindings that "route" data to and from components (e.g. settings of hardware devices). Some properties are common to all widget components. Other properties are component-specific, and are thus described in the articles concerning these components.

Property Types

Description of each widget component property includes property type. Property type is the type of value returned by a component property reference appearing in widget binding (String, Boolean, Integer, etc.).

Indexed Properties

Indexed property is a property that has several elements, i.e. that is represented by array or list. Elements of indexed properties must be referred from bindings by adding zero-based element index into a binding target.

Default Property

Default property is a component's property which is targeted by an automatically created binding. For example, when you drag some server variable and drop in on a Label, the binding created by this operation will change label's text, since Text is the default property of a Label component.

Common Properties Of Components

This section describes properties that are supported by most widget components. The individual description for each component includes a list of supported common properties.

Width

The preferred width of the component, in pixels. If there is not enough space to display a component, this setting may be ignored and the component's actual width will be smaller. If set to zero, the component's width is calculated automatically based on its contents and the display area available to it within the widget layout.

Property name: width

Property type: Integer

height

Preferred height of a component, in pixels. If there is not enough space to display a component, this setting may be ignored and the component's actual height will be smaller. If set to zero, the component's height is calculated automatically based on its contents and the display area available to it within the widget layout.

Property name: height

Property type: Integer

Bindings

This property contains a table of all bindings related to this component (meaning, bindings with an expression, target or activator referring to the component's properties).

Property name: bindings

Property type: Data Table

Enabled

This flag indicates a component is active. Disabled components do not respond to user input, and on most interfaces are rendered as grayed-out:

ls_widgets_disabled

Property name: enabled

Property type: Boolean

Visible

This flag indicates a component is visible.

Property name: visible

Property type: Boolean

Foreground

This property defines a component's foreground color. The exact elements rendered in the foreground color are component-specific.

Property name: foreground

Property type: Color

Background

This property defines a component's background color. The exact elements rendered in the background color are component-specific.

Property name: background

Property type: Color

Opaque

Indicates that component is opaque. It is a Boolean value - can be "True" (Opaque) or "False" (Transparent). A transparent component's background is not rendered -- the background color property is ignored.

Property name: opaque

Property type: Boolean

Border

See Border article for details on border settings.

Property name: border

Property type: Data Table

Font

Defines which font is used by the component. This property is relevant for components using labels or other text elements (e.g, Text Field). Properties of font are described here.

Property name: font

Property type: Data Table

Tooltip

Text for the component's tooltip. Tooltips usually appear when the mouse hovers over the component:

ls_widgets_tooltip

Property name: tooltip

Property type: String