SHIP:Node:textframe

See Also

• SHIPv5 string nodes for much lighter weight string resources with (optional) translation
• Node Home
• Text Frame Model Reference
• Language Support
• Sail String Functions

Synopsys

Node Type	Description
textframe	Defines a textframe resource or a visual text representation.

textframe nodes in the layout area are rendered according to the SHIP Text Frame Model, and UTF-8 encoding is used for textframe node values.

In the resources area, textframe nodes define re-usable (and unchangeable) text resources. These textframe resources can have alternate translations such that when the system variable shiplanguage changes the GUI can automatically be updated.

Ancestors

textframe nodes within the resources area may be found within the following nodes:

Node Type	Description
group	Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.
resources†	All reusable items, such as images, are held in the SHIP top-level node defined as the resources node

^†textframe nodes are permitted only directly underneath these nodes.

Within the layout area, textframe nodes may be found within the following nodes:

Node Type	Description
box†	A generic rectangular container, available as a reusable resource or layout element.
display	Contains the visual GUI layout for a specific LCD display/touch set.
group†	Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.
layout	Top of the Layout Area within a SHIP GUI, which completely describes how the GUI is visually organized.
page†	Visual layout area for a specific GUI "page", or "screen"

^†textframe nodes are permitted directly underneath these nodes.

Descendants

The following nodes are permitted within textframes:

Node Type	Description
constant†	Defines a constant value for use in SHIPTide properties or SAIL scripts.
group†	Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.
listener†	Monitors one or more properties (including variable values!) for changes, and on changes invokes a script.
script	Run-time algorithms, written in SHIPSail.
timer†	Generates delays and timed alarm events.
variable†	Run-time value accessible by scripts and able to generate events on change.

^†textframe nodes are permitted directly underneath these nodes.

Properties

Property Name	Data Type	Description
enabled	Boolean	If true (default) this node and its children are able to receive events.
name**	String	The name used to identify this node in SHIPTide.
object
opacity	Byte	Opacity of the displayable node and all its children, grandchildren, etc.
silent
visible	Boolean	If true (default) this node will be visible iff all direct line parent nodes up to and including the display node are also visible.

**available only in SHIPTide; cannot be accessed from Sail scripts at run-time.

The following textframe-related properties are inherited: textframe||A generic text container, available as a reusable resource or layout element.