True/False Variable Overview

A true/false variable is a type of variable that represents an unknown true/false value. For example, if you want to place a certain word or phrase into the assembled document based on the template user's answer to a true or false question, you would create a true/false variable to capture the template user's true or false response.

Overview

In HotDocs, a true/false variable is a component that represents an unknown answer to a true/false question in your template (i.e. a true/false value, such as). While you can use a true/false variable to capture true/false answers, the true/false is variable is most useful for creating conditional regions (e.g. a section of a document you want to include based on a template user's answer, such as whether or not they are married or have children.) You can create true/false variables using the HotDocs Field Editor or Component Studio and true/false variables are typically:

Like other components, true/false variables have properties that you can set to define how they perform in an interview and how HotDocs processes the date variable in an assembled document. In fact, true/false variables have a number of unique properties, which you can review below.

Common Tasks

Among others, true/false variables enable you to accomplish the following common tasks:

Workflow

When you create a template from an existing document, the existing document usually contains sections that you would include or exclude based on the template user's answer to a true/false question. To enable template users to provide their answer to the true/false question and to have a section of your template included or excluded based on that answer, you:

When creating a true/false variable, you can set properties that define how to gather the true/false value from a template user, how HotDocs stores that true/false value as an answer, and how to format that answer when assembling a document. For example, you start by setting the name property for the true/false variable, which is used to identify the true/false variable throughout Author and in the answer file. You can set the Prompt property to provide instructive text (as opposed to the true/false variable name) to help a template user answer a question during the interview. You can also set the Default format property to define the pattern that HotDocs uses to format the template user's answer in the assembled document (such as). Lastly, you can then group related true/false (and other) variables into dialogs to improve the usability and flow of an interview.

Once you have created the true/false variable and set all of the properties you need, you can use the test feature to ensure the variable will behave as you desire when the document is assembled.

 

 

Common Reference Topics

Among others, the following reference topics may relate to this conceptual area: