HotDocs_Online.VariableCollection Object

A VariableCollection provides a "data dictionary" of all variables used in a template. HotDocs Server uses the VariableCollection when creating the browser-based interview, to decide which answers in an AnswerCollection should be used to pre-populate the interview and which should be ignored. Host applications may also use a VariableCollection for purposes of providing the necessary data for a specific template.

A VariableCollection object is created based on a template manifest file (published from current versions of HotDocs) or a legacy .HVC file (published from versions prior to 11).

Each variable in the VariableCollection object is assigned an arbitrary index number in the range of 0 to Count - 1. Use this index number to iterate through the collection.

Interface Information

Methods

Method	Description
Open	This method opens the template manifest (.manifest.xml) or variable collection (.HVC) file and populates the variable collection object. (You must use this method first if you plan to use the VariableCollection object.)

Properties

Property	Description
Count	[Read-only] This property returns the number of variables in a variable collection.
Description	[Read-only] This property returns the template description.
Title	[Read-only] This property returns the template title.
VarEncodedName	[Read-only] This property returns the URL-encoded name HotDocs Server uses in the interview. This method was deprecated in HotDocs Server 11.
VarName	[Read-only] This property returns the encoded name of the variable at the specified index.
VarType	[Read-only] This property returns a number corresponding to the variable type. These values are enumerated in the ansType enumeration.
VCHandle	[Read-only] This property provides an identifier to a variable collection. As a read-only property, you cannot modify this identifier.