Page History

Panel

borderStyle	solid
title	Description

This component is a specialized label used to display a discrete state. The state must be represented by an integer, but the values and number of different states is customizable. Use the component's styles customizer to configure the different states.

Panel

title	Properties

Name

Description

Property Type

Scripting

Category

Background Color

The background color of the component. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.

Color

.background

Appearance

Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

Note
The border is unaffected by rotation.

Border

.border

Common

Cursor

The mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.

int

.cursorCode

Common

Disabled Image Path

The relative path of the image to be displayed when this component is not enabled.

String

.disabledPath

Appearance

Enabled

If disabled, a component cannot be used.

boolean

.componentEnabled

Common

Font

Font of text on this component.

Font

.font

Appearance

Foreground Color

The foreground color of the component. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.

Color

.foreground

Appearance

Horizontal Alignment

Determines the alignment of the label's contents along the X axis.

int

.horizontalAlignment

Layout

Horizontal Text Position

Determines the horizontal position of the label's text, relative to its image.

int

.horizontalTextPosition

Layout

Icon-Text Spacing

The space (in pixels) between the icon (if any) and the text (if any).

int

.iconTextGap

Appearance

Image Path

The relative path of the image.

String

.path

Appearance

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

String

.toolTipText

Common

Name

The name of this component.

String

.name

Common

Quality

The data quality code for any Tag bindings on this component.

QualityCode

.quality

Data

State

The current state of the component.

int

.state

Data

Styles

Contains the component's styles.

Dataset

.styles

Appearance

Text

Text of this Label.

String

.text

Data

Vertical Alignment

Determines the alignment of the label's contents along the Y axis.

int

.verticalAlignment

Layout

Vertical Text Position

Determines the vertical position of the label's text, relative to its image.

int

.verticalTextPosition

Layout

Visible

If disabled, the component will be hidden.

boolean

.visible

Common

Deprecated Properties

Data Quality

The data quality code for any Tag bindings on this component.

int

.dataQuality

Deprecated

Panel

title	Scripting

Panel

title	Scripting Functions

This component does not have scripting functions associated with it.

Panel

title	Extension Functions

This component does not have extension functions associated with it.

Panel

title	Event Handlers

Expand

title	mouse

Expand

title	mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.source	The component that fired this event.
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseEntered

This event fires when the mouse enters the space over the source component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseExited

This event fires when the mouse leaves the space over the source component.

.source	The component that fired this event.
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mousePressed

This event fires when a mouse button is pressed down on the source component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseMotion

Expand

title	mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

Expand

title	propertyChange

Expand

title	propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.source

The component that fired this event

.newValue

The new value that this property changed to.

.oldValue

The value that this property was before it changed. Note that not all components include an accurate oldValue in their events.

.propertyName

The name of the property that changed.

Note
Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

Panel

title	Customizers

The Multi-State Indicator component does not have a special customizer, however, it relies on the Style Customizer. When you open the Style Customizer, you'll notice that it has the State driving property selected, and several visual properties defined such as Background Color, Border, Foreground Color, and Text. If you don't like the predefined properties, you can change them, as well as add or remove any styled properties.

The Style Customizer for the Multi-State Indicator works by configuring a set of visual properties that change based on a different state. The State is represented by an integer, but the values and number of different states are customizable.

Style Customizer for the Multi-State Indicator - Property Description

Property	Description
Driving Property	Property that drives the style of the component.
Styled Properties	There are two categories of properties: Available Properties and Used Properties.
Available Properties	Styled properties that have not been used.
Used Properties	Styled properties that have been used.
Styles	Styles section for the defining states and styles.
Values	Driving property represented by an integer.
Preview	View the label after the visual styles are configured. Expand each value to configure, or change any of the styles. There is an Animate checkbox that you can check to enable the label to blink.

For additional Customizers, see:

Panel

title	Examples

Panel

Property Name	Value
Styles	As defined by the style customizer.

OTHER USER MANUAL VERSIONS

GETTING STARTED

MODULES AND PLATFORM

APPENDIX

TUTORIALS & HELPFUL TRICKS

PARTNER LINKS

RESOURCES

Employees

Versions Compared

Old Version 9

New Version Current

Key