HotDocs.Server.Component Class

A Component represents a single HotDocs component, such as a variable or a dialog. Using this object, you can find out general information about the component, such as its Name or Prompt. For more detailed information about a component, such as a Multiple Choice variable's options, you can also look at the component's Properties.

Namespace: HotDocs.Server
Assembly: HotDocs.Server in HotDocs.Server.dll

This class implements the following interfaces:

• IDisposable: The class can be disposed.

Methods

Method	Description
Dispose	This method is an implementation of the IDisposable.Dispose method that releases unmanaged resources held by an instance of the Component class.

Properties

Property	Description
Name	[Read-only] This string property returns the name of the component.
Prompt	[Read-only] This string property returns the prompt of the component.
Properties	[Read-only] This property returns a ComponentProperties collection, which is a collection of all properties associated with the Component object. Each property in the collection is in turn represented by a ComponentProperty object.
Type	[Read-only] This property returns the component's type, which is a value from the hdCmpType enumeration.