HDAPI.GotoInterviewBookmark Method

HDAPI GotoInterviewBookmark Method

This function navigates the user to a specific dialog in the interview, and moves the focus to a designated field within that dialog. If the bookmark is invalid, or the location is no longer part of the interview, no navigation takes place.

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

Syntax

JavaScript

Copy

function GotoInterviewBookmark(str);

Parameters

str: Type: System String
An interview bookmark string, as generated by HDAPI.GetInterviewBookmark.

Remarks

If the current answer set changes between the time the bookmark is created and when it is passed into the str parameter, 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 HDGotoInterviewBookmark with an invalid bookmark string will not have any effect.

This function was introduced in HotDocs Server 10.

Examples

JavaScript

Copy

var HDInterviewOptions = {
    OnInit= function ()
    {
        HDAPI.RegisterHandler("OnHDStart",
            function (eventArgs)
            {
                HDAPI.GotoInterviewBookmark('Job Information|1');
            }
        );
    }
};

Reference

HDAPI Object