TextMarkupAnnotation

TextMarkupAnnotation class

Abstract base class for text markup annotations.

The TextMarkupAnnotation type exposes the following members:

Properties

NameDescription
vertical_alignmentNone
horizontal_alignmentGets or sets text alignment for annotation.
marginNone
is_first_paragraph_in_columnNone
is_kept_with_nextNone
is_in_new_pageNone
is_in_line_paragraphNone
hyperlinkNone
z_indexNone
update_appearance_on_convertIf true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time.
use_font_subsetIf this property set to true, fonts will be added to document as subsets. Default value is true.
flagsFlags of the annotation.
annotation_typeGets type of annotation.
widthGets or sets width of the annotation.
actionsGets list of annotatation actions.
heightGets or sets height of the annotation.
rectGets or sets annotation rectangle.
contentsGets or sets annotation text.
nameGets or sets annotation name on the page.
modifiedGets or sets date and time when annotation was recently modified.
colorGets or sets annotation color.
borderGets or sets annotation border characteristics. border
active_stateGets or sets current annotation appearance state.
characteristicsGets annotation characteristics.
statesGets appearance dictionary of annotation.
alignmentAnnotation alignment. This property is obsolete. Use HorizontalAligment instead.
text_horizontal_alignmentGets or sets text alignment for annotation.
full_nameGets full qualified name of the annotation.
appearanceGets appearance dictionary of the annotation.
page_indexGets index of page which contains annotation.
titleGets or sets a text that shall be displayed in title bar of annotation.
rich_textGets or sets a rich text string to be displayed in the pop-up window when the annotation is opened.
creation_dateGets date and time when annotation was created.
subjectGets text representing desciption of the object.
popupPop-up annotation for entering or editing the text associated with this annotation.
opacityGets or sets the constant opacity value to be used in painting the annotation.
in_reply_toA reference to the annotation that this annotation is “in reply to”.
Both annotations must be on the same page of the document.
reply_typeA string specifying the relationship (the “reply type”) between this annotation
and one specified by InReplyTo.
quad_pointsGets or sets an array of points specifying the coordinates of n quadrilaterals. Each quadrilateral encompasses a word or group of contiguous words in the text underlying the annotation.

Methods

NameDescription
clone()None
get_rectangle(consider_rotation)Returns rectangle of annotation taking into consideration page rotation.
accept(visitor)Accepts visitor for annotation processing.
flatten()Places annotation contents directly on the page,
annotation object will be removed.
change_after_resize(transform)Updates the QuadPoints, according to the matrix transform.
get_marked_text()Gets text under markup annotation as string.
get_marked_text_fragments()Gets text under markup annotation as TextFragmentCollection.

See Also