Help
Click here for email support.
Command and Functions List by alphabet or by category
Category quick links:
Conditional, Data Capture, Data Sources, Formatting Dates, Formatting Numbers, Formatting Strings, Miscellaneous, Post Merge, Repeating, Templates, and Variables.
Alphabetic List of Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| AlignCaptions | Sets whether captions on the interview should be aligned left or right
|
| BaseTemplate | Base (or overlay) this template on another template
|
| Caption | Set the caption for the data element on the interview screen
|
| CaptureAsLongText | Capture a multi-line text values
|
| CaptureDataElement | Places a control for the data element on the interview screen
|
| CaptureLater | Defer the capture of a data element to later in the interview
|
| ChooseFromData | Choose from a data in the data source
|
| ChooseFromDataSource | Choose a row from a data source
|
| ChooseFromFile | Choose data from a text or XML file
|
| ChooseFromList | Present the user with a list of choices in a drop down list
|
| ChooseFromRDBList | Present a radio button list of choices
|
| ChooseFromSamples | Presents a drop down list of choices, but the user can type their own if it is not in the list
|
| ChooseUsingCheckBox | Choose a value using a check box
|
| ComeHereAfterRun | Place a marker in the template where the cursor should be after the template has run.
|
| Comment | Places a comment into the template
|
| concat | Concatenates any number of string values
|
| contains | Test for a substring inside another string
|
| count | Count – returns the number of a repeated item
|
| CountOf | Get the number of occurrences of one string inside another
|
| CreateDataElement | Create a data element in the template’s data set.
|
| CurrencySymbol | Insert the currency symbol as defined in the Regional Settings
|
| Debug | Debug missing or superfluous ‘end’ and ‘else’ issues
|
| Define | Define the interview properties of a data element
|
| DocumentBody | Insert the body of the originating template into the Base Template
|
| Dolares | Render a numeric amount as a number of Dollars, in Spanish words
|
| Dollars | Render a numeric amount as a number of Dollars, in words
|
| DollarsFrancaise | Render a numeric amount as a number of Dollars, in French words
|
| EndsWith | Test whether a string ends in a given string
|
| EuroDeutsch | Render a numeric amount as a number of Euros, in German words
|
| EurosEspanol | Render a numeric amount as a number of Euros, in Spanish words
|
| EurosFrancaise | Render a numeric amount as a number of Euros, in French words
|
| ExcludeFromIV | Excludes a data element from the capture interview for the template
|
| ExtractInitials | Extract Initials from name
|
| Footing | Place footing text below a data element in the interview
|
| ForEach | Repeat for a number of repeating data elements
|
| FormatDate | Format a field as date and/or time
|
| FormatNumber | Format Number
|
| Gender | Return a value depending on a party’s gender
|
| GetListItem | Extract a value from a delimited list
|
| GetV | Get the value of a variable
|
| GetValidFileName | Get a string which only has valid file name characters
|
| HardSpace | Convert normal spaces to non-breaking spaces
|
| Heading | Place heading text above a data element in the interview
|
| Help | Provide help text (to be shown in the Help area) for a data element
|
| Hyperlink | Attach a hyperlink to a heading or footing
|
| If | Conditionally include text into the document
|
| IncludeDataSourceData | Include data from a data source
|
| IncludeFileData | Include data from a text or XML file
|
| IncludeTemplate | Include a template as part of this template
|
| IncludeTemplateText | Include the bare text of a template as part of this template
|
| IncrementDate | Increment a date
|
| IncrementV | Increment a variable value
|
| InsertFormattedText | Insert text captured as long text
|
| InsertTemplate | Insert a template whose name appears in a data element which is chosen by the user.
|
| InsertUnformattedLongText | Inserts text captured as “long” text but with no line breaks or formatting
|
| InterviewIsWizard | Specify whether the interview should be in Wizard form or not
|
| InterviewTitle | Set the title which will show on the Interview screen for this template
|
| last | Used in a ForEach to test whether the last repeating item is being referenced.
|
| LinkToDataSource | Link the control for any data element in the interview to a data source
|
| List | Produce a delimited list (e.g. commas and ‘and’) from repeating data
|
| Max | Gets the higher of two values
|
| MergePdfForm | Merge a PDF from after the currently running template
|
| MergeTemplate | Supply the name of another template to be merged
|
| Min | Gets the lower of two values
|
| Now | Insert the current date (i.e. today) and/or time into the document
|
| NumberPhrase | Format a number as words
|
| NumberToCurrency | Render a number as currency, in words
|
| OptimizeParsing | Optimize parsing of the template
|
| Ordinal | Ordinal (i.e. First, Second,…) inside ForEach
|
| OrdinalSuffix | Gets the suffix st, nd, rd, etc. of the ordinal of a number
|
| Pesos | Render a numeric amount as a number of Pesos, in Spanish words
|
| PlaceHolder | A placeholder in the interview to which text can be attached
|
| Plural | Get the singular or plural depending on the number.
|
| position | Get the position within a ForEach
|
| Pounds | Render a numeric amount as a number of Pounds, in words, UK English
|
| Rand | Render a numeric amount as a number of Rand in words, in English
|
| RandAfrikaans | Render a numeric amount as a number of Rand in words, Afrikaans
|
| RemoveParagraph | Remove the paragraph after the template has merged.
|
| RenderAsNumeric | Force a string to be a valid numeric value
|
| Replace | Replace all occurrences of a specified string with another
|
| ReplaceField | Replace a Fillpoint in the Base Template
|
| Required | Mark a data element as required – must have a non-empty value
|
| RequiredVersion | Allows the template author to prevent a template running if the installed version of XpressDox is too low.
|
| RestrictToLicenses | Supply licence serial numbers for this template
|
| round | Round a value to the nearest integer
|
| Rule | Applies a custom made validation rule to the data element in the interview process
|
| RunTemplates | Specify a number of templates to be run when this template is run.
|
| RunWordMacro | Run a Word macro after the template has been merged.
|
| SaveAsPDF | Specify that a merged document must be saved as PDF
|
| Script | Define a chunk of document for re-use
|
| SendWebEmail | Set all the properties to send an email from a Web based template
|
| SetCustomDocumentProperty | Sets a custom document property in the merged document.
|
| SetDocumentName | Set the document name (referenced as).
|
| SetInitialValue | Sets the initial value for a data element that is to be captured
|
| SetInterviewDataOnly | Set the option that a template is destined only for data capture
|
| SetMultipleDocumentFilter | Sets a filter applying to the Document Per Repeated Item feature
|
| SetSavedDataFileName | Set the file name of the data that was captured in an interview for the template.
|
| SetSavedDataFolder | Sets the folder where the data captured in the interview will be saved.
|
| SetSavedDocumentFileName | Set the file name of the merged document.
|
| SetSavedDocumentFolder | Set the folder where the merged document will be saved.
|
| SetSavedDocumentNameVersioning | Set the option governing the versioning of the merged document file name (default is ON)
|
| SetV | Set a variable value
|
| SetVR | Set a variable value and remove the paragraph
|
| SetWebButtonText | Sets the text to be shown in the “Assemble Document” button on the web interview
|
| SetWebReturnURL | Set the return URL for a web-based template
|
| ShowIfHasValue | Show the item only if it has a non-empty value
|
| starts-with | Test whether a value starts with a given string
|
| StartsWithVowel | Test whether a string starts with a vowel
|
| string-length | Returns the number of characters in a value
|
| substring | Extract a portion of a string
|
| substring-after | Extract the substring after a given string
|
| substring-before | Extract the substring before a given string
|
| sum | Calculate the sum of values
|
| Tab | Add a tab to the main panel of the interview screen
|
| TableLookup | Calculate a value from a table
|
| Today | Insert the current date into the document
|
| ToLower | Convert to lower case
|
| ToSentence | Convert to Sentence case
|
| ToTitle | Convert to Title Case
|
| ToUpper | Convert to UPPER case
|
| Trim | Removes white space from either side of a string
|
| UseScript | Insert the contents of a script defined in another part of the template.
|
| When | Provide condition for including small text values (e.g. for gender or plural handling)
|
| WindowsLogonUser | Returns the user name with which the current user logged on to Windows
|
Categorized List of Commands and Functions
Conditional Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| contains | Test for a substring inside another string
|
| count | Count – returns the number of a repeated item
|
| EndsWith | Test whether a string ends in a given string
|
| If | Conditionally include text into the document
|
| ShowIfHasValue | Show the item only if it has a non-empty value
|
| starts-with | Test whether a value starts with a given string
|
| StartsWithVowel | Test whether a string starts with a vowel
|
| string-length | Returns the number of characters in a value
|
| When | Provide condition for including small text values (e.g. for gender or plural handling)
|
Data Capture (Interview) Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| AlignCaptions | Sets whether captions on the interview should be aligned left or right
|
| Caption | Set the caption for the data element on the interview screen
|
| CaptureAsLongText | Capture a multi-line text values
|
| CaptureDataElement | Places a control for the data element on the interview screen
|
| CaptureLater | Defer the capture of a data element to later in the interview
|
| ChooseFromData | Choose from a data in the data source
|
| ChooseFromList | Present the user with a list of choices in a drop down list
|
| ChooseFromRDBList | Present a radio button list of choices
|
| ChooseFromSamples | Presents a drop down list of choices, but the user can type their own if it is not in the list
|
| ChooseUsingCheckBox | Choose a value using a check box
|
| Define | Define the interview properties of a data element
|
| ExcludeFromIV | Excludes a data element from the capture interview for the template
|
| Footing | Place footing text below a data element in the interview
|
| Heading | Place heading text above a data element in the interview
|
| Help | Provide help text (to be shown in the Help area) for a data element
|
| Hyperlink | Attach a hyperlink to a heading or footing
|
| InterviewIsWizard | Specify whether the interview should be in Wizard form or not
|
| InterviewTitle | Set the title which will show on the Interview screen for this template
|
| OptimizeParsing | Optimize parsing of the template
|
| PlaceHolder | A placeholder in the interview to which text can be attached
|
| Required | Mark a data element as required – must have a non-empty value
|
| RequiredVersion | Allows the template author to prevent a template running if the installed version of XpressDox is too low.
|
| Rule | Applies a custom made validation rule to the data element in the interview process
|
| SetInitialValue | Sets the initial value for a data element that is to be captured
|
| SetInterviewDataOnly | Set the option that a template is destined only for data capture
|
| Tab | Add a tab to the main panel of the interview screen
|
Data Sources Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| ChooseFromDataSource | Choose a row from a data source
|
| ChooseFromFile | Choose data from a text or XML file
|
| IncludeDataSourceData | Include data from a data source
|
| IncludeFileData | Include data from a text or XML file
|
| LinkToDataSource | Link the control for any data element in the interview to a data source
|
Formatting Dates Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| FormatDate | Format a field as date and/or time
|
| IncrementDate | Increment a date
|
| Now | Insert the current date (i.e. today) and/or time into the document
|
| Today | Insert the current date into the document
|
Formatting Numbers Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| CurrencySymbol | Insert the currency symbol as defined in the Regional Settings
|
| Dolares | Render a numeric amount as a number of Dollars, in Spanish words
|
| Dollars | Render a numeric amount as a number of Dollars, in words
|
| DollarsFrancaise | Render a numeric amount as a number of Dollars, in French words
|
| EuroDeutsch | Render a numeric amount as a number of Euros, in German words
|
| EurosEspanol | Render a numeric amount as a number of Euros, in Spanish words
|
| EurosFrancaise | Render a numeric amount as a number of Euros, in French words
|
| FormatNumber | Format Number
|
| GetListItem | Extract a value from a delimited list
|
| Max | Gets the higher of two values
|
| Min | Gets the lower of two values
|
| NumberPhrase | Format a number as words
|
| NumberToCurrency | Render a number as currency, in words
|
| OrdinalSuffix | Gets the suffix st, nd, rd, etc. of the ordinal of a number
|
| Pesos | Render a numeric amount as a number of Pesos, in Spanish words
|
| Pounds | Render a numeric amount as a number of Pounds, in words, UK English
|
| Rand | Render a numeric amount as a number of Rand in words, in English
|
| RandAfrikaans | Render a numeric amount as a number of Rand in words, Afrikaans
|
| round | Round a value to the nearest integer
|
| sum | Calculate the sum of values
|
| TableLookup | Calculate a value from a table
|
Formatting Strings Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| CountOf | Get the number of occurrences of one string inside another
|
| ExtractInitials | Extract Initials from name
|
| Gender | Return a value depending on a party’s gender
|
| GetValidFileName | Get a string which only has valid file name characters
|
| HardSpace | Convert normal spaces to non-breaking spaces
|
| InsertFormattedText | Insert text captured as long text
|
| InsertUnformattedLongText | Inserts text captured as “long” text but with no line breaks or formatting
|
| List | Produce a delimited list (e.g. commas and ‘and’) from repeating data
|
| Plural | Get the singular or plural depending on the number.
|
| RenderAsNumeric | Force a string to be a valid numeric value
|
| Replace | Replace all occurrences of a specified string with another
|
| substring | Extract a portion of a string
|
| substring-after | Extract the substring after a given string
|
| substring-before | Extract the substring before a given string
|
| ToLower | Convert to lower case
|
| ToSentence | Convert to Sentence case
|
| ToTitle | Convert to Title Case
|
| ToUpper | Convert to UPPER case
|
| Trim | Removes white space from either side of a string
|
| WindowsLogonUser | Returns the user name with which the current user logged on to Windows
|
Miscellaneous Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| Comment | Places a comment into the template
|
| Debug | Debug missing or superfluous ‘end’ and ‘else’ issues
|
| RunTemplates | Specify a number of templates to be run when this template is run.
|
| SetMultipleDocumentFilter | Sets a filter applying to the Document Per Repeated Item feature
|
Post Merge Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| RunWordMacro | Run a Word macro after the template has been merged.
|
| SaveAsPDF | Specify that a merged document must be saved as PDF
|
| SetCustomDocumentProperty | Sets a custom document property in the merged document.
|
| SetDocumentName | Set the document name (referenced as).
|
| SetSavedDataFileName | Set the file name of the data that was captured in an interview for the template.
|
| SetSavedDataFolder | Sets the folder where the data captured in the interview will be saved.
|
| SetSavedDocumentFileName | Set the file name of the merged document.
|
| SetSavedDocumentFolder | Set the folder where the merged document will be saved.
|
| SetSavedDocumentNameVersioning | Set the option governing the versioning of the merged document file name (default is ON)
|
Repeating Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| ForEach | Repeat for a number of repeating data elements
|
| last | Used in a ForEach to test whether the last repeating item is being referenced.
|
| Ordinal | Ordinal (i.e. First, Second,…) inside ForEach
|
| position | Get the position within a ForEach
|
Templates Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| BaseTemplate | Base (or overlay) this template on another template
|
| ComeHereAfterRun | Place a marker in the template where the cursor should be after the template has run.
|
| DocumentBody | Insert the body of the originating template into the Base Template
|
| IncludeTemplate | Include a template as part of this template
|
| IncludeTemplateText | Include the bare text of a template as part of this template
|
| InsertTemplate | Insert a template whose name appears in a data element which is chosen by the user.
|
| MergePdfForm | Merge a PDF from after the currently running template
|
| MergeTemplate | Supply the name of another template to be merged
|
| ReplaceField | Replace a Fillpoint in the Base Template
|
| RestrictToLicenses | Supply licence serial numbers for this template
|
| Script | Define a chunk of document for re-use
|
| UseScript | Insert the contents of a script defined in another part of the template.
|
Variables Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| concat | Concatenates any number of string values
|
| CreateDataElement | Create a data element in the template’s data set.
|
| GetV | Get the value of a variable
|
| IncrementV | Increment a variable value
|
| RemoveParagraph | Remove the paragraph after the template has merged.
|
| SetV | Set a variable value
|
| SetVR | Set a variable value and remove the paragraph
|
Web Commands and Functions
| Command or Function Name | Description and Examples |
|---|---|
| SendWebEmail | Set all the properties to send an email from a Web based template
|
| SetWebButtonText | Sets the text to be shown in the “Assemble Document” button on the web interview
|
| SetWebReturnURL | Set the return URL for a web-based template
|
Comments on this entry are closed.