|
def | FileAttachment () |
| Constructor. More...
|
|
def | GetFileSpec () |
| Get the file specification. More...
|
|
def | GetIconName () |
| Get icon name. More...
|
|
def | SetFileSpec (file_spec) |
| Set a file specification, which should specify an embedded file. More...
|
|
def | SetIconName (icon_name) |
| Set icon name. More...
|
|
def | Markup (annot) |
| Constructor, with parent class object. More...
|
|
def | AddReply () |
| Add a new reply to the end of reply list. More...
|
|
def | AddRichText (content, style) |
| Add a new rich text string to the end. More...
|
|
def | AddStateAnnot (title, model, state) |
| Add a new state annotation. More...
|
|
def | GetCreationDateTime () |
| Get creation date time. More...
|
|
def | GetGroupElements () |
| Get an element (as markup annotation) from the group that current markup annotation belongs to. More...
|
|
def | GetGroupHeader () |
| Get the header annotation (as primary annotation) of the group that current markup annotation belongs to. More...
|
|
def | GetIntent () |
| Get intent name. More...
|
|
def | GetOpacity () |
| Get opacity value. More...
|
|
def | GetPopup () |
| Get related pop-up annotation. More...
|
|
def | GetReply (index) |
| Get a reply by index. More...
|
|
def | GetReplyCount () |
| Count all replies. More...
|
|
def | GetRichTextContent (index) |
| Get text string of a rich text string specified by index. More...
|
|
def | GetRichTextCount () |
| Get the count of rich text strings. More...
|
|
def | GetRichTextStyle (index) |
| Get style data of a rich text string specified by index. More...
|
|
def | GetStateAnnots (model) |
| Get all state annotations in a specified state model. More...
|
|
def | GetSubject () |
| Get subject string. More...
|
|
def | GetTitle () |
| Get title string. More...
|
|
def | InsertRichText (index, content, style) |
| Insert a new rich text string to the place which is specified by index. More...
|
|
def | IsGrouped () |
| Check whether current markup annotation is in a group or not. More...
|
|
def | RemoveAllReplies () |
| Remove all the replies. More...
|
|
def | RemoveAllStateAnnots () |
| Remove all the state annotations. More...
|
|
def | RemovePopup () |
| Remove related pop-up annotation. More...
|
|
def | RemoveReply (index) |
| Remove a reply by index. More...
|
|
def | RemoveRichText (index) |
| Remove a rich text string specified by index. More...
|
|
def | SetCreationDateTime (date_time) |
| Set creation date time. More...
|
|
def | SetIntent (intent) |
| Set intent name. More...
|
|
def | SetOpacity (opacity) |
| Set opacity value. More...
|
|
def | SetPopup (popup) |
| Set related pop-up annotation. More...
|
|
def | SetRichTextContent (index, content) |
| Set text string of a rich text string specified by index. More...
|
|
def | SetRichTextStyle (index, style) |
| Set style data of a rich text string specified by index. More...
|
|
def | SetSubject (subject) |
| Set subject string. More...
|
|
def | SetTitle (title) |
| Set title string. More...
|
|
def | Ungroup () |
| Ungroup current markup annotation from the group it belongs to. More...
|
|
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...
|
|
|
| e_EndingStyleButt = _fsdk.Markup_e_EndingStyleButt |
| A short line at the endpoint perpendicular to the line itself.
|
|
| e_EndingStyleCircle = _fsdk.Markup_e_EndingStyleCircle |
| A circle filled with the annotation's interior color if any.
|
|
| e_EndingStyleClosedArrow = _fsdk.Markup_e_EndingStyleClosedArrow |
| Two short lines meeting in an acute angle as in the OpenArrow style and connected by a third line to form a triangular closed arrowhead filled with the annotation's interior color if any.
|
|
| e_EndingStyleDiamond = _fsdk.Markup_e_EndingStyleDiamond |
| A diamond shape filled with the annotation's interior color if any.
|
|
| e_EndingStyleNone = _fsdk.Markup_e_EndingStyleNone |
| No special line ending.
|
|
| e_EndingStyleOpenArrow = _fsdk.Markup_e_EndingStyleOpenArrow |
| Two short lines meeting in an acute angle to form an open arrowhead.
|
|
| e_EndingStyleRClosedArrow = _fsdk.Markup_e_EndingStyleRClosedArrow |
| A triangular closed arrowhead in the reverse direction from ClosedArrow.
|
|
| e_EndingStyleROpenArrow = _fsdk.Markup_e_EndingStyleROpenArrow |
| Two short lines in the reverse direction from OpenArrow.
|
|
| e_EndingStyleSlash = _fsdk.Markup_e_EndingStyleSlash |
| A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line itself.
|
|
| e_EndingStyleSquare = _fsdk.Markup_e_EndingStyleSquare |
| A square filled with the annotation's interior color if any.
|
|
| e_MeasureTypeA = _fsdk.Markup_e_MeasureTypeA |
| Measurement of area.
|
|
| e_MeasureTypeD = _fsdk.Markup_e_MeasureTypeD |
| Measurement of distance in any direction.
|
|
| e_MeasureTypeS = _fsdk.Markup_e_MeasureTypeS |
| Measurement of the slope of a line.
|
|
| e_MeasureTypeT = _fsdk.Markup_e_MeasureTypeT |
| Measurement of angles.
|
|
| e_MeasureTypeX = _fsdk.Markup_e_MeasureTypeX |
| Measurement of change along the x axis.
|
|
| e_MeasureTypeY = _fsdk.Markup_e_MeasureTypeY |
| Measurement of change along the y axis.
|
|
| e_StateAccepted = _fsdk.Markup_e_StateAccepted |
| (Used with state model FoxitPDFSDKPython2.Markup.e_StateModelReview ) The user agrees with the change.
|
|
| e_StateCancelled = _fsdk.Markup_e_StateCancelled |
| (Used with state model FoxitPDFSDKPython2.Markup.e_StateModelReview ) The change has been cancelled.
|
|
| e_StateCompleted = _fsdk.Markup_e_StateCompleted |
| (Used with state model FoxitPDFSDKPython2.Markup.e_StateModelReview ) The change has been completed.
|
|
| e_StateDeferred = _fsdk.Markup_e_StateDeferred |
| (Used with state model FoxitPDFSDKPython2.Markup.e_StateModelReview ) The change has been deferred.
|
|
| e_StateFuture = _fsdk.Markup_e_StateFuture |
| (Used with state model FoxitPDFSDKPython2.Markup.e_StateModelReview ) The change will be working in the future.
|
|
| e_StateMarked = _fsdk.Markup_e_StateMarked |
| (Used with state model FoxitPDFSDKPython2.Markup.e_StateModelMarked ) The annotation has been marked by the user.
|
|
| e_StateModelMarked = _fsdk.Markup_e_StateModelMarked |
| Markup annotation state model: marked.
|
|
| e_StateModelReview = _fsdk.Markup_e_StateModelReview |
| Markup annotation state model: review.
|
|
| e_StateNone = _fsdk.Markup_e_StateNone |
| (Used with state model FoxitPDFSDKPython2.Markup.e_StateModelReview ) The user has indicated nothing about the change.
|
|
| e_StateRejected = _fsdk.Markup_e_StateRejected |
| (Used with state model FoxitPDFSDKPython2.Markup.e_StateModelReview ) The user disagrees with the change.
|
|
| e_StateUnmarked = _fsdk.Markup_e_StateUnmarked |
| (Used with state model FoxitPDFSDKPython2.Markup.e_StateModelMarked ) The annotation has not been marked by the user.
|
|
| 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...
|
|