Skip to main content
Version: 7.9


Component Palette Icon

The Label is one of the most versatile components. It can display text, images, or both. Its text can be HTML formatted (like most components). It can even be made to respond to user interaction through its events.

Labels are one of the most common components that you will want to add dynamic properties to. For instance, you can put an integer dynamic property "state" on a label, and then bind the text to be "On" when the state=1 and "Off" otherwise, using an expression binding. Bind the background color to be red when the state is 0, and green when the state is 1 using a property binding. Now you have a re-usable binary state indicator. While you could have used the Multi-State Indicator to achieve the same effect, the exercise is good practice for creating custom components. You can see how the flexibility of bindings and dynamic properties make the Label extremely versatile.


NameDescriptionProperty TypeScriptingCategory
AntialiasDraw with antialias on? Makes text smoother.boolean.antialiasAppearance
Background ColorThe background color of the label, if opaque is set to "true".Color.backgroundAppearance
BorderThe border surrounding this component. NOTE that the border is unaffected by rotation.Border.borderCommon
CursorThe mouse cursor to use when hovering over this
Data QualityThe data quality code for any tag bindings on this
Disabled Image PathThe relative path of the image to be displayed when this component is not enabled.String.disabledPathAppearance
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
Fill BackgroundIf true, the label's background color will be drawn. If false, it will have a transparent background.boolean.fillBackgroundAppearance
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe color of the Label's text.Color.foregroundAppearance
Horizontal AlignmentDetermines the alignment of the label's contents along the X
Horizontal Text PositionDetermines the horizontal position of the label's text, relative to its
Icon-Text SpacingThe space (in pixels) between the icon (if any) and the text (if any).int.iconTextGapAppearance
Image PathThe relative path of the image.String.pathAppearance
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
RotationThe angle of rotation in
StylesContains the component's styles.Dataset.stylesAppearance
TextText of this Label.String.textData
Vertical AlignmentDetermines the alignment of the label's contents along the Y
Vertical Text PositionDetermines the vertical position of the label's text, relative to its
VisibleIf disabled, the component will be hidden.boolean.visibleCommon


Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

This component does not have extension functions associated with it.

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page



Stylized Label Inside a Popup Window


  • Image Path: Builtin/icons/48/edit.png
  • Text: Shown below:
<html><p><strong><center><h2>Procedure 10a: <br>
React to a Reactor Shutdown.</h2></center></strong></p>
<li>Inspect cameras for potential safety incident.</li>
<li>Contact Supervisor and Floor Coordinator.</li>
<li>Continue to <strong>Sub Process 1a: Reactor Reset.