FreeTextAnnotation

FreeTextAnnotation class

Represents a free text annotation that displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text is always visible.

The FreeTextAnnotation type exposes the following members:

Constructors

NameDescription
FreeTextAnnotation(document, appearance)Initializes a new instance of the FreeTextAnnotation class
FreeTextAnnotation(page, rect, appearance)Initializes a new instance of the FreeTextAnnotation class

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.
starting_styleGets or sets line ending style for line ending point.
OThis property is obsolete, please use EndingStyle.
ending_styleGets or sets line ending style for line ending point.
justificationGets or set a code specifying the form of quadding (justification) to be used in displaying the annotation�s text.
default_appearanceGets or sets the default appearance string to be used in formatting the text.
default_appearance_objectObject which represents default appearance of FreeText annotation.
intentGets or sets the intent of the free text annotation.
default_styleGets or sets a default style string.
text_styleGets or sets style of the text in appearance. when text style is changed, text appearance is updated.
rotateAngle of annotation rotation.
calloutArray of point specifying callout line.
text_rectangleRectangle describing the numerical differences between two rectangles: the Rect entry of the annotation
and a rectangle contained within that rectangle. The inner rectangle is where the annotation�s text should be displayed.

Methods

NameDescription
clone()None
get_rectangle(consider_rotation)Returns rectangle of annotation taking into consideration page rotation.
accept(visitor)Accepts visitor object to process the annotation.
flatten()Places annotation contents directly on the page,
annotation object will be removed.
change_after_resize(transform)Update parameters and appearance, according to the matrix transform.

See Also