Name
annot:SetTextAnnotIcon -- set annotation icon
Synopsis
status = annot:SetTextAnnotIcon(icon)
Function
annot:SetTextAnnotIcon() defines the style of the annotation's icon. icon can be one of the following constants:

 
#HPDF_ANNOT_ICON_COMMENT
#HPDF_ANNOT_ICON_KEY
#HPDF_ANNOT_ICON_NOTE
#HPDF_ANNOT_ICON_HELP
#HPDF_ANNOT_ICON_NEW_PARAGRAPH
#HPDF_ANNOT_ICON_PARAGRAPH
#HPDF_ANNOT_ICON_INSERT

Returns #HPDF_OK on success. Otherwise, returns an error code and the error handler is invoked.

Inputs
icon
one of the constants listed above
Results
status
status code
Errors
#HPDF_INVALID_ANNOTATION - An invalid annotation handle was set.

#HPDF_ANNOT_INVALID_ICON - An invalid icon-style was specified.

#HPDF_FAILED_TO_ALLOC_MEM - Memory allocation failed.

Show TOC