Name
page:CreateTextMarkupAnnot -- create text markup annotation object
Synopsis
ant = page:CreateTextMarkupAnnot(rect, text, encoder, subtype)
Function
page:CreateTextMarkupAnnot() creates a new text markup annotation object for the page.

The rect parameter must be a table which contains left, top, right, and bottom fields that describe a rectangle.

The subtype parameter must be one of the following constants:

 
#HPDF_ANNOT_TEXT_NOTES
#HPDF_ANNOT_LINK
#HPDF_ANNOT_SOUND
#HPDF_ANNOT_FREE_TEXT
#HPDF_ANNOT_STAMP
#HPDF_ANNOT_SQUARE
#HPDF_ANNOT_CIRCLE
#HPDF_ANNOT_STRIKE_OUT
#HPDF_ANNOT_HIGHTLIGHT
#HPDF_ANNOT_UNDERLINE
#HPDF_ANNOT_INK
#HPDF_ANNOT_FILE_ATTACHMENT
#HPDF_ANNOT_POPUP
#HPDF_ANNOT_3D
#HPDF_ANNOT_SQUIGGLY
#HPDF_ANNOT_LINE
#HPDF_ANNOT_PROJECTION
#HPDF_ANNOT_WIDGET

Inputs
rect
a rectangle of the clickable area
text
the text to be displayed
encoder
an encoder handle which is used to encode the text; if it is Nil, the default encoding is used
subtype
subtype of annotation object (see above for possible values)
Results
ant
handle to an annotation
Errors
#HPDF_INVALID_PAGE - An invalid page handle was set.

#HPDF_FAILED_TO_ALLOC_MEM - Memory allocation failed.

#HPDF_INVALID_ENCODER - An invalid encoder handle is specified.

Show TOC