Foxit PDF SDK
FoxitPDFSDKPython3.Annot Class Reference
Inheritance diagram for FoxitPDFSDKPython3.Annot:
FoxitPDFSDKPython3.Base FoxitPDFSDKPython3.Link FoxitPDFSDKPython3.Markup FoxitPDFSDKPython3.Popup FoxitPDFSDKPython3.PSInk FoxitPDFSDKPython3.Screen FoxitPDFSDKPython3.Widget FoxitPDFSDKPython3.Caret FoxitPDFSDKPython3.Circle FoxitPDFSDKPython3.FileAttachment FoxitPDFSDKPython3.FreeText FoxitPDFSDKPython3.Ink FoxitPDFSDKPython3.Line FoxitPDFSDKPython3.Note FoxitPDFSDKPython3.Polygon FoxitPDFSDKPython3.PolyLine FoxitPDFSDKPython3.Redact FoxitPDFSDKPython3.Sound FoxitPDFSDKPython3.Square FoxitPDFSDKPython3.Stamp FoxitPDFSDKPython3.TextMarkup

Public Member Functions

def Annot (page, annot_dict)
 Constructor, with PDF page and annotation's PDF dictionary. More...
 
def GetAppearanceStream (type, appearance_state)
 Get annotation's appearance stream with specified type and state. More...
 
def GetBorderColor ()
 Get border color. More...
 
def GetBorderInfo ()
 Get border information. More...
 
def GetContent ()
 Get content. More...
 
def GetDeviceRect (matrix)
 Get annotation rectangle in device coordinate system. More...
 
def GetDict ()
 Get annotation's dictionary object. More...
 
def GetDisplayMatrix (page_display_matrix)
 Get the display matrix, from [PDF coordinate system] () to targeted device coordinate system. More...
 
def GetFlags ()
 Get annotation flags. More...
 
def GetIndex ()
 Get the index of current annotation in the page which current annotation belongs to. More...
 
def GetModifiedDateTime ()
 Get last modified date time. More...
 
def GetOptionalContent ()
 Get the PDF dictionary of annotation's optional content. More...
 
def GetPage ()
 Get the related PDF page. More...
 
def GetRect ()
 Get rectangle, in [PDF coordinate system] (). More...
 
def GetType ()
 Get actual annotation type of current annotation. More...
 
def GetUniqueID ()
 Get unique ID. More...
 
def HasProperty (property)
 Whether current annotation has the specified annotation's property. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def IsMarkup ()
 Check if current annotation is a markup annotation. More...
 
def Move (rect)
 Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] (). More...
 
def RemoveProperty (property)
 Remove a specified annotation's property. More...
 
def ResetAppearanceStream ()
 Reset appearance stream. More...
 
def SetBorderColor (color)
 Set border color. More...
 
def SetBorderInfo (border)
 Set border information. More...
 
def SetContent (content)
 Set content. More...
 
def SetFlags (flags)
 Set annotation flags. More...
 
def SetModifiedDateTime (date_time)
 Set last modified date time. More...
 
def SetUniqueID (unique_id)
 Set unique ID. More...
 

Static Public Attributes

 e_3D = _fsdk.Annot_e_3D
 Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_AppearanceTypeDown = _fsdk.Annot_e_AppearanceTypeDown
 Annotation's down appearance.
 
 e_AppearanceTypeNormal = _fsdk.Annot_e_AppearanceTypeNormal
 Annotation's normal appearance.
 
 e_AppearanceTypeRollover = _fsdk.Annot_e_AppearanceTypeRollover
 Annotation's rollover appearance.
 
 e_Caret = _fsdk.Annot_e_Caret
 Annotation type: caret annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Circle = _fsdk.Annot_e_Circle
 Annotation type: circle annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_FileAttachment = _fsdk.Annot_e_FileAttachment
 Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_FlagHidden = _fsdk.Annot_e_FlagHidden
 Annotation flag: hidden. More...
 
 e_FlagInvisible = _fsdk.Annot_e_FlagInvisible
 Annotation flag: invisible. More...
 
 e_FlagLocked = _fsdk.Annot_e_FlagLocked
 Annotation flag: locked. More...
 
 e_FlagLockedContents = _fsdk.Annot_e_FlagLockedContents
 Annotation flag: locked contents. More...
 
 e_FlagNoRotate = _fsdk.Annot_e_FlagNoRotate
 Annotation flag: no rotate. More...
 
 e_FlagNoView = _fsdk.Annot_e_FlagNoView
 Annotation flag: no view. More...
 
 e_FlagNoZoom = _fsdk.Annot_e_FlagNoZoom
 Annotation flag: no zoom. More...
 
 e_FlagPrint = _fsdk.Annot_e_FlagPrint
 Annotation flag: print. More...
 
 e_FlagReadOnly = _fsdk.Annot_e_FlagReadOnly
 Annotation flag: read only. More...
 
 e_FlagToggleNoView = _fsdk.Annot_e_FlagToggleNoView
 Annotation flag: toggle no view. More...
 
 e_FreeText = _fsdk.Annot_e_FreeText
 Annotation type: free text annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Highlight = _fsdk.Annot_e_Highlight
 Annotation type: highlight annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_HighlightingInvert = _fsdk.Annot_e_HighlightingInvert
 Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
 
 e_HighlightingNone = _fsdk.Annot_e_HighlightingNone
 Highlighting mode: No highlighting.
 
 e_HighlightingOutline = _fsdk.Annot_e_HighlightingOutline
 Highlighting mode: Outline, which is to invert the annotation's border.
 
 e_HighlightingPush = _fsdk.Annot_e_HighlightingPush
 Highlighting mode: Push, which is to display the annotation's down appearance, if any.
 
 e_HighlightingToggle = _fsdk.Annot_e_HighlightingToggle
 Highlighting mode: Toggle. This is only useful for widget annotation.
 
 e_Ink = _fsdk.Annot_e_Ink
 Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Line = _fsdk.Annot_e_Line
 Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Link = _fsdk.Annot_e_Link
 Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_MKEntryBackgroundColor = _fsdk.Annot_e_MKEntryBackgroundColor
 Background color entry. "BG" in MK dictionary.
 
 e_MKEntryBorderColor = _fsdk.Annot_e_MKEntryBorderColor
 Border color entry. "BC" in MK dictionary.
 
 e_MKEntryDownCaption = _fsdk.Annot_e_MKEntryDownCaption
 Down caption (or alternate caption) entry. "AC" in MK dictionary. More...
 
 e_MKEntryDownIcon = _fsdk.Annot_e_MKEntryDownIcon
 Down icon (or alternate icon) entry. "IX" in MK dictionary. More...
 
 e_MKEntryIconCaptionRelation = _fsdk.Annot_e_MKEntryIconCaptionRelation
 Icon and caption relation entry. "TP" in MK dictionary. More...
 
 e_MKEntryIconFit = _fsdk.Annot_e_MKEntryIconFit
 Icon fit information entry. "IF" in MK dictionary. More...
 
 e_MKEntryNormalCaption = _fsdk.Annot_e_MKEntryNormalCaption
 Normal caption entry. "CA" in MK dictionary. More...
 
 e_MKEntryNormalIcon = _fsdk.Annot_e_MKEntryNormalIcon
 Normal icon entry. "I" in MK dictionary. More...
 
 e_MKEntryRolloverCaption = _fsdk.Annot_e_MKEntryRolloverCaption
 Rollover caption entry. "RC" in MK dictionary. More...
 
 e_MKEntryRolloverIcon = _fsdk.Annot_e_MKEntryRolloverIcon
 Rollover icon entry. "RI" in MK dictionary. More...
 
 e_MKEntryRotation = _fsdk.Annot_e_MKEntryRotation
 Rotation entry. "R" in MK dictionary.
 
 e_MKRelationCaptionAboveIcon = _fsdk.Annot_e_MKRelationCaptionAboveIcon
 Caption above the icon.
 
 e_MKRelationCaptionBelowIcon = _fsdk.Annot_e_MKRelationCaptionBelowIcon
 Caption below the icon.
 
 e_MKRelationCaptionLeft = _fsdk.Annot_e_MKRelationCaptionLeft
 Caption to the left of the icon.
 
 e_MKRelationCaptionOvrlayOnIcon = _fsdk.Annot_e_MKRelationCaptionOvrlayOnIcon
 Caption overlaid directly on the icon.
 
 e_MKRelationCaptionRight = _fsdk.Annot_e_MKRelationCaptionRight
 Caption to the right of the icon.
 
 e_MKRelationNoCaption = _fsdk.Annot_e_MKRelationNoCaption
 No caption; icon only.
 
 e_MKRelationNoIcon = _fsdk.Annot_e_MKRelationNoIcon
 No icon; captin only.
 
 e_Movie = _fsdk.Annot_e_Movie
 Annotation type: movie annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Note = _fsdk.Annot_e_Note
 Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PDF reference 1.7>.
 
 e_Polygon = _fsdk.Annot_e_Polygon
 Annotation type: polygon annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_PolyLine = _fsdk.Annot_e_PolyLine
 Annotation type: polyline annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Popup = _fsdk.Annot_e_Popup
 Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_PrinterMark = _fsdk.Annot_e_PrinterMark
 Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_PropertyBorderColor = _fsdk.Annot_e_PropertyBorderColor
 Annotation property: border color. More...
 
 e_PropertyCreationDate = _fsdk.Annot_e_PropertyCreationDate
 Annotation property: creation date. More...
 
 e_PropertyFillColor = _fsdk.Annot_e_PropertyFillColor
 Annotation property: fill color. More...
 
 e_PropertyModifiedDate = _fsdk.Annot_e_PropertyModifiedDate
 Annotation property: modified date.
 
 e_PSInk = _fsdk.Annot_e_PSInk
 Annotation type: pressure sensitive ink annotation.
 
 e_Redact = _fsdk.Annot_e_Redact
 Annotation type: redact annotation.
 
 e_RichMedia = _fsdk.Annot_e_RichMedia
 Annotation type: rich media annotation.
 
 e_Screen = _fsdk.Annot_e_Screen
 Annotation type: screen annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Sound = _fsdk.Annot_e_Sound
 Annotation type: sound annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Square = _fsdk.Annot_e_Square
 Annotation type: square annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Squiggly = _fsdk.Annot_e_Squiggly
 Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Stamp = _fsdk.Annot_e_Stamp
 Annotation type: stamp annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_StrikeOut = _fsdk.Annot_e_StrikeOut
 Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_TrapNet = _fsdk.Annot_e_TrapNet
 Annotation type: trap network annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Underline = _fsdk.Annot_e_Underline
 Annotation type: underline annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_UnknownType = _fsdk.Annot_e_UnknownType
 Annotation type: unknown.
 
 e_Watermark = _fsdk.Annot_e_Watermark
 Annotation type: watermark annotation. One of standard annotation in <PDF reference 1.7>.
 
 e_Widget = _fsdk.Annot_e_Widget
 Annotation type: widget annotation. One of standard annotation in <PDF reference 1.7>. More...
 

Detailed Description

An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard. PDF includes a wide variety of standard annotation types.
Class Annot is the base class for all kinds of PDF annotations. It offers the base functions to get/set annotation's common properties, to move an annotation or reset appearance stream of an annotation. For concrete annotation types, please refer to derived classes. To get the count of annotations or get/add/remove an annotation, please refer to class pdf::PDFPage.
This class object can also be used to construct objects of other classes in order to do some more operation in annotation or access specified information of annotation:

Note
Currently, following kind of functions only support note, highlight, underline, strikeout, squiggly, link, square, circle, free text, stamp, caret, ink, line, polygon, polyline, file attachment, pop-up, widget, screen, PSInk, redact annotations:
See also
FoxitPDFSDKPython3.PDFPage
FoxitPDFSDKPython3.AdditionalAction
FoxitPDFSDKPython3.TextSearch

Constructor & Destructor Documentation

◆ Annot()

def FoxitPDFSDKPython3.Annot.Annot (   page,
  annot_dict 
)

Constructor, with PDF page and annotation's PDF dictionary.

Constructor.

Constructor, with another annotation object.

Parameters
[in]pageA valid PDF page.
[in]annot_dictAn annotation's PDF dictionary. It should represent an annotation and should be in the PDF page specified by parameter page.
[in]annotAnother annotation object.

Member Function Documentation

◆ GetAppearanceStream()

def FoxitPDFSDKPython3.Annot.GetAppearanceStream (   type,
  appearance_state 
)

Get annotation's appearance stream with specified type and state.

For more details, please refer to "AP" and "AS" entries in "TABLE 8.15 Entries common to all annotation dictionaries" in <PDF reference 1.7>.

Parameters
[in]typeType of annotation's appearance. Please refer to values starting from FoxitPDFSDKPython3.Annot.e_AppearanceTypeNormal and this should be one of these values.
[in]appearance_stateAnnotation's appearance state, which is used to select the applicable appearance stream from an appearance sub- dictionary. If this is an empty string, Foxit PDF SDK will choose the appearance state specified by the "AS" (Appearance State) entry in the annotation dictionary.
Returns
The specified annotation's appearance stream. If there is no entry which related to appearance or any error occurs, this function will return null.

◆ GetBorderColor()

def FoxitPDFSDKPython3.Annot.GetBorderColor ( )

Get border color.

This property has effect on annotation's appearance.

Returns
The border color. Format: 0xRRGGBB. If no border color can be found, 0x000000 will be returned.

◆ GetBorderInfo()

def FoxitPDFSDKPython3.Annot.GetBorderInfo ( )

Get border information.

This property has effect on annotation's appearance. For an annotation which does not have border information, the default border information will be returned:
border width = 1, border style = FoxitPDFSDKPython3.BorderInfo.e_Solid , border cloud intensity = 0, border dash phase = 0, border dashes array is an empty array. Attention: among supported annotation types (please refer to "Note" comment part of class Annot ), this property will not have effect on appearance of these annotations: note, highlight, underline, strikeout, squiggly, stamp, caret, popup, file attachment, PSInk, redact. For ink annotation, only border width will have effect on ink annotation's appearance.

Returns
A border information object that received the border information. If not find any border information, the default border information will be returned as described in "Details" part.

◆ GetContent()

def FoxitPDFSDKPython3.Annot.GetContent ( )

Get content.

Returns
Content string.

◆ GetDeviceRect()

def FoxitPDFSDKPython3.Annot.GetDeviceRect (   matrix)

Get annotation rectangle in device coordinate system.

This is a useful function to get the device rectangle of an annotation, but not support pop-up annotation.
For the rectangle conversion, the result rectangle is always "normalized", which is using device coordinate system: left is always smaller than right, and top is always smaller than bottom.

Parameters
[in]matrixA matrix used to transform from [PDF coordinate system] () to device coordinate system. Usually, this is returned by function FoxitPDFSDKPython3.PDFPage.GetDisplayMatrix and also used for rendering.
Returns
The annotation rectangle in device coordinate system. If there is no rectangle information, a RectI object with all 0 values would be returned.

◆ GetDict()

def FoxitPDFSDKPython3.Annot.GetDict ( )

Get annotation's dictionary object.

Returns
Annotation's dictionary. If there is any error, this function will return null.

◆ GetDisplayMatrix()

def FoxitPDFSDKPython3.Annot.GetDisplayMatrix (   page_display_matrix)

Get the display matrix, from [PDF coordinate system] () to targeted device coordinate system.

Display matrix of current annotation can be used with annotation's rectangle to calculate the real area of annotation in target device coordinate system.

Parameters
[in]page_display_matrixThe transformation matrix. Usually this is returned by function FoxitPDFSDKPython3.PDFPage.GetDisplayMatrix .
Returns
The display matrix of current annotation.

◆ GetFlags()

def FoxitPDFSDKPython3.Annot.GetFlags ( )

Get annotation flags.

Returns
The annotation flags. Please refer to values starting from FoxitPDFSDKPython3.Annot.e_FlagInvisible and this would be one or a combination of these values. 0 means no annotation flag.

◆ GetIndex()

def FoxitPDFSDKPython3.Annot.GetIndex ( )

Get the index of current annotation in the page which current annotation belongs to.

Returns
The index value, starting from 0.

◆ GetModifiedDateTime()

def FoxitPDFSDKPython3.Annot.GetModifiedDateTime ( )

Get last modified date time.

Returns
A date and time object that receives the last modified date time. If there is no modified date time information, a date and time object with all 0 values would be returned.

◆ GetOptionalContent()

def FoxitPDFSDKPython3.Annot.GetOptionalContent ( )

Get the PDF dictionary of annotation's optional content.

Returns
The PDF dictionary of annotation's optional content. If there is no "OC" entry or any error occurs, this function will return null.

◆ GetPage()

def FoxitPDFSDKPython3.Annot.GetPage ( )

Get the related PDF page.

Returns
A PDF page object which is the related PDF page.

◆ GetRect()

def FoxitPDFSDKPython3.Annot.GetRect ( )

Get rectangle, in [PDF coordinate system] ().

Returns
The annotation rectangle. If there is no rectangle information, a RectF object with all 0 values would be returned.

◆ GetType()

def FoxitPDFSDKPython3.Annot.GetType ( )

Get actual annotation type of current annotation.

Returns
Annotation type. Please refer to values starting from FoxitPDFSDKPython3.Annot.e_Note and this would be one of these values.

◆ GetUniqueID()

def FoxitPDFSDKPython3.Annot.GetUniqueID ( )

Get unique ID.

Returns
Unique ID string.

◆ HasProperty()

def FoxitPDFSDKPython3.Annot.HasProperty (   property)

Whether current annotation has the specified annotation's property.

Parameters
[in]propertyProperty name. Please refer to values starting from FoxitPDFSDKPython3.Annot.e_PropertyModifiedDate and this should be one of these values.
Returns
true means current annotation has the specified property, while false means current annotation does not have the specified property.

◆ IsEmpty()

def FoxitPDFSDKPython3.Annot.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ IsMarkup()

def FoxitPDFSDKPython3.Annot.IsMarkup ( )

Check if current annotation is a markup annotation.

Returns
true means current annotation is a markup annotation, while false means current annotation is not a markup annotation.

◆ Move()

def FoxitPDFSDKPython3.Annot.Move (   rect)

Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] ().

Parameters
[in]rectNew rectangle to specify the new position where current annotation is to be moved to. It should be valid in [PDF coordinate system] ().
Returns
true means success, while false means failure.
Parameters
[in]rectNew rectangle to specify the new position where current annotation is to be moved to. It should be valid in [PDF coordinate system] ().
[in]is_reset_appearanceA boolean value specifies whether to reset annotation's appearance after moving.
Returns
true means success, while false means failure.

◆ RemoveProperty()

def FoxitPDFSDKPython3.Annot.RemoveProperty (   property)

Remove a specified annotation's property.

This function can be used to remove some optional properties of an annotation. When appearance related property is removed successfully, such as FoxitPDFSDKPython3.Annot.e_PropertyBorderColor and FoxitPDFSDKPython3.Annot.e_PropertyFillColor , user should call function FoxitPDFSDKPython3.Annot.ResetAppearanceStream to make effect on annotation's appearance.

Parameters
[in]propertyProperty name. Please refer to values starting from FoxitPDFSDKPython3.Annot.e_PropertyModifiedDate and this should be one of these values.
Returns
true means remove the specified property successfully, or current annotation supports the property but does not have the property.
false means current annotation does not support to have the specified property, or current annotation cannot be removed specified property.

◆ ResetAppearanceStream()

def FoxitPDFSDKPython3.Annot.ResetAppearanceStream ( )

Reset appearance stream.

Annotation's appearance is stored as stream in PDF document. Any appearance-related property can be changed through the corresponding setting functions. For this change to take effect, this function should be called to update the annotation's appearance.
Please check "Note" part in the comment of class Annot to see which types of annotations can be reset appearance by current function and also check comment in classes of these annotations to see if any property is required before resetting appearance stream.

Returns
true means success, while false means failure.

Annotation's appearance is stored as stream in PDF document. Any appearance-related property can be changed through the corresponding setting functions. For this change to take effect, this function should be called to update the annotation's appearance.
Please check "Note" part in the comment of class Annot to see which types of annotations can be reset appearance by current function and also check comment in classes of these annotations to see if any property is required before resetting appearance stream.

Parameters
[in]is_generate_new_appearance_objtrue means to generate a new appearance object to reset the appearance of the current annotation, while false means to reset the appearance of annotations that share this appearance stream. The parameter has only effect on widget annotation's appearance.
Returns
true means success, while false means failure.

◆ SetBorderColor()

def FoxitPDFSDKPython3.Annot.SetBorderColor (   color)

Set border color.

This property has effect on annotation's appearance. If user wants the new border color has effect on annotation's appearance, please call function FoxitPDFSDKPython3.Annot.ResetAppearanceStream after setting the new border color.

Parameters
[in]colorNew border color to be set. Format: 0xRRGGBB.
Returns
None.

◆ SetBorderInfo()

def FoxitPDFSDKPython3.Annot.SetBorderInfo (   border)

Set border information.

This property has effect on annotation's appearance. If user wants the new border information has effect on annotation's appearance, please call function FoxitPDFSDKPython3.Annot.ResetAppearanceStream after setting the new border information.
Attention: among supported annotation types (please refer to "Note" comment part of class Annot ), this property will not have effect on appearance of these annotations: note, highlight, underline, strikeout, squiggly, stamp, caret, popup, file attachment, PSInk, redact. For ink annotation, only border width will have effect on ink annotation's appearance.

Parameters
[in]borderNew border information to be set. It should be a valid border information object. If any value of parameter border is invalid, this function will fail to set new border information to current annotation.
Returns
None.

◆ SetContent()

def FoxitPDFSDKPython3.Annot.SetContent (   content)

Set content.

For free text annotation and line annotation (which has enabled caption), they would show content in their appearance. So for these kinds of annotations, this property would have effect on annotation's appearance. If user wants the effect to be shown in the appearance of these kind of annotations, please call function FoxitPDFSDKPython3.Annot.ResetAppearanceStream after setting new content.

Parameters
[in]contentNew content string to be set.
Returns
None.

◆ SetFlags()

def FoxitPDFSDKPython3.Annot.SetFlags (   flags)

Set annotation flags.

Parameters
[in]flagsThe annotation flags. It could be 0, or one or a combination of values starting from FoxitPDFSDKPython3.Annot.e_FlagInvisible .
Returns
None.

◆ SetModifiedDateTime()

def FoxitPDFSDKPython3.Annot.SetModifiedDateTime (   date_time)

Set last modified date time.

Parameters
[in]date_timeThe data time to be set. It should contain valid date time data.
Returns
None.

◆ SetUniqueID()

def FoxitPDFSDKPython3.Annot.SetUniqueID (   unique_id)

Set unique ID.

Parameters
[in]unique_idNew unique ID string to be set.
Returns
None.

Member Data Documentation

◆ e_FlagHidden

FoxitPDFSDKPython3.Annot.e_FlagHidden = _fsdk.Annot_e_FlagHidden
static

Annotation flag: hidden.

If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available.

◆ e_FlagInvisible

FoxitPDFSDKPython3.Annot.e_FlagInvisible = _fsdk.Annot_e_FlagInvisible
static

Annotation flag: invisible.

If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an non-standard annotation using an appearance stream specified by its appearance dictionary, if any.

◆ e_FlagLocked

FoxitPDFSDKPython3.Annot.e_FlagLocked = _fsdk.Annot_e_FlagLocked
static

Annotation flag: locked.

If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

◆ e_FlagLockedContents

FoxitPDFSDKPython3.Annot.e_FlagLockedContents = _fsdk.Annot_e_FlagLockedContents
static

Annotation flag: locked contents.

If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.

◆ e_FlagNoRotate

FoxitPDFSDKPython3.Annot.e_FlagNoRotate = _fsdk.Annot_e_FlagNoRotate
static

Annotation flag: no rotate.

If set, do not rotate the annotation's appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation.

◆ e_FlagNoView

FoxitPDFSDKPython3.Annot.e_FlagNoView = _fsdk.Annot_e_FlagNoView
static

Annotation flag: no view.

If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of flag FoxitPDFSDKPython3.Annot.e_FlagPrint ) but should be considered hidden for purposes of on-screen display and user interaction.

◆ e_FlagNoZoom

FoxitPDFSDKPython3.Annot.e_FlagNoZoom = _fsdk.Annot_e_FlagNoZoom
static

Annotation flag: no zoom.

If set, do not scale the annotation's appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification.

◆ e_FlagPrint

FoxitPDFSDKPython3.Annot.e_FlagPrint = _fsdk.Annot_e_FlagPrint
static

Annotation flag: print.

If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.

◆ e_FlagReadOnly

FoxitPDFSDKPython3.Annot.e_FlagReadOnly = _fsdk.Annot_e_FlagReadOnly
static

Annotation flag: read only.

If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of flags FoxitPDFSDKPython3.Annot.e_FlagNoView and FoxitPDFSDKPython3.Annot.e_FlagPrint ) but should not respond to mouse clicks or change its appearance in response to mouse motions.

Note
This flag is ignored for widget annotations; its function is subsumed by flag FoxitPDFSDKPython3.Field.e_FlagReadOnly of related form field.

◆ e_FlagToggleNoView

FoxitPDFSDKPython3.Annot.e_FlagToggleNoView = _fsdk.Annot_e_FlagToggleNoView
static

Annotation flag: toggle no view.

If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it.

◆ e_MKEntryDownCaption

FoxitPDFSDKPython3.Annot.e_MKEntryDownCaption = _fsdk.Annot_e_MKEntryDownCaption
static

Down caption (or alternate caption) entry. "AC" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.

◆ e_MKEntryDownIcon

FoxitPDFSDKPython3.Annot.e_MKEntryDownIcon = _fsdk.Annot_e_MKEntryDownIcon
static

Down icon (or alternate icon) entry. "IX" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.

◆ e_MKEntryIconCaptionRelation

FoxitPDFSDKPython3.Annot.e_MKEntryIconCaptionRelation = _fsdk.Annot_e_MKEntryIconCaptionRelation
static

Icon and caption relation entry. "TP" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field. This is used to specify where to position the text of widget annotation's mk caption relative to widget annotation's mk icon.

◆ e_MKEntryIconFit

FoxitPDFSDKPython3.Annot.e_MKEntryIconFit = _fsdk.Annot_e_MKEntryIconFit
static

Icon fit information entry. "IF" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.

◆ e_MKEntryNormalCaption

FoxitPDFSDKPython3.Annot.e_MKEntryNormalCaption = _fsdk.Annot_e_MKEntryNormalCaption
static

Normal caption entry. "CA" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field, check box field or radio button field.

◆ e_MKEntryNormalIcon

FoxitPDFSDKPython3.Annot.e_MKEntryNormalIcon = _fsdk.Annot_e_MKEntryNormalIcon
static

Normal icon entry. "I" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.

◆ e_MKEntryRolloverCaption

FoxitPDFSDKPython3.Annot.e_MKEntryRolloverCaption = _fsdk.Annot_e_MKEntryRolloverCaption
static

Rollover caption entry. "RC" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.

◆ e_MKEntryRolloverIcon

FoxitPDFSDKPython3.Annot.e_MKEntryRolloverIcon = _fsdk.Annot_e_MKEntryRolloverIcon
static

Rollover icon entry. "RI" in MK dictionary.

Note
Only applicable for widget annotation associated with pushbutton field.

◆ e_PropertyBorderColor

FoxitPDFSDKPython3.Annot.e_PropertyBorderColor = _fsdk.Annot_e_PropertyBorderColor
static

Annotation property: border color.

Free text annotation can have border color property but not support to remove this property from free text annotation.

◆ e_PropertyCreationDate

FoxitPDFSDKPython3.Annot.e_PropertyCreationDate = _fsdk.Annot_e_PropertyCreationDate
static

Annotation property: creation date.

Only markup annotations can have creation date property.

◆ e_PropertyFillColor

FoxitPDFSDKPython3.Annot.e_PropertyFillColor = _fsdk.Annot_e_PropertyFillColor
static

Annotation property: fill color.

Only following types of annotations can have fill color property:
square, circle, free text, line, polygon, polyline, redact.

◆ e_Widget

FoxitPDFSDKPython3.Annot.e_Widget = _fsdk.Annot_e_Widget
static

Annotation type: widget annotation. One of standard annotation in <PDF reference 1.7>.

Note
Foxit PDF SDK treats widget annotation as form control.