| GetInterviewOptionsSettings Property |
Collection of settings that can be specified when requesting a HotDocs interview. When you do not explicitly
provide a value for any setting, the default value specified in the HotDocs Cloud Services
Administrative Portal will be used.
Namespace: HotDocs.Cloud.Client
Assembly: HotDocs.Cloud.Client (in HotDocs.Cloud.Client.dll) Version: 1.0.5652.20312
Syntax
Property Value
Type: DictionaryString, StringRemarks
| Setting Name | Description |
|---|---|
| HotDocsJsUrl | The URL from which the web browser should request the HotDocs interview runtime files (including hdloader.js and other JavaScript files and/or Silverlight DLLs). To avoid security errors or complex cross-domain policy files, the host application must be able to serve these files itself (from its own domain name). |
| HotDocsCssUrl | The base URL from which the web browser should request the interview style sheet and related components. The setting itself designates the full URL to the "user" CSS style sheet (for styling JavaScript interviews). The default user style sheet is named "hdsuser.css", but customized style sheets can have any base file name. Browser interviews rely on this setting to derive URLs for several other style-related components: (1) For HotDocs 11 and later, a sprite-style image must be available at this same base URL (but with a .png file extension) containing all the interview images at expected offsets within the sprite; (2) For Silverlight interviews, a XAML style sheet will be requested from this same base URL (but with a .xaml file extension); (3) The "system" style sheet (hdssystem.css) must also be available at the same base URL (differing by file name). |
| HotDocsImageUrl | In HotDocs 11, this setting is ignored since interview images (used for all buttons, tree nodes, etc.) were replaced with a single sprite-style image at the same base URL as the user style sheet. For HotDocs 10.x interviews, this is the base URL from which each of the standard images will be requested. |
| InterviewDefUrl | The base URL from which the interview runtime (running in the browser) will request interview definition files. For JavaScript interviews, interview definitions are JavaScript files; for Silverlight interviews, interview definitions are compiled DLLs. HotDocs generates these interview definitions, but a host application must deliver them from the host application's own domain name. At runtime HotDocs appends the file name of the requested interview definition to the supplied string and issues an HTTP GET to the resulting URL. Note that for HotDocs 10.x interviews, this URL was only used to deliver Silverlight interview definitions. |
| DocPreviewUrl | If this URL is null or empty, users will not be able to request document previews from within browser interviews. Otherwise this URL should be the location of a handler from which a browser interview can request a document preview. |
| SaveAnswersPageUrl | The URL of a page within your host application that allows saving answers during an interview. If this URL is null or empty, HotDocs will not show a Save Answers button on the interview toolbar. Otherwise the browser will POST interview answers to this page in response to the user clicking the Save Answers button. The page should return an HTML response that will be displayed within an IFRAME in the interview. |
| FormActionUrl | The URL to which interview answers are posted when the user clicks the Finish button at the end of an interview. This is sometimes referred to as the "Disposition Page"; it typically proceeds to perform a document assembly based on those answers and may give the user options to decide whether to return to the interview, proceed to another interview, or go do something else. |
| TempInterviewUrl | The base URL from which the browser interview can request graphics or other peripheral files necessary for an interview in progress. For example, when an interview is displayed that uses Image dialog elements, your host application must know about those image files, and be able to deliver them in response to requests to this URL. |
| RequestTimeout | (number of seconds) By default, HotDocs Core Services will assume a request to produce an interview has hung if the response takes longer than (a certain time). Setting RequestTimeout to another value can raise or lower the threshhold before HotDocs gives up on a request. |
| AddHdMainDiv |
"true" or "false" In order to embed HotDocs interviews within a host application web page, HotDocs looks for a DIV with the id of "hdMain" somewhere on the page, and uses that location to embed the interview. This setting indicates whether or not HotDocs should include the HDMain DIV element on its own (appended to the HTML content returned from GetInterview), or whether your host application has already placed a DIV with the appropiate ID for HotDocs to use. |
| TemplateTitleOverride | By default, HotDocs interviews show a template's title in the interview toolbar. Use this setting to override the text shown in the toolbar. |
| InterviewLocale | HotDocs interviews are assumed to use the English (US) language by default. If you wish to display interviews in other languages, you should set this property to the name of an appropriately configured HotDocs Browser Language Module. See (link) for more information on Browser Language Modules. |
| OutlineInOrder |
"true" or "false" Corresponds to the "Next Dialog Follows Outline" entry on the "Navigate" menu within desktop HotDocs. When this setting is "true" (the default), dialogs are navigated in a top-down manner, with the Next command always navigating the interview outline from top to bottom. When this setting is "false", behavior of the Next command depends on the current location: choosing Next from a top-level dialog always proceeds to the next top-level dialog (skipping child dialogs, if any), and choosing Next from a child dialog always navigates back to its parent. |
| ShowAllResourceButtons |
"true" or "false" HotDocs interviews display a resource button next to input fields for which the template author has provided additional resource information. This setting determines whether resource buttons will be visible simultaneously for all such input fields, or whether resource buttons should appear only for the current-focused input field. Corrresponds to the HotDocs Options > Interviews and Dialogs > Show answer field resource button option in desktop HotDocs. |
| DisableAnswerSummary |
"true" or "false" HotDocs interviews allow users to request answer summaries (from the interview toolbar) by default. This option can remove the answer summary toolbar button. |
| AsMaximumMultipleChoice | No longer supported. This setting was used to set the maximum number of selected multiple choice options that could be displayed in an answer summary. HotDocs now shows ALL selected multiple choice options in answer summaries. |
| AsNumberOfColumns |
"1" or "2" Answer summaries can be formatted in 1-column or 2-column format. |
| AsIndentPrompts |
"true" or "false" Indents the left margin of each prompt with respect to dialog titles. Applicable only to 1-column answer summary layout. |
| AsBulletPrompts |
"true" or "false" Precedes each prompt with a bullet character. Applicable only to 1-column answer summary layout. |
| AsIndentAnswers |
"true" or "false" Indents the left margin of each answer with respect to its prompt. Applicable only to 1-column answer summary layout. |
| AsBulletAnswers |
"true" or "false" Precedes each answer with a bullet character. Applicable only to 1-column answer summary layout. |
| AsBorders |
"N", "P" or "S" Sets the border style for the answer summary table: [N]one, [P]lain or [S]culpted. Applicable only to 2-column answer summary layout. |
| AsPercentOfWidthForPrompt |
Recommended range of "30" to "70" Specifies the percentage of the total interview width reserved for prompts. |
| UnansweredFormat |
"Nothing" / "Underscores" / "Asterisks" / "[Variable]" / "*** Variable ***" Dictates what to merge (by default) when a value for which no answer is available is merged into text within the interview. Corresponds to the "Unanswered variable placeholder" HotDocs setting |
| HonorCmpUnansFormat |
"true" or "false" Determines whether template author preferences (as specified in a HotDocs component file) should override the default UnansweredFormat specified by the host application. ("true" corresponds to the behavior of desktop HotDocs.) |
| DefaultDateFormat |
"June 3, 1990", etc. Specifies the default format example to be used when merging date values into text. |
| MaxRepeatCount |
e.g. "100" The number of iterations through a WHILE loop HotDocs will perform before generating an error. For performance reasons, HotDocs Core Services may ignore values over a certain threshhold. |
| MaxRecursionDepth |
e.g. "100" The maximum depth that may be reached by a recursive script in HotDocs before generating an error. For performance reasons, HotDocs Core Services may ignore values over a certain threshhold. |
TODO: document the %%VERSION% macro for the URL settings
TODO: document which URL settings above will be called with specific parameters on the query string.
See Also