HotDocs.Icon Object

This object represents an icon, which you can display next to a custom menu command. You can also overlay an icon on top of the icons displayed next to items in the HotDocs library.

General Information

ProgID: HotDocs.Icon.11.0
HotDocs.Icon (version-independent)
CLSID: {D1B6F1CC-C9DA-47a1-B58A-7BF32EB62CE2}

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

Name IID Added in
_Icon {D1B6F1CB-C9DA-47a1-B58A-7BF32EB62CE2} HotDocs 6.2 SP1

Methods

Method Description
LoadBitmap This method loads a bitmap (.bmp) file.
LoadIcon This method loads an icon (.ico) file.

Properties

Property Description
HBITMAP [Write-only] This property sets the HBITMAP for the icon.
HICON [Write-only] This property sets the HICON for the icon.
index [Read/Write] This property sets or returns the index of the icon.
maskColor [Read/Write] This property sets or returns the mask color for an icon loaded from a bitmap (.bmp) file. It has no effect on icons loaded from an icon (.ico) file because those files have an embedded mask.

This method is only used in conjunction with a HotDocs Plugin.