Application.GetInterviewDefinitionFromTemplate Method

Get an interview definition for a template using a template path.

Syntax

public string GetInterviewDefinitionFromTemplate(string templatePath, string templateKey, HotDocs.Server.Interop.interviewFormat format)

Parameters Description
TemplatePath The path of the template for which an interview definition is being requested.
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 definition format being requested. See interviewFormat for a list of possible values.

Return Value

A string of HTML code that represents the core interview content for the assembly. The host application supplies this content to the browser when a request is made to the interview definition URL previously passed to Application.GetInterview.