PDF3DAnnotation

PDF3DAnnotation class

Class PDF3DAnnotation. This class cannot be inherited.

The PDF3DAnnotation type exposes the following members:

Constructors

NameDescription
PDF3DAnnotation(page, rect, pdf_3d_artwork)Initializes a new instance of the PDF3DAnnotation class
PDF3DAnnotation(page, rect, pdf_3d_artwork, activation)Initializes a new instance of the PDF3DAnnotation class

Properties

NameDescription
vertical_alignmentGets or sets a vertical alignment of paragraph
horizontal_alignmentGets or sets text alignment for annotation.
marginGets or sets a outer margin for paragraph (for pdf generation)
is_first_paragraph_in_columnGets or sets a bool value that indicates whether this paragraph will be at next column.
Default is false.(for pdf generation)
is_kept_with_nextGets or sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph.
Default is false.(for pdf generation)
is_in_new_pageGets or sets a bool value that force this paragraph generates at new page.
Default is false.(for pdf generation)
is_in_line_paragraphGets or sets a paragraph is inline.
Default is false.(for pdf generation)
hyperlinkGets or sets the fragment hyperlink(for pdf generator).
z_indexGets or sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex
will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative
ZIndex will be placed behind the text in the page.
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.
pdf_3d_artworkGets the 3D Artwork.
lighting_schemeGets the lighting scheme.
contentGets or sets the content.
render_modeGets the render mode.
view_arrayGets the view array.

Methods

NameDescription
set_image_preview(filename)Sets the image preview.
set_image_preview(image)Sets the image preview.
clone()Clones this instance.
Virtual method. Always return null.
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)Update parameters and appearance, according to the matrix transform.
set_default_view_index(index)Sets the index of the default view.
clear_image_preview()Clears the image preview.
get_image_preview()Gets the image preview.

See Also