PLUG'N SCRIPT
rapid plugin development
Tutorial
DSP
KUIML
How-to
Scripts
  • Tutorial
  • Element Reference
Language basics
  • SKIN
  • DUMMY
  • INCLUDE
  • INCLUDE_ONCE
  • DEFINE
  • UNDEFINE
  • VARIABLE
  • LOCAL_VARIABLE
  • TEMPLATE
  • TEMPLATE_INNER_CONTENT
  • REPEAT
Data model
  • PARAM
  • ACTION
    • Action types
  • ACTION_TRIGGER
UI Layout and positioning
  • CELL
  • TABLE
UI Widgets
  • TEXT
  • TEXT_FIELD
  • TEXT_EDIT_BOX
  • CANVAS
    • Graphics API
  • svg
Common attrubutes
  • For all elements
  • Widgets
  • Param Widgets
  • Param Controls
  • Param Info Viewers
  • Text Widgets
  • Surface Viewers
  • Curve Viewers
  • 3D Objects
  • Parameters mapping
KUIMLElement ReferenceSTRING
December 05, 2022

STRING

This element can be used to create custom strings.

Attributes brief detailed show all inherited

Name DescriptionDefault
defaultString default value0
nameDisplayed named of the stringempty
commentComment about the stringempty
persistentSets the persistency of the stringWhen this property is set to 'true', the string will be saved when closing the user interface and the value will be restored next time the user interface is openedfalse
exposedMake string available for scriptsWhen this property is set to 'true', the string will be exposed to the scripting engine. It can be also achieved via "requires" attribute in SCRIPT, ACTION or ACTION_TRIGGER, as well as via EXPOSED_OBJECTS element.false
Read Only Attributes
Exposed: v. 2.0lengthlength of the string
Name Value type Default Description Comment
defaultstring0String default value
namestringemptyDisplayed named of the string
commentstringemptyComment about the string
persistentbooleanfalseSets the persistency of the stringWhen this property is set to 'true', the string will be saved when closing the user interface and the value will be restored next time the user interface is opened
exposedbooleanfalseMake string available for scriptsWhen this property is set to 'true', the string will be exposed to the scripting engine. It can be also achieved via "requires" attribute in SCRIPT, ACTION or ACTION_TRIGGER, as well as via EXPOSED_OBJECTS element.
Read Only Attributes
Exposed: v. 2.0lengthintegerlength of the string

Examples

The following example creates a string which default value is "Hello!" and adds the TEXT widget to display it:

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <SKIN>
  3. <STRING id="my_string" default="Hello!" />
  4. <TEXT string_id="my_string" />
  5. </SKIN>

 


Comments

2020 © Plug'n Script and KUIML by Blue Cat Audio  |  Site by LetiMix