HotDocs.Server.ComponentProperties Class

ComponentProperties represents a collection of ComponentProperty objects. Each HotDocs component (e.g., variable, dialog, etc.) contains a ComponentProperties collection that defines the component. For example, one property that every component contains is its name. Using this object, your host application could read the properties of any HotDocs component and use that information to change certain behavior of your application.

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

This class implements the following interfaces:

  • IDictionary: This class represents a collection of key/value pairs.

  • IDisposable: The class can be disposed.

  • IList: The class is a list of ComponentProperty objects.

Methods

Method Description
Add Inherited from the IList interface, but not implemented.
Clear Inherited from the IList interface, but not implemented.
Contains This method determines whether the ComponentProperties collection contains a specific ComponentProperty.
CopyTo This method copies the elements of the ComponentProperties collection to an Array, starting at a particular index.
Dispose This method is an implementation of the IDisposable.Dispose method that releases unmanaged resources held by an instance of the ComponentProperties class.
GetEnumerator This method returns an enumerator that iterates through the ComponentProperties collection.
IndexOf This method determines the index of a specific ComponentProperty in the ComponentProperties collection.
Insert Inherited from the IList interface, but not implemented.
Remove Inherited from the IList interface, but not implemented.
RemoveAt Inherited from the IList interface, but not implemented.

Properties

Property Description
Count [Read-only] This property returns the number of components in the ComponentProperties collection.
Item This property returns the specified ComponentProperty from the ComponentProperties collection.
Keys [Read-only] This property returns a list of keys for the ComponentProperties collection.
Values [Read-only] This property returns a list of values for the ComponentProperties collection.