Quick Reference—Field Properties

The following tables describe properties you can assign to the different field types in your HotDocs Models. For a full description of each property, see Define Field Properties. Default values are in parentheses.

Text Variable Properties

Property Name	Value	Where It Can Be Used
name	text	Variable field
title	text	Variable field Variable table
prompt	text	Variable field Variable table
resource	text	Variable field Variable table
format	(none) upper lower title sentence	Variable field Variable table
nonbreak	(no) yes	Variable field Variable table
height	(0) Number between 1 and 12 By default, HotDocs displays one-line answer fields	Variable field Variable table
max	(0) Number between 1 and 15,000 By default, HotDocs lets you enter any number of characters between 1 and 15,000.	Variable field Variable table
pattern	(none) (999) 999-9999 999-99-9999 99:99 99:99am	Variable field Variable table
enter	(break) paragraph	Variable field Variable table
ask	(yes) no	Variable field Variable table
warn	(yes) no	Variable field Variable table
save	(yes) no	Variable field Variable table
irrelevant	(gray) hide show	Variable field Variable table
unanswered	Any text you enter	Variable field Variable table
font	(font used in document) Font Name	Variable field
comment	text	Variable field Variable table

Number Variables

Property Name	Value	Where It Can Be Used
name	text	Variable field
title	text	Variable field Variable table
prompt	text	Variable field Variable table
resource	text	Variable field Variable table
format	alpha ordinal 09 9 1/8 9,999.00 9.9 9999 9th IX Nine Dollars and Twelve Cents	Variable field Variable table
nonbreak	(no) yes	Variable field Variable table
minimum	(0) any number	Variable field Variable table
maximum	(0) any number	Variable field Variable table
decimal	(0) any number between 1 and 7	Variable field Variable table
currency	($) £ € DM Any currency (3 characters or less)	Variable field Variable table
ask	(yes) no	Variable field Variable table
warn	(yes) no	Variable field Variable table
save	(yes) no	Variable field Variable table
irrelevant	(gray) hide show	Variable field Variable table
unanswered	Any text you enter	Variable field Variable table
font	(font used in document) Font Name	Variable field
comment	text	Variable field Variable table

Date Variables

Property Name	Value	Where It Can Be Used
name	text	Variable field
title	text	Variable field Variable table
prompt	text	Variable field Variable table
resource	text	Variable field Variable table
format	d dd dth dy m mm mn mnt y yy yyyy yr wd wdy	Variable field Variable table
nonbreak	(no) yes	Variable field Variable table
ask	(yes) no	Variable field Variable table
warn	(yes) no	Variable field Variable table
save	(yes) no	Variable field Variable table
irrelevant	(gray) hide show	Variable field Variable table
unanswered	Any text you enter	Variable field Variable table
font	(font used in document) Font Name	Variable field
comment	text	Variable field Variable table

True/False Variables

Property Name	Value	Where It Can Be Used
name	text	Variable field Variable table
title	text	Variable field Variable table
prompt	text	Variable field Variable table
resource	text	Variable field Variable table
format	/x true/false x/ yes/no truetext/falsetext	Variable field Variable table
style	(row) column	Variable field Variable table
nonbreak	(no) yes	Variable field Variable table
ask	(yes) no	Variable field Variable table
warn	(yes) no	Variable field Variable table
save	(yes) no	Variable field Variable table
irrelevant	(gray) hide show	Variable field Variable table
unanswered	Any text you enter	Variable field Variable table
font	(font used in document) Font Name	Variable field
comment	text	Variable field Variable table

Multiple Choice Variables

Property Name	Value	Where It Can Be Used
name	text	Variable field
title	text	Variable field Variable table
prompt	text	Variable field Variable table
resource	text	Variable field Variable table
format (multiple-select variables)	a, and b a, b a, b and c A, b and c A, B AND C A, B and C a, b or c a, b, and c a; b; and c	Variable field Variable table
format (single-select variables)	upper lower title sentence	Variable field Variable table
options	text	Variable field Variable table
optionprompts	text	Variable field Variable table
optionresources	text	Variable field Variable table
merge	text	Variable field Variable table
select	(single) multiple	Variable field Variable table
other	(no) yes	Variable field Variable table
none	(no) yes	Variable field Variable table
style	(dropdown) (grid) column list	Variable field Variable table
nonbreak	(no) yes	Variable field Variable table
ask	(yes) no	Variable field Variable table
warn	(yes) no	Variable field Variable table
save	(yes) no	Variable field Variable table
irrelevant	(gray) hide show	Variable field Variable table
unanswered	Any text you enter	Variable field Variable table
font	(font used in document) Font Name	Variable field
comment	text	Variable field Variable table

Computation Variables

Property Name	Value	Where It Can Be Used
name	text	Variable field
script	A valid HotDocs script	Variable field Variable table
merge	text	Variable field Variable table This property can be used when the Computation field generates a true/false value.
nonbreak	(no) yes	Variable field Variable table
unanswered	Any text you enter	Variable field Variable table
font	(font used in document) Font Name	Variable field
comment	text	Variable field Variable table

Dialogs

Property Name	Value	Where It Can Be Used
name	text	Dialog table
title	text	Dialog table
resource	text	Dialog table
contents	names of variables, dialogs, and/or dialog text variables	Dialog table
group	(none) single multiple	Dialog table
style	(regular) repeated spreadsheet ssonparent	Dialog table
label	text	Dialog table
prompt	text	Dialog table
rows	(3) number	Dialog table
ask	(yes) no	Dialog table
irrelevant	(hide) show	Dialog table
none	(no) yes	Dialog table

Repeat Fields

Property Name	Value	Where It Can Be Used
name	text	Repeat field Dialog table
format	a, and b a, b a, b and c A, b and c A, B AND C A, B and C a, b or c a, b, and c a; b; and c	Repeat field Dialog table
title	text	Repeat field Dialog table
resource	text	Repeat field Dialog table
contents	names of variables, dialogs, and/or dialog text variables	Repeat field Dialog table
group	(none) single multiple	Repeat field Dialog table
style	(regular) repeated spreadsheet ssonparent	Dialog table
label	text	Repeat field Dialog table
prompt	text	Repeat field Dialog table
rows	(3) number	Repeat field Dialog table
ask	(yes) no	Repeat field Dialog table
irrelevant	(hide) show	Repeat field Dialog table
none	(no) yes	Repeat field Dialog table
ascend	VariableName	Repeat field Dialog table
descend	VariableName	Repeat field Dialog table
filter	ComputationVariableName	Repeat field Dialog table
comment	text	Repeat field Dialog table

Insert Fields

Property Name

Value

Where It Can Be Used

keep

header

footer

both

Insert field

comment

text

Insert field

Span Fields

Property Name	Value	Where It Can Be Used
title	text	Span field
comment	text	Span field

Language Fields

Property Name	Value	Where It Can Be Used
decimal	decimal separator character	Language field
grouping	thousands separator character	Language field