HotDocs.Component Object

This object represents a HotDocs variable or other component stored in a HotDocs component file.

General Information

The following table shows the name and IID for each interface, as well as the version of HotDocs in which it was introduced. The primary interface and the main public interface exposed by this object is _Component2.

Methods

Method	Description
DisplayEditor	This method displays a user interface for modifying a component's properties. For example, if the component is a Text variable, this method displays the Text Variable Editor.

Properties

Property	Description
Application	[Read-only] This property returns a reference to the Application object.
DBName	[Read-only] This is a string property that tells the name of the database component (if any) that links this variable component to a field in a database table.
DialogName	[Read-only] This is a string property that specifies the name of the dialog in which this variable component appears.
HelpText	[Read-only] This is a string property that tells what resource text has been included for a variable.
Name	[Read-only] This is a string property that tells the name of the variable.
Prompt	[Read-only] This is a string property that tells the prompt of the variable.
Properties	[Read-only] This property returns a ComponentProperties object, 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.
Title	[Read-only] This property returns the title of the component.
Type	[Read-only] This HDVARTYPE property tells which type the variable is. This can be one of the values from the HDVARTYPE enumeration.