The Text control can be used to edit either strings or values, depending on the type of parameter that it is connected to. If a parameter is defined as a value, you can increase and decrease the value by clicking on the text control and dragging up and down. For string parameters, you can enter the string. The Fit String and Fit Path options automatically shorten a string if it is getting too long to be displayed completely. For value parameters, you can add a unit that is displayed behind the value. If you want increment and decrement buttons, you can use the "ValueBox Black Flat" template from the Basic Controls library (in the "Flat" folder found in the "Text and Value" folder). This template contains a text control with up and down buttons.
The name of the element. This name will be displayed in the GUI Tree.
Position/Size
Position X, Position Y, Width, Height: Position and size of the element in pixels. Position X/Y defines the position of the upper left corner.
Attach
Defines how an element behaves when its parent element is resized. You can set the following parameters:
Left: If the parent element is resized, the element remains attached to left edge, with the specified ratio.
Right: If the parent element is resized, the element moves relatively to the right edge, with the specified ratio.
Top: If the parent element is resized, the element remains attached to top edge, with the specified ratio.
Bottom: If the parent element is resized, the element moves relatively to the bottom edge, with the specified ratio.
Left + Right: If the parent element is resized, the element is resized horizontally relatively to the left and right edges, with the specified ratio.
Tooltip
Text that appears as a tooltip when the mouse hovers over the element.
Style
Fit Strings: Activate this option if you want a string to be shortened automatically if it cannot be fully displayed in the edit field. This method first removes spaces, then vowels.
Fit Path: Activate this option if you want a path string to be shortened automatically if it cannot be fully displayed in the edit field. This method keeps the first and last characters of the string and puts "..." in between to indicate that letters were omitted.
Wordwrap: Activate this option if you want to write text in more than one line. The text continues on the next line as soon as it does not fit into the current line.
Read-Only: Activate this option if you want to use the text as a display-only parameter which cannot be edited. (Since HALion 6.1)
Val Meter: Activate this option if you want to display a value meter popup display when dragging the text control. (Since HALion 7.0)
Single Click: Activate this option if you want to enter edit mode with a single click. (Since HALion 7.0)
Immediate: Activate this option if you want to update values immediately while typing. (Since HALion 7.0)
Font
Allows you to select which Font resource to be used to display the text.
Units
A unit, such as milliseconds (ms) or decibel (dB), can be displayed with the value. Any string can be used. The value must be displayed in the correct value format to match the selected unit.
Alignment
Defines how the text is aligned. You can choose from the following settings:
Align Left: Aligns the text to the left side.
Align Center (Horizontal): Aligns the text to the horizontal center.
Align Right: Aligns the text to the right side.
Align Top: Aligns the text to the top.
Align Center (Vertical): Aligns the text to the vertical center.
Align Bottom: Aligns the text to the bottom.
Val Meter
The following properties are only accessible if the Val Meter style has been activated.
Template: Here you can select a template that is shown as value meter when dragging the text control. The template must contain an indicating control like a slider or an animation with an exported Value property. This value appears under Template Parameters and can then be connected to the same parameter as the text control. With no template specified, the HALion value meter popup display is used. (Since HALion 7.0)
Placement: Here you can define the relative position in relation to the text control where the Val Meter should be shown.
Template Parameter: All exported properties of the selected template will be listed here. However, only the Value property needs to be exported for the value meter functionality. Since the Template Parameters can also be exported, the Value property of the Val Meter template and the Value property of the text control can be combined to be used as a single common template parameter, e.g., on a text control template. (Since HALion 7.0)