Join Text
Verb: joinText
Joins, in a single text, all elements of a list of the "Text" type, also being able to add spacing or characters to separate each element of the list.
Syntax
joinText --list(List<String>) --delimiter(JoinDelimiter) [--standarddelimiter(StandardDelimiters)] --repetitions(Numeric) --customDelimiter(String) (String)=value
Inputs
| Script | Designer | Required | AcceptedTypes | Description |
|---|---|---|---|---|
| --list | Text List | Required | List<Text> | "Text" type list that contains the elements that should be joined to create new text. |
| --delimiter | Delimiter | Required | JoinDelimiter | Type of delimiter to be used between the elements of Text List, with the following options available:
|
| --standarddelimiter | Standard delimiter | Optional | StandardDelimiters | Spacing delimiters used between the elements of Text List, the available choices are:
|
| --repetitions | Number of delimiter repetitions | Only whenDelimiter is Standard | Number | Number of times the delimiter is added between list elements. |
| --customDelimiter | Custom delimiter | Only whenDelimiter is Custom | Text | Character or string used to separate elements from Text List. |
Outputs
| Script | Designer | AcceptedTypes | Description |
|---|---|---|---|
| value | Text | Text | Resulting text from joining all elements of Text List, with the chosen delimiter between each element. |
Example
Example 1: Join text elements contained in "elementList" using Space as a delimiter between each list element.
defVar --name elementsList --type List --innertype String --value "[Text,to be,joined]"
defVar --name joinedText --type String
// Join all list elements.
joinText --list ${elementsList} --delimiter "Standard" --standarddelimiter "Space" --repetitions 1 joinedText=value
logMessage --message "${joinedText}" --type "Info"
// This example produces the following result:
// Text to be joined.
Example 2: Join text elements contained in "elementList" using Custom delimiter and choosing the character "%" as the delimiter between the list elements.
defVar --name elementsList --type List --innertype String --value "[text,to be,joined]"
defVar --name joinedText --type String
// Join all list elements.
joinText --list ${elementsList} --delimiter "Custom" --customDelimiter "%" joinedText=value
logMessage --message "${joinedText}" --type "Info"
// This example produces the following result:
// Text%to be%joined.
Remarks
The 3 options to choose from Delimiter and their functions are:
None: No separator type is added between the Text List elements when joining them.
Standard: A default separator (spacing, line break, or tab) is added between the Text List elements when joining them. This separator can be chosen through the Standard delimiter parameter.
Customized: A character/character delimiter is added between the Text List elements when joining them. This character delimiter can be inserted through the Custom delimiter parameter.