InterviewSettings.DocumentPreviewUrl Property

InterviewSettings DocumentPreviewUrl Property

The URL to which answers will be posted when a browser interview requests an HTML document preview. The HTTP response returned by that POST will be displayed to user as the preview.

If not specified, this property defaults to null (which omits the document preview feature).

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

Syntax

C++

Copy to Clipboard Print

public string DocumentPreviewUrl { get; set; }

public string DocumentPreviewUrl { get; set; }

Property Value

Type:

String

Remarks

This property is equivalent to the DocumentPreviewUrl property in the HotDocs Server API and the DocPreviewUrl setting in Core Services.

The following are field values that may be posted to this URL:

Answers are sent from the browser in a set of "HDInfo" field values. Usually, all answer content will be contained in a single HDInfo value, but if the answer content is large, it may be broken up across several HDInfo values which need to be concatenated back together before use. You can use the static InterviewResponse.GetAnswers method to read and join these values from the request automatically. These answers may be overlayed on any answers maintained on the server with a call to HotDocs.Sdk.AnswerCollection.OverlayXml, for example. The resulting combined answer collection may then used to assemble a document for a preview.The "InlineImages" field's value is "true" if the requesting browser supports HTML with images included as embedded URIs.