IServices.GetInterview Method

IServices GetInterview Method

GetInterview returns an HTML fragment suitable for inclusion in any standards-mode web page, which embeds a HotDocs interview directly in that web page.

Namespace: HotDocs.Sdk.Server
Assembly: HotDocs.Sdk.Server (in HotDocs.Sdk.Server.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy to Clipboard Print

InterviewResult GetInterview(
	Template template,
	TextReader answers,
	InterviewSettings settings,
	IEnumerable<string> markedVariables,
	string logRef
)

InterviewResult GetInterview(
	Template template,
	TextReader answers,
	InterviewSettings settings,
	IEnumerable<string> markedVariables,
	string logRef
)

Parameters

template: Type: HotDocs.Sdk Template
The template for which to return an interview.

answers: Type: System.IO TextReader
The answers to use when building an interview.

settings: Type: HotDocs.Sdk InterviewSettings
The InterviewSettings to use when building an interview.

markedVariables: Type: System.Collections.Generic IEnumerable String
The variables to highlight to the user as needing special attention. This is usually populated with UnansweredVariables from AssembleDocument(Template, TextReader, AssembleDocumentSettings, String).

logRef: Type: System String
A string identifying the current user or transcation, to be included in HotDocs log entries. This is necessary if you wish to track log entries back to specific users during analysis or troubleshooting.

Return Value

Type: InterviewResult
Returns the results of building the interview as an InterviewResult object.