IHDSvc.GetComponentInfo Method

IHDSvc GetComponentInfo Method

This web service retrieves metadata about variables and optionally dialog structure. The variable information is essentially the same as what is found in the .HVC file created when you publish a template for use with HotDocs Server, and the dialog information is a list of the dialog's variables and any answer source mappings that may exist for the dialog.

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

Syntax

C++

Copy to Clipboard Print

ComponentInfo GetComponentInfo(
	string templateID,
	bool includeDialogs
)

ComponentInfo GetComponentInfo(
	string templateID,
	bool includeDialogs
)

Parameters

templateID: Type: System String
The file name of the template.

includeDialogs: Type: System Boolean
This indicates whether or not the returned data should include information about dialogs and their contents.

Return Value

Type: ComponentInfo
A ComponentInfo object with information about each variable (and optionally dialog) in the template's interview.