Component Palette Icon:

On this page ...

The Label component can display text, images, or both. Its text can be HTML formatted (like most components) and can be bound to dynamic properties.


Properties

NameDescriptionProperty TypeScriptingCategory
Background ColorThe background color of the label, if opaque is set to "true". Can be chosen from color wheel, chosen from color palette, or entered as  RGB  or  HSL  value. See Color Selector. Color.backgroundAppearance
Border

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

Note: The border is unaffected by rotation.
This feature was changed in Ignition version 8.1.21:


As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Border.borderCommon
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.int.cursorCodeCommon
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 axis.int.horizontalAlignmentLayout
Horizontal Text PositionDetermines the horizontal position of the label's text, relative to its image.int.horizontalTextPositionLayout
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
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityDeprecated
RotationThe angle of rotation in degrees.int.rotationAppearance
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 axis.int.verticalAlignmentLayout
Vertical Text PositionDetermines the vertical position of the label's text, relative to its image.int.verticalTextPositionLayout
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Deprecated Properties
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityData


Scripting

Component Functions

This component does not have component 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.


Customizers


Examples

Stylized Label Inside a Popup Window

Property NameValue

Image Path

Builtin/icons/48/document_edit.png
Text

<html><p><strong><center><h2>Procedure 10a: <br>
React to a Reactor Shutdown.</h2></center></strong></p>
<ol>
<li>Inspect cameras for potential safety incident.</li>
<li>Contact Supervisor and Floor Coordinator.</li>
<li>Continue to <strong>Sub Process 1a: Reactor Reset.
</strong></li>
</ol></html>


  • No labels