|
Foxit PDF SDK
|
Public Member Functions | |
| constructor () | |
| Constructor. | |
| constructor (annot) | |
| Constructor, with parent class object. More... | |
| ExecuteJavaScriptAction (javascript_action) | |
| Execute the JavaScript action associated with the link annotation. More... | |
| GetAction () | |
| Get action. More... | |
| GetHighlightingMode () | |
| Get highlighting mode. More... | |
| GetQuadPoints () | |
| Get quadrilaterals. More... | |
| RemoveAction () | |
| Remove action. More... | |
| SetAction (action) | |
| Set action. More... | |
| SetHighlightingMode (mode) | |
| Set highlighting mode. More... | |
| SetQuadPoints (quad_points_array) | |
| Set quadrilaterals. More... | |
Public Member Functions inherited from FSDK.Annot | |
| constructor (page, annot_dict) | |
| Constructor, with PDF page and annotation's PDF dictionary. More... | |
| constructor () | |
| Constructor. | |
| GetAppearanceStream (type, appearance_state) | |
| Get annotation's appearance stream with specified type and state. More... | |
| GetBorderColor () | |
| Get border color. More... | |
| GetBorderInfo () | |
| Get border information. More... | |
| GetContent () | |
| Get content. More... | |
| GetDeviceRect (matrix) | |
| Get annotation rectangle in device coordinate system. More... | |
| GetDict () | |
| Get annotation's dictionary object. More... | |
| GetDisplayMatrix (page_display_matrix) | |
| Get the display matrix, from PDF coordinate system to targeted device coordinate system. More... | |
| GetFlags () | |
| Get annotation flags. More... | |
| GetIndex () | |
| Get the index of current annotation in the page which current annotation belongs to. More... | |
| GetModifiedDateTime () | |
| Get last modified date time. More... | |
| GetOptionalContent () | |
| Get the PDF dictionary of annotation's optional content. More... | |
| GetPage () | |
| Get the related PDF page. More... | |
| GetRect () | |
| Get rectangle, in PDF coordinate system. More... | |
| GetType () | |
| Get actual annotation type of current annotation. More... | |
| GetUniqueID () | |
| Get unique ID. More... | |
| HasProperty (property) | |
| Whether current annotation has the specified annotation's property. More... | |
| IsEmpty () | |
| Check whether current object is empty or not. More... | |
| IsMarkup () | |
| Check if current annotation is a markup annotation. More... | |
| Move (rect) | |
| Move current annotation to a new position, specified by a new rectangle in PDF coordinate system. More... | |
| Move (rect, is_reset_appearance) | |
| Move current annotation to a new position, specified by a new rectangle in PDF coordinate system. More... | |
| RemoveProperty (property) | |
| Remove a specified annotation's property. More... | |
| ResetAppearanceStream () | |
| Reset appearance stream. More... | |
| ResetAppearanceStream (is_generate_new_appearance_obj) | |
| Reset appearance stream. More... | |
| SetBorderColor (color) | |
| Set border color. More... | |
| SetBorderInfo (border) | |
| Set border information. More... | |
| SetContent (content) | |
| Set content. More... | |
| SetFlags (flags) | |
| Set annotation flags. More... | |
| SetModifiedDateTime (date_time) | |
| Set last modified date time. More... | |
| SetUniqueID (unique_id) | |
| Set unique ID. More... | |
Additional Inherited Members | |
Static Public Attributes inherited from FSDK.Annot | |
| static | e_3D |
| Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_AppearanceTypeDown |
| Annotation's down appearance. | |
| static | e_AppearanceTypeNormal |
| Enumeration for the type of annotation's appearance. More... | |
| static | e_AppearanceTypeRollover |
| Annotation's rollover appearance. | |
| static | e_Caret |
| Annotation type: caret annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Circle |
| Annotation type: circle annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_FileAttachment |
| Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_FlagHidden |
| Annotation flag: hidden. More... | |
| static | e_FlagInvisible |
| Enumeration for PDF annotation flags. More... | |
| static | e_FlagLocked |
| Annotation flag: locked. More... | |
| static | e_FlagLockedContents |
| Annotation flag: locked contents. More... | |
| static | e_FlagNoRotate |
| Annotation flag: no rotate. More... | |
| static | e_FlagNoView |
| Annotation flag: no view. More... | |
| static | e_FlagNoZoom |
| Annotation flag: no zoom. More... | |
| static | e_FlagPrint |
| Annotation flag: print. More... | |
| static | e_FlagReadOnly |
| Annotation flag: read only. More... | |
| static | e_FlagToggleNoView |
| Annotation flag: toggle no view. More... | |
| static | e_FreeText |
| Annotation type: free text annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Highlight |
| Annotation type: highlight annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_HighlightingInvert |
| Highlighting mode: Invert, which is to invert the contents of the annotation rectangle. | |
| static | e_HighlightingNone |
| Enumeration for PDF annotation highlighting mode. More... | |
| static | e_HighlightingOutline |
| Highlighting mode: Outline, which is to invert the annotation's border. | |
| static | e_HighlightingPush |
| Highlighting mode: Push, which is to display the annotation's down appearance, if any. | |
| static | e_HighlightingToggle |
| Highlighting mode: Toggle. This is only useful for widget annotation. | |
| static | e_Ink |
| Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Line |
| Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Link |
| Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_MKEntryBackgroundColor |
| Background color entry. "BG" in MK dictionary. | |
| static | e_MKEntryBorderColor |
| Border color entry. "BC" in MK dictionary. | |
| static | e_MKEntryDownCaption |
| Down caption (or alternate caption) entry. "AC" in MK dictionary. More... | |
| static | e_MKEntryDownIcon |
| Down icon (or alternate icon) entry. "IX" in MK dictionary. More... | |
| static | e_MKEntryIconCaptionRelation |
| Icon and caption relation entry. "TP" in MK dictionary. More... | |
| static | e_MKEntryIconFit |
| Icon fit information entry. "IF" in MK dictionary. More... | |
| static | e_MKEntryNormalCaption |
| Normal caption entry. "CA" in MK dictionary. More... | |
| static | e_MKEntryNormalIcon |
| Normal icon entry. "I" in MK dictionary. More... | |
| static | e_MKEntryRolloverCaption |
| Rollover caption entry. "RC" in MK dictionary. More... | |
| static | e_MKEntryRolloverIcon |
| Rollover icon entry. "RI" in MK dictionary. More... | |
| static | e_MKEntryRotation |
| Enumeration for annotation's MK dictionary (an appearance characteristics) entry. More... | |
| static | e_MKRelationCaptionAboveIcon |
| Caption above the icon. | |
| static | e_MKRelationCaptionBelowIcon |
| Caption below the icon. | |
| static | e_MKRelationCaptionLeft |
| Caption to the left of the icon. | |
| static | e_MKRelationCaptionOvrlayOnIcon |
| Caption overlaid directly on the icon. | |
| static | e_MKRelationCaptionRight |
| Caption to the right of the icon. | |
| static | e_MKRelationNoCaption |
| No caption; icon only. | |
| static | e_MKRelationNoIcon |
| Enumeration for icon and caption relative position in annotation's MK dictionary. More... | |
| static | e_Movie |
| Annotation type: movie annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Note |
| Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PDF reference 1.7>. | |
| static | e_PagingSeal |
| Annotation type: paging seal annotation. A Foxit PDF SDK custom annotation type (not a standard annotation type). | |
| static | e_Polygon |
| Annotation type: polygon annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_PolyLine |
| Annotation type: polyline annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Popup |
| Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_PrinterMark |
| Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_PropertyBorderColor |
| Annotation property: border color. More... | |
| static | e_PropertyCreationDate |
| Annotation property: creation date. More... | |
| static | e_PropertyFillColor |
| Annotation property: fill color. More... | |
| static | e_PropertyModifiedDate |
| Enumeration for some PDF annotation property. More... | |
| static | e_PSInk |
| Annotation type: pressure sensitive ink annotation. | |
| static | e_Redact |
| Annotation type: redact annotation. | |
| static | e_RichMedia |
| Annotation type: rich media annotation. | |
| static | e_Screen |
| Annotation type: screen annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Sound |
| Annotation type: sound annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Square |
| Annotation type: square annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Squiggly |
| Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Stamp |
| Annotation type: stamp annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_StrikeOut |
| Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_TrapNet |
| Annotation type: trap network annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Underline |
| Annotation type: underline annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_UnknownType |
| Enumeration for PDF annotation type. More... | |
| static | e_Watermark |
| Annotation type: watermark annotation. One of standard annotation in <PDF reference 1.7>. | |
| static | e_Widget |
| Annotation type: widget annotation. One of standard annotation in <PDF reference 1.7>. More... | |
A link annotation represents an action to be performed.
Class FSDK.Link is derived from FSDK.Annot, and offers functions to get/set link annotation's properties and reset appearance stream of a link annotation.
| FSDK.Link.constructor | ( | annot | ) |
Constructor, with parent class object.
| [in] | annot | Parent class object. |
| FSDK.Link.ExecuteJavaScriptAction | ( | javascript_action | ) |
Execute the JavaScript action associated with the link annotation.
| JavaScriptAction | The executed javascript action and it should be belong to current annotation. It will execute the main JavaScript action if the value is empty. |
| FSDK.Link.GetAction | ( | ) |
Get action.
| FSDK.Link.GetHighlightingMode | ( | ) |
Get highlighting mode.
| FSDK.Link.GetQuadPoints | ( | ) |
Get quadrilaterals.
The order of points in a quadrilateral should be:
| FSDK.Link.RemoveAction | ( | ) |
Remove action.
| FSDK.Link.SetAction | ( | action | ) |
Set action.
| [in] | action | New action to be set. It should be valid. Currently only support following types as the new action: FSDK.Action.e_TypeGoto, FSDK.Action.e_TypeURI, FSDK.Action.e_TypeJavaScript, FSDK.Action.e_TypeNamed, FSDK.Action.e_TypeGoToR, FSDK.Action.e_TypeGoToE, FSDK.Action.e_TypeSubmitForm, FSDK.Action.e_TypeResetForm, FSDK.Action.e_TypeHide, FSDK.Action.e_TypeLaunch, FSDK.Action.e_TypeImportData, FSDK.Action.e_TypeRendition. |
| FSDK.Link.SetHighlightingMode | ( | mode | ) |
Set highlighting mode.
| [in] | mode | New highlighting mode value. Please refer to values starting from FSDK.Annot.e_HighlightingNone and this should be one of these values except FSDK.Annot.e_HighlightingToggle. |
| FSDK.Link.SetQuadPoints | ( | quad_points_array | ) |
Set quadrilaterals.
This property has effect on the link annotation's appearance.The order of points in a quadrilateral should be :
If user wants the new quadrilaterals has effect on annotation's appearance, please call function FSDK.Annot.ResetAppearanceStream after setting quadrilaterals.
| [in] | quad_points_array | A valid array of quadrilaterals. It should not be an empty array. |