Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


UI Text Box
sizemedium
typeinfo

This function creates a variable for storing a text value, and directly setsvalue.

This value will be immediately returned and can be accessed by the getString() function, when used function afterwards within the same expression.


Code Block
languagebash
titleSyntax
linenumberstrue
setString(variableName, value) #Output: Text


UI Expand
titleExamples


Expression parserDescription


Code Block
languagebash
linenumberstrue
setString("myStringmyText","Hello World!")


This example creates the variable "myStringmyText" and , sets the value "Hello World!" and returns it accordingly.



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
variableName

Status
subtletrue
titletext

A text for the variable name.
value

Status
subtletrue
titletext

The text value to be stored.



UI Expand
titleOutput

This function returns a 

Status
subtletrue
titletext


UI Text Box
typetip

To retrieve the value stored in the variable, use the function getString() within the same expression.



Page properties
hiddentrue



Status
Tech review

Status
colourYellowGreen
titleReady for reviewdone

Style guide

Status
colourGreen
titledone

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged



Page properties
hiddentrue


Short description

Creates a variable to temporarily store a text.

Output

Status
subtletrue
titletext

Available since

Status
subtletrue
colourBlue
title2.6.0

Label