PLUG'N SCRIPT
rapid plugin development
Tutorial
DSP
KUIML
How-to
Scripts
  • Overview
  • Tutorial
  • Reference
Layout and positioning
  • CELL
  • TABLE
Language basics
  • SKIN
  • DUMMY
  • INCLUDE
  • INCLUDE_ONCE
  • DEFINE
  • UNDEFINE
  • VARIABLE
  • LOCAL_VARIABLE
  • TEMPLATE
  • TEMPLATE_INNER_CONTENT
  • TEMPLATE_UNLOAD
  • REPEAT
Text widgets
  • TEXT
  • TEXT_FIELD
  • TEXT_EDIT_BOX
  • TOOLTIP
  • PARAM_TEXT
  • PARAM_TEXT_CONTROL
  • PARAM_TEXT_EDIT_BOX
  • PARAM_TOOLTIP
Image widgets
  • IMAGE
  • IMAGE_ACTION_BUTTON
  • IMAGE_GROUP_BOX
  • IMAGE_PARAM_BUTTON
  • IMAGE_PARAM_KNOB
  • IMAGE_PARAM_LINEAR_METER
  • IMAGE_PARAM_MENU_BUTTON
  • IMAGE_PARAM_METER
  • IMAGE_PARAM_SLIDER
  • IMAGE_PARAM_TOGGLE_SWITCH
  • XYZ_IMAGE_PARAM_JOYSTICK
Invisible controls
  • INVISIBLE_ACTION_BUTTON
  • INVISIBLE_PARAM_BUTTON
  • INVISIBLE_PARAM_KNOB
  • INVISIBLE_PARAM_MENU_BUTTON
  • INVISIBLE_PARAM_SLIDER
  • INVISIBLE_PARAM_TOGGLE_SWITCH
  • XY_PARAM_PAD
  • XY_ZOOM_SELECT_PAD
  • XYZ_PARAM_SCRATCH_PAD
  • XYZ_PARAM_CLICK_PAD
Drawing, curves & 3D
  • CANVAS
    • Graphics API
  • svg
  • CURVE_GRAPH
  • XY_CURVES_GRAPH
  • GRID
  • RULER
  • COLOR_SCALE
  • VIEW_3D
  • COLOR_SURFACE_3D
  • GRID_3D
  • GL_OBJECT_3D
    • OpenGL Cheat Sheet
  • SURFACE_COLORMAP_2DPLOT
Miscellaneous
  • SCRIPT
  • WIDGET
  • KUIML_WIDGET
  • POPUP_MENU
  • MENU_ITEM
  • MENU_SEPARATOR
  • FILE_SELECT_MENU
  • SYSTEM_ACTION_BUTTON
  • SYSTEM_PARAM_CHECKBOX
  • SYSTEM_PARAM_DROPDOWN_LIST
  • WINDOW
  • LOAD_FONT
Data model
  • STRING
  • PARAM
  • FORMULA_PARAM
  • PARAM_ANIMATOR
  • ACTION
    • Built-in action types
  • TIMER
  • ACTION_TRIGGER
  • CURVE
  • FORMULA_CURVE
  • CURVE_FROM_PARAM_OVER_TIME
  • SURFACE
  • FORMULA_SURFACE
  • SURFACE_FROM_CURVE_OVER_TIME
  • GROUP
Links and commands
  • PARAM_LINK
  • PARAM_MULTI_LINK
  • PARAM_CONNECTION
  • PARAM_TO_STRING_LINK
  • STRING_LINK
  • STRING_MULTI_LINK
  • CURVE_LINK
  • CURVE_MULTI_LINK
  • SURFACE_LINK
  • REQUIRED_OBJECTS
  • EXPOSED_OBJECTS
  • PERSISTENT_OBJECTS
Common attrubutes
  • For all elements
  • Widgets
  • Param Widgets
  • Param Controls
  • Param Info Viewers
  • Text Widgets
  • Surface Viewers
  • Curve Viewers
  • Images
  • 3D Objects
Additional information
  • All attributes
  • Attribute types
  • Cursors
  • Math formulas
  • Scripting
    • Built-in addons
  • User experience
  • Errors and solutions
  • Built-in variables
  • Runtime model
  • Parameters mapping
  • Script converter
  • LetiMix
KUIMLReferenceSTRING_LINK
June 06, 2025

STRING_LINK

This element connects a string to another one: whenever the 'from' string changes, the 'to' string takes the 'from' string value.

Attributes brief detailed show all inherited

Name DescriptionDefault
fromIdentifier of the origin stringMandatoryempty
toIdentifier of the target stringMandatoryempty
Exposed: v. 1.4enabledEnables or disables the link'true'
Common attributesRead about `common`
idIdentifier of the elementThe id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.empty
Name Value type Default Description Comment
fromstring idemptyIdentifier of the origin stringMandatory
tostring idemptyIdentifier of the target stringMandatory
Exposed: v. 1.4enabledboolean'true'Enables or disables the link
Common attributesRead about `common`
ididentifieremptyIdentifier of the elementThe id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.

Examples

Link string_a to string_b, so that every time string_a changes, string_b follows.

  1. <!-- string -->
  2. <STRING id="string_a" default="Hello!" />
  3. <STRING id="string_b" default="World!" />

  4. <!-- link -->
  5. <STRING_LINK from="string_a" to="string_b" />

  6. <!-- controls -->
  7. <TEXT_FIELD string_id="string_a" />
  8. <TEXT_FIELD string_id="string_b" />

We can enable and disable links on the fly, like this:

  1. <!-- string -->
  2. <STRING id="string_a" default="Hello!" />
  3. <STRING id="string_b" default="World!" />
  4. <STRING id="result" default="" />

  5. <!-- link -->
  6. <STRING_LINK id="link_a" from="string_a" to="result" enabled="false" />
  7. <STRING_LINK id="link_b" from="string_b" to="result" enabled="false" />

  8. <!-- which link to enable -->
  9. <PARAM id="which_link" type="enumeration" enum_values="Off;Link A;Link B" />
  10. <PARAM_LINK from="which_link" to="link_a.enabled" formula="x==1" />
  11. <PARAM_LINK from="which_link" to="link_b.enabled" formula="x==2" />

  12. <!-- controls -->
  13. <TEXT_FIELD string_id="result" />
  14. <PARAM_TEXT_CONTROL param_id="which_link" content="link: {text_value}" />

We can also link to/from some string attributes of various elements (like KUIML_WIDGET.innerKUIML or PARAM.text_value)

  1. <STRING_LINK from="demo_param.text_value" to="my_string" />

  2. <PARAM id="demo_param" default="1.125345" max="100" />
  3. <STRING id="my_string" default="Hello!" />

  4. <!-- display and edit a string -->
  5. <PARAM_TEXT_CONTROL param_id="demo_param" content="param: {value}" />
  6. <ROW>
  7. <TEXT value="string" /><TEXT_FIELD string_id="my_string" />
  8. </ROW>

See more examples in "Changing text on the fly" tutorial.


Comments

Please, authorize to view and post comments.

2020 - 2026 © Site by LetiMix · Donate  |  Plug'n Script and KUIML by Blue Cat Audio