Global Variables

The Legacy API exposes the following members.

Variables

  Name Description
Public field HDBottomMargin
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".
Public field Code example HDDisableBrowserWarning
By default HotDocs browser interviews display a warning during interview initialization if an unsupported browser or operating system is detected. Setting this variable to true suppresses that warning.
Public field HDDisableFinishWarning
When set to true, 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 false.)
Public field HDDisableOnSubmit
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.
Public field HDInterviewHeight
The requested height of the HotDocs browser interview. If not specified, the default value is "auto" (see Remarks below).
Public field HDInterviewLocale
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).
Public field HDInterviewOutlineWidth
Specifies the initial width (in pixels) for the interview outline component of the interview outline.
Public field HDInterviewWidth
The requested width of the HotDocs browser interview. If not specified, the default value is "auto" (see Remarks below).
Public field HDLeaveWarning
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.
Public field HDRequiredAsterisk
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.
Public field HDResourcePaneHeight
Specifies the initial height (in pixels) of the resource pane. Defaults to 100 if not specified.
Public field OnHDFinish
[Deprecated] Use HDAPI.RegisterHandler to register for the "OnHDFinish" event instead.
Public field Code example OnHDStart
[Deprecated] Use HDAPI.RegisterHandler to register for the "OnHDStart" event instead.
Public field Code example PreHDRender
[Deprecated] Use HDInterviewOptions.OnInit instead. This function is called before HotDocs builds the interview. You can use this function to perform any interview preprocessing, such as adding custom buttons to the interview toolbar or registering for interview events.
Public field Code example PreHDSubmit
[Deprecated] Use HDAPI.RegisterHandler to register for the "PreHDSubmit" event instead.
Top
See Also

Reference