Application.GetInterview Method

This method returns a browser-based HTML interview for a template.

Syntax

public string GetInterview(string templatePath, templateKey, HotDocs.Server.Interop.interviewFormat format, HotDocs.Server.Interop.HDInterviewOptions options, string serverFilesUrl, string styleUrl, HotDocs.Server.AnswerCollection ansColl, string formActionUrl, string templateName, string interviewDefinitionUrl, string tempInterviewPath, string tempInterviewUrl, string saveAnswersUrl, string previewUrl);

Parameters Description
templatePath The path to the template.
templateKey The cache key for this template. This key uniquely identifies the template and is provided by the calling application. This key is only important when templatePath may vary between calls pertaining to the same template. For example, if the template is stored in a document management system (DMS), the template file name may change every time the file is requested from the DMS.
format The interview format. See interviewFormat for a list of possible values.
options The interview options. See HDInterviewOptions for a list of possible values.
serverFilesUrl The URL that HotDocs Server should use for server files such as the JavaScript engine that do not vary from template to template.
styleUrl The URL that HotDocs Server should use for the user cascading style sheet (e.g., hdsuser.css).
ansColl The answer collection containing the answers used while building the interview.
formActionUrl The URL for the page to which interview results are posted.

For HotDocs 11 forward, when using the GetInterview method (for both .NET and COM APIs), if you try to call GetInterview() without first setting the FormActionUrl on the Assembly object, you get a JavaScript error, though nothing appears on the page.
templateName The template name that is to be displayed in the browser.
interviewDefUrl The URL from which the browser will request the template's interview content.
tempInterviewPath Indicates the path to a folder where temporary files are created during the interview. For example, when an interview is displayed that uses Image dialog elements, the image files are copied to this folder so the browser interview can find them. Files in this folder are automatically deleted at an appropriate time after completing the interview.
tempInterviewUrl Indicates the URL to a folder where temporary files are created during the interview. For example, when an interview is displayed that uses Image dialog elements, the image files are copied to this folder so the browser interview can find them. Likewise, when HotDocs Server generates a document preview, the files it creates for the document preview are placed in this folder. Files in this folder are automatically deleted at an appropriate time after completing the assembly.
saveAnswersUrl The URL of a page you can create to handle saving answer files in the middle of an interview. (If the user selects the Save Answers command in the interview, this URL will be loaded to handle that command.)
previewUrl This property represents the URL of the document preview handler page. (If the user selects the Document Preview command in the interview, this URL will be loaded to handle that command.)

Return Value

A string of HTML code that represents the browser-based interview for the Assembly. You can then embed this HTML code in your host application's Web page. (When embedding the interview in a Web page, it is recommended that you do not place anything below the interview. The browser-based interview is designed to expand to the height of the browser window, which would force users to scroll in order to see any text below the interview.)