windowOnHDStart Property
[Deprecated] Use HDAPI.RegisterHandler to register for the "OnHDStart" event instead.

JavaScript API: Direct
Assembly: api.js Version: 1.0.0.0 (1.0.0.0)
Syntax
JavaScript
Copy
var OnHDStart

Field Value

Type: function
Remarks
This function (if defined in the global namespace) is called when an interview is fully loaded and initialized in the browser, but before the user has a chance to interact with the interview. For example, if you want to dictate that the user should begin the interview at any dialog other than the first one, you could implement the OnHDStart callback function and call the HDAPI.GotoInterviewBookmark function to set an alternate starting point for the user's interview.

This callback function was deprecated in HotDocs Server 10.0.2. Although it can still be used, its functionality is now available in a more versatile manner using the HDAPI.RegisterHandler method.

Examples

The following example navigates the interview to a specific dialog ("bookmark") when the interview first loads:

JavaScript
Copy
function OnHDStart()
{
    HDGotoInterviewBookmark('Job Information|1');
}
See Also

Reference

Legacy API
Direct JavaScript API