HDInterviewOptions Object

This object, if you define it in the global scope in JavaScript, will be used by HotDocs during interview initialization. Any properties you leave off your HDInterviewOptions object will inherit the default behavior. Likewise, if you do not declare an HDInterviewOptions object at all, all properties will inherit the default behavior as dictated by the server.

JavaScript API: Direct
Assembly: api.js Version: 1.0.0.0 (1.0.0.0)

Syntax

JavaScript

Copy

Direct.HDInterviewOptions = function();

Type.createClass(
	'Direct.HDInterviewOptions');

The HDInterviewOptions type exposes the following members.

Methods

	Name	Description
	OnInit	This method, if present on the HDInterviewOptions object, will be called before HotDocs builds the interview. You can use this method to perform any necessary interview pre-processing or customization, such as adding custom buttons to the interview toolbar or registering interview event handlers.

Top

Properties

	Name	Description
	BrowserWarning	By default HotDocs browser interviews display a warning during interview initialization if an unsupported browser or operating system is detected. Setting this variable to false suppresses that warning.
	DisableOnSubmit	This determines whether or not buttons, input fields, and other controls on the interview are disabled (by overlaying them with a translucent HTML DIV) when answers are being submitted to the server. The default is true.
	FinishWarning	When set to false, suppresses the browser interview's default behavior of warning the user before he or she submits an interview accidentally or which may be in an incomplete state. (The default value is true.)
	FooterHeight	The number of pixels to reserve below the browser interview when HDInterviewOptions.Height (or formerly, HDInterviewHeight) is set to "auto" and the actual height of the interview's HTML DIV is being calculated. Irrelevant when HDInterviewOptions.Height is set to anything other than "auto".
	Height	The requested height of the HotDocs browser interview. If not specified, the default value is "auto" (see Remarks below).
	LanguageModule	An object (associative array) containing one or more language modules to load. The name of each item in array is the name of the language module (e.g., "en-GB") and the value is the URL from which the JavaScript file containing the language module can be downloaded.
	LeaveWarning	Specifies whether the end user will be warned if they try to close or navigate away from the interview page without submitting their answers to the host application.
	LoadingTimeout	[int] The number of seconds to wait for interview definitions to load. The default is 30. If you set this to a number less than or equal to 0, the interview will wait indefinitely.
	Locale	The name of the language module that will be loaded and used by HotDocs when presenting this interview. Browser language modules dictate date and number formatting, calendars, all built-in user interface text, etc. The name is formed by combining a two-letter language code with a regional code; If no value is specified, the default is "en-US" (US English).
	OutlineWidth	Specifies the initial width (in pixels) for the interview outline component of the interview outline.
	ProgressBar	Determines whether the interview progress bar (new for HotDocs 11) is displayed or not. The default is true.
	RequiredAsterisk	Specifies whether an asterisk will be appended to the prompt of any variable for which a value is always required. Such prompts are normally highlighted in an alternate color (as dicatated by the interview style sheet) until they have been answered, but this option causes asterisks to be shown as well (even after the variables have been answered). Defaults to false.
	ResourceHeight	Specifies the initial height (in pixels) of the resource pane. Defaults to 100 if not specified.
	SplashScreen	An object (associative array) containing the definition of a custom splash screen to display while the interview is loading.
	Width	The requested width of the HotDocs browser interview. If not specified, the default value is "auto" (see Remarks below).

Top

Remarks

HDInterviewOptions was introduced in HotDocs 11 as a way to consolidate the many separate global variables used to initialize various interview options in prior versions of HotDocs Server. Those "legacy" global variables (e.g., HDInterviewWidth) are still available and functional, but they are now deprecated and new (or updated) integrations should use HDInterviewOptions instead.

Examples

JavaScript

Copy

HDInterviewOptions = { Width: 800, Height: 500, Locale: "de-DE" }

Reference

Direct JavaScript API