HotDocs.Library Object

This object represents a HotDocs library (.HDL) file. It allows an integration to iterate through all the items in the library to inspect, add, or delete items.

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 _Library2.

Methods

Method	Description
Close	This method closes an open library file.
New	This method creates a new library file and opens it. If you pass in a libFileName that already exists, then that file is opened using the Open method. Once you are finished using the library, close it using the Close method.
Open	This method opens an existing library file. If the file specified by fileName doesn't exist, this method will return an error. (To create and open a new library file, use the New method.) When you are finished using the library, you should close it using the Close method.
Save	This method saves the library to disk. HotDocs saves the library to the location specified in the New or Open method call.

Properties

Property	Description
Application	[Read-only] This property returns a reference to the Application object.
Description	[Read/Write] This property sets or returns the description for the library. (The description appears in the Properties tab when the top folder of the library is selected.)
MainFolder	[Read-only] This property returns a LibraryEntity object representing the root folder of the library.
Redraw	[Write-only] This Boolean property causes the library window to be redrawn (refreshed).
Title	[Read/Write] This property sets or returns the title for the library. (The title appears as the top folder in the library window.)