HotDocs.LibraryEntity Object

This object represents any valid item in a HotDocs library, including folders, templates, clause libraries, URLs, documents, and so forth.

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

Methods

Method	Description
AddFolder	This method adds a new folder to the library. The LibraryEntity object on which this method is called must represent a folder in which the new subfolder will be added.
AddTemplate	This method adds a new item to a library folder. The LibraryEntity object on which this method is called must represent a folder to which the new item will be added.
Item	This method returns the specified item from the subordinate _LibraryEntity collection. The _LibraryEntity object on which this method is called must represent a folder, since templates have no subordinate objects in a library.
Remove	This method removes the LibraryEntity object from the library.

Properties

Property	Description
Application	[Read-only] This property returns a reference to the Application object.
Count	[Read-only] This property returns the number of subordinate objects in the collection. The LibraryEntity object on which this property is called should represent a folder, since templates have no subordinate objects in a library.
Description	[Read/Write] This property sets/returns the description for selected library item.
ID	[Read-only] This property returns a numerical identifier for the LibraryEntity.
isFolder	[Read-only] If this Boolean property is true, then the _LibraryEntity object represents a folder. However, if it is false, the object represents some other library item, such as a template, clause library, URL, and so forth.
OverlayIndex	[Read/Write] This property is a long index to the Icon object. (To clear an overlay, set the index to -1.)
Parent	[Read-only] This property returns a LibraryEntity object for the parent object. If the current object is the root of the Library, then the return value is NULL.
TemplateFullPath	[Read-only] This property returns the full file system path of the template represented by the LibraryEntity. This is different than the TemplatePath property, which may contain only a file name or a reference path and file name.
TemplatePath	[Read/Write] This property sets/returns the file system path for the template. The LibraryEntity object on which this property is called must represent a non-folder entity because folders have no file system path.
Title	[Read/Write] This property sets/returns the title for the object. The title is the text that appears next to the icon in the list of library items. It also appears in the Properties tab of the library window when the item is selected and viewed.