String (Input)

This object is used to enter a string from the operator. It allows text to be entered that can then be used for further processing.

Attributes

AID
Attribute
Description
Object Id

Unique identifier of the object. This must be unique within the object pool (2 bytes, 0-65534).

Type

The type of the object.

Width

Width of the object in pixels.

Height

Height of the object in pixels.

Background Colour

Background colour. A colour based on the index of the Colour Palette.

Font Attributes

Object Id of a Font Attributes object for display formatting of this field.

Input Attributes

Object ID of an Input Attributes object or an Extended Input Attributes object used to validate the string, or NULL if no validation is to be performed. A referenced Input Attributes object or Extended Input Attributes object must be of the same type as the string value (or the string variable), i.e. both must be either an 8-bit string or a WideString. If they are not of the same type, no validation is performed. The specified object and the value match if the specified object is an Input Attributes object and the value is an 8-bit string, or if the specified object is an Extended Input Attributes object and the value is a WideString.

Options (input string)

Option bits of the Input String.

  • Bit 0 = Transparent: If TRUE, the input field is displayed with a transparent background instead of using the background colour attributes.
  • Bit 1 = Auto-Wrap: If TRUE, the automatic wrapping rules apply (see 4.6.19.5).
  • Bit 2 = Wrap on hyphen: If TRUE, automatic wrapping may occur between a hyphen (2D₁₆) and the following character (see 4.6.19.5). Wrap on hyphen is a modification of the Auto-Wrap option and is only applied if the Auto-Wrap option is TRUE. If the Auto-Wrap option is FALSE, this setting is ignored.
  • Variable Reference

    Reference to a Variable object from which the value is taken.

    Justification

    Horizontal/vertical alignment of the content.

    Length

    Maximum length of the text in the object (bytes).

    Value (String)

    Current value of the object if no variable reference is used.

    Enabled

    Current state of the object.

    0 = Disabled
    1 = Enabled

    Number of Macros to follow

    Number of contained macro references, even if it is zero.

    Each macro reference consists of 2 bytes: one for the event Id and one for the macro Id.

    When the specified event occurs, the associated macro is executed. VT version 5 and later: A reference to a macro with a 16-bit Object Id counts as 2 macro references in the context of this attribute.