SHIP:Node:string

See Also

• Node Home
• Text Model Reference
• Language Support
• text nodes
• Sail String Functions

Synopsys

The string node type was introduced in SHIPv5, and is not available in SHIPv4.

Node Type	Description
string	Defines a simplified UTF8 text resource with optional translation(s).

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

Unlike text nodes, string nodes have no concept of font, alignment, colors, or any layout related properties. They are the lightest-weight text-type node and designed for efficient memory use in GUIs, especially when there are many string resources to be put in your GUI.

Only available in the resources area, string nodes are very simple re-usable (and unchangeable) text resources. These string resources can have alternate translations such that when the system variable shiplanguage changes the GUI can automatically be updated.

Ancestors

string 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

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

Descendants

The following nodes are permitted within string nodes:

Node Type	Description
alternate†	Defines a alternate translation for a text resource.

^†These nodes are permitted only directly underneath the string node.

Properties

Property Name	Data Type	Description
name**	String	The name used to identify this node in SHIPTide.
value	String	Value of a string resource node.

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