HD$ GetInterviewBookmark Method  
This function returns a string (up to 70 characters in length) that represents the user's current location in the interview, including the input field that contains the focus. For example, you can call this function before the user leaves the interview, in order to submit a bookmark for the user's current location to the server along with the user's answers. Later, you could use the GotoInterviewBookmark(String, function) method to return the user to the same location in the interview.

 

JavaScript API: Embedded
Assembly: hotdocs.js Version: 1.0.0.0 (1.0.0.0)
Syntax
 
 
JavaScript
 
Copy
function GetInterviewBookmark(callback);

Parameters

callback
Type: function
A function to which the requested interview bookmark will be passed.
Remarks
 
Bookmarks are simple strings, defined as follows. For variables appearing outside a dialog, the bookmark is simply the variable name. For dialogs, a bookmark looks like this:
"Dialog Name|Dialog item index|Repeat Index"

If the current answer set changes between the time the bookmark is created and when it is used, the bookmark may no longer be valid. For example, if you create a bookmark to the 5th repetition of a repeated dialog, but later delete answers so there are only four repetitions, that bookmark will no longer be valid. Calling GotoInterviewBookmark(String, function) with an invalid bookmark string will not have any effect.

This function was introduced in HotDocs Server 10.

See Also
 

Reference

HD$ Object
Embedded JavaScript API