Instruction | Description |
ascend var; descend var | The ascend instruction sorts lists of answers (gathered using a repeat instruction) in alphanumeric order, from 1 to 9, and from A to Z. The descend instruction sorts lists of answers from 9 to 1, and from Z to A. |
ask dialog | The ask dialog instruction allows you to control the order in which dialogs appear in an interview. |
ask var | Sometimes a variable needs to be asked by itself. You can use the ask var instruction so that during the interview, HotDocs displays the variable in its own default dialog. |
default var to value | This instruction suggests a value for a variable if the variable is unanswered. |
filter computation_var | The filter instruction filters out certain entries from a repeated list, based on conditions you specify. |
format "list_format" | The format "list_format" instruction allows you to create a sentence-style list within a computation. |
if expression; elseIf; else; endIf | You can make sections of a HotDocs Model conditional by using if instructions. You can also make instructions or expressions in a script conditional. A conditional section will be included only if a condition you specify is true. The elseIf instruction allows two or more conditions to be included in an if instruction. The else instruction establishes a final condition for an if instruction, specifying that if all preceding conditions are false, the following information should be included. It must be the last item of the if instruction. |
increment num_var; decrement num_var | The increment and decrement instructions cause HotDocs to increase or decrease a number variable, usually a counter, by the value of 1. |
insert "filename" | This instruction inserts another HotDocs Model into the document currently being assembled. When HotDocs encounters an insert instruction, it immediately processes the instruction and inserts the model into the current document. If there are variables to be answered, HotDocs presents them before finishing the interview of the main document. |
language code | This instruction tells HotDocs to format numbers and dates in a particular language. |
repeat dialog; endRepeat | A repeat instruction gathers lists of answers and merges them into a document. |
set var to value | This instruction lets you specify a given value for a variable’s answer automatically, rather than allow the user to specify an answer. With the set instruction, you can transfer names and other values from one variable to another. |
while expression; endWhile | The while expression instruction allows you to repeatedly process (or loop through) an answer or set of answers until a certain condition is met, such as a certain answer is found or a limit is reached. |