Services.GetInterview Method

Services 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.WebService
Assembly: HotDocs.Sdk.Server (in HotDocs.Sdk.Server.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy to Clipboard Print

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

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

Parameters

template: Type: HotDocs.Sdk Template
An instance of the Template class, for which the interview will be requested.

answers: Type: System.IO TextReader
The initial set of answers to include in the interview.

settings: Type: HotDocs.Sdk InterviewSettings
Settings that define various interview behaviors.

markedVariables: Type: System.Collections.Generic IEnumerable String
A collection of variables that should be marked with special formatting in the interview.

logRef: Type: System String
A string to display in logs related to this request.

Return Value

Type: InterviewResult
An object which contains an HTML fragment to be inserted in a web page to display the interview.

Implements

IServices GetInterview(Template, TextReader, InterviewSettings, IEnumerable String , String)