All commands regarding Variables

This is a consolidated list regarding all commands regarding Variables. Along with each command you will find a short description and usage example if applicable. However, there are links to more detailed articles provided on each of the command names.

 

Variables:

AppendVr
Append a value to the end of a variable.
«AppendVr('List','|',Name)»

 

GetV
Get a variable that was set using SetV and place it in the document.
«GetV('Amount')»

 

GetVn
Get the value of a variable used as a number.
«GetVn('Amount')»

 

GetVOrDefault
Get the value of a variable if it has been defined otherwise a default number.
«GetVOrDefault('amount',10)»

 

IncrementV
«IncrementV('Counter')»
«IncrementV('Total', UnitPrice)»
Add an amount to an XpressDox variable.

 

IncrementVr
«IncrementV('Counter')»
«IncrementV('Total', UnitPrice)»
Add an amount to an XpressDox variable and remove the paragraph.

 

PrependVr
«PrependVr('List','|',Name)»
Prefix values at the front of the variable.

 

SetV and SetVr
Set a variable to a value before it can be used in a template. Both of these commands set a variable, but SetVr also removes the paragraph.
«SetVr('Amount',0)»

 

Arrays:

Arrays are similar to variables and have a very similar set of functions to manipulate them.

ArrayAppendVr
ArrayClear
ArrayConcat
ArrayCount
ArrayDelete
ArrayGetV
ArrayGetVn
ArrayIncrementV
ArrayIncrementVr
ArrayKeys
ArrayRemoveDuplicates
ArraySetFromString
ArraySetV
ArraySetVr
ArraySortByIndex
ArraySortByValue
ArrayValues

 

Table of Contents