VarMap.HDVariablesItem Method

This method retrieves a variable item from the HDVariables collection. A HotDocs variable is identified by a name (varname) and type (vartype). The index parameter is a number which will return the indexth variable from the collection.

Syntax

void HDVariablesItem ( int index, out string varName, ref HotDocs.HDVARTYPE varType )

Parameters Description
index A number representing the position of the desired variable in the collection.
varName If the variable is found in the collection, then this will be set to the name of the variable. If the variable cannot be found, then this will be an empty ("") string.
varType When the method returns, this parameter will be set to the correct HDVARTYPE for the variable requested. It may be one of the following values:
  • HD_TEXTTYPE
  • HD_NUMBERTYPE
  • HD_DATETYPE
  • HD_TRUEFALSETYPE
  • HD_MULTCHOICETYPE