Text Item

Help Contents

Introduction

A text item displays one or more lines of text on a graphic page.

To add a Text Item to a graphic page use the Add Text Tool.

Text Item Properties

Text item properties define how text appears on the graphic page. For example, the FontFamily property sets which font face is used to display the text.

When one or more text items are selected, the text item properties are shown in the Properties Window. To make changes, enter new values for the appropriate property.

Text items support these properties:

Identification
Label An optional label to attach to the item.
Properties
Comment A field to store notes and information about the item. The comment property has no effect on how the item is displayed or behaves.
Text The text to display (unless overridden by the DataBindText property). To enter multiple lines of text, Click the Browse button Browse button to open a multiple line text editor.
Visible The initial visibility in run mode. To dynamically display or hide the item use the DataBindVisible data binding, or the GraphicItemSetVisible() function.
Text Attributes
FontFamily The font family used to display the text. To change the available font families use the Global Text Styles Editor.
FontSizeThe size of the text in points.
TextColorDefines the color of the text (unless overridden by the DataBindTextColor property).
TextStrikeoutChooses whether the text is drawn with a strikeout effect (unless overridden by the DataBindTextStrikeout property).
TextUnderlineChooses whether the text is drawn with an underline (unless overridden by the DataBindTextUnderline property).
Direction & Alignment
DirectionDefines the direction of text (horizontal, vertical up, vertical down).
HorizontalAlignmentDefines the horizontal alignment of text in the bounding rectangle (left, center, right).
VerticalAlignmentDefines the vertical alignment of text in the bounding rectangle (top, center, bottom).
Blink Attributes
BlinkModeDefines how the text item blinks: Invisible or Alternate Color.
BlinkSpeedDefines how fast the text item blinks: Slow, Medium or Fast.
BlinkTextColorThe alternate text color when the blink mode is Alternate Color.
General Data Bindings
DataBindBlink A Data Binding which if evaluates to TRUE causes the item to blink.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindDisableActions A Data Binding which if evaluates to TRUE disables all actions on this item.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindTooltip A Data Binding which sets the tooltip to display if a user hovers the cursor over the item. Note: Tooltips are not currently supported in the Android Operator Interface.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindVisible A Data Binding which if evaluates to FALSE hides the item.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
Size Position Data Bindings
ClipRegionHorizontal When the DataBindClipHorizontal data binding is defined, this value chooses whether the left or right side of the item is clipped.
ClipRegionVertical When the DataBindClipVertical data binding is defined, this value chooses whether the top or bottom of the item is clipped.
DataBindClipHorizontal A Data Binding which sets how much of the item to clip horizontally. A value less than or equal to zero clips the entire item. A value greater than or equal to one does not clip the item. Values between zero and one clip the corresponding portion of the item.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindClipVertical A Data Binding which sets how much of the item to clip vertically. A value less than or equal to zero clips the entire item. A value greater than or equal to one does not clip the item. Values between zero and one clip the corresponding portion of the item.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindOffsetX A Data Binding which moves the item in the horizontal direction. The offset is in canvas units.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindOffsetY A Data Binding which moves the image in the vertical direction. The offset is in canvas units.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindScaleX A Data Binding which resizes the image in the horizontal direction. A value less than 1.0 shrinks the item horizontally. A value greater than 1.0 expands the item horizontally. Note: This property has very little effect on text items because font is chosen to fit the available height. The aspect ratio of the characters in the font is always preserved.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindScaleY A Data Binding which resizes the image in the vertical direction. A value less than 1.0 shrinks the item vertically. A value greater than 1.0 expands the item vertically.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
Text Data Bindings
DataBindLineColor A Data Binding which sets the text to display.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindTextColor A Data Binding which determines the text color.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindTextStrikeout A Data Binding which if evaluated to TRUE draws the text with a strikeout line.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindTextUnderline A Data Binding which if evaluated to TRUE draws an underline.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
Actions
ActionButtonDown An Operator Action script to run when the operator presses the left mouse button down, or touches the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionButtonShortcut A keyboard shortcut to emulate a button press on the item. Click the Browse button Property browse button to edit the shortcut using the Shortcut Editor.
ActionButtonUp An Operator Action script to run when the operator releases the left mouse button, or removes touch from the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionButtonWhileDown An Operator Action script to run at intervals while the operator holds the left mouse button down, or continuously touches the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionDoubleClick An Operator Action script to run when the operator double clicks the left mouse button, or double taps the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionContextMenu An Operator Action script to run when the operator clicks the right mouse button, or does a long press on the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
WhileDownInterval The interval between each execution of the ActionButtonWhileDown script.

FontSize Property

The FontSize property defines the height of text in points. A point is traditionally 1/72 of an inch or 0.3528 millimetres.

The drawing canvas is notionally an A4 page in landscape orientation (297 x 210 millimetres). The height of the text drawn is chosen by scaling the point size relative to the notional A4 size of the drawing canvas.

In typography an em is a unit of measurement equal to the current point size. For example in a 24 point font, the size of an em will be 24 points or 8.4672 millimetres. An em is the same size in all font faces.

Font designers layout fonts relative to an em square, but are not constrained by its dimensions. A font designer could design font glyphs that are substantially smaller than the em square, or stray outside its boundaries. This is why two characters from different type faces can have different sizes even though they are using the same point size.

Underline and Strikeout Properties

The Underline and Strikeout properties draw a line under the text or through the text respectively:

Text underline and strikeout options

Direction Property

The Direction property controls the direction of the text:

HorizontalVertical upVertical down
Horizontal text direction Vertical up text direction Vertical down text direction

Alignment Properties

The HorizontalAlignment and VerticalAlignment properties control how the text is aligned in the bounding box:

Text alignment options

Line Breaking

Text will be drawn as multiple lines if:

Text can be drawn outside of the bounding box if:

Further Information

Data Bindings

For a complete description of all data binding options.

Graphic Editor Toolbar

For the different tools available to edit graphic pages.

Graphic Editor

For information about editing graphic pages in Fernhill SCADA.

Glossary

For the meaning of terms used in Fernhill SCADA.