|
Foxit PDF SDK
|
Public Member Functions | |
| def | ExecuteJavaScriptAction (javascript_action) |
| Execute the JavaScript action associated with the link annotation. More... | |
| def | GetAction () |
| Get action. More... | |
| def | GetHighlightingMode () |
| Get highlighting mode. More... | |
| def | GetQuadPoints () |
| Get quadrilaterals. More... | |
| def | RemoveAction () |
| Remove action. More... | |
| def | SetAction (action) |
| Set action. More... | |
| def | SetHighlightingMode (mode) |
| Set highlighting mode. More... | |
| def | SetQuadPoints (quad_points_array) |
| Set quadrilaterals. More... | |
A link annotation represents an action to be performed.
Class fsdk.Link is derived from Annot , and offers functions to get/set link annotation's properties and reset appearance stream of a link annotation.
| def fsdk.Link.ExecuteJavaScriptAction | ( | javascript_action | ) |
Execute the JavaScript action associated with the link annotation.
| The | executed javascript action and it should be belong to current annotation. It will execute the main JavaScript action if the value is empty. |
| def fsdk.Link.GetAction | ( | ) |
Get action.
| def fsdk.Link.GetHighlightingMode | ( | ) |
Get highlighting mode.
| def fsdk.Link.GetQuadPoints | ( | ) |
Get quadrilaterals.
The order of points in a quadrilateral should be:
The first point is the point in left-top corner of the quadrilateral.
The second point is the point in right-top corner of the quadrilateral.
The third point is the point in left-bottom corner of the quadrilateral.
The fourth point is the point in right-bottom corner of the quadrilateral.
| def fsdk.Link.RemoveAction | ( | ) |
Remove action.
| def 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.ActionE_TypeGoto , fsdk.ActionE_TypeURI , fsdk.ActionE_TypeJavaScript , fsdk.ActionE_TypeNamed , fsdk.ActionE_TypeGoToR , fsdk.ActionE_TypeGoToE , fsdk.ActionE_TypeSubmitForm , fsdk.ActionE_TypeResetForm , fsdk.ActionE_TypeHide , fsdk.ActionE_TypeLaunch , fsdk.ActionE_TypeImportData , fsdk.ActionE_TypeRendition . |
| def fsdk.Link.SetHighlightingMode | ( | mode | ) |
Set highlighting mode.
| [in] | mode | New highlighting mode value. Please refer to values starting from fsdk.AnnotE_HighlightingNone and this should be one of these values except fsdk.AnnotE_HighlightingToggle . |
| def 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 :
The first point is the point in left-top corner of the quadrilateral.
The second point is the point in right-top corner of the quadrilateral.
The third point is the point in left-bottom corner of the quadrilateral.
The fourth point is the point in right-bottom corner of the quadrilateral.
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. |