Foxit PDF SDK
|
Public Member Functions | |
Link () | |
Constructor. | |
Link (Annot annot) | |
Constructor, with parent class object. More... | |
Action | GetAction () |
Get action. More... | |
Annot.HighlightingMode | GetHighlightingMode () |
Get highlighting mode. More... | |
QuadPointsArray | GetQuadPoints () |
Get quadrilaterals. More... | |
bool | RemoveAction () |
Remove action. More... | |
void | SetAction (Action action) |
Set action. More... | |
void | SetHighlightingMode (Annot.HighlightingMode mode) |
Set highlighting mode. More... | |
void | SetQuadPoints (QuadPointsArray quad_points_array) |
Set quadrilaterals. More... | |
![]() | |
Annot (PDFPage page, PDFDictionary annot_dict) | |
Constructor, with PDF page and annotation's PDF dictionary. More... | |
Annot (Annot annot) | |
Constructor, with another annotation object. More... | |
Annot () | |
Constructor. | |
PDFStream | GetAppearanceStream (Annot.AppearanceType type, string appearance_state) |
Get annotation's appearance stream with specified type and state. More... | |
int | GetBorderColor () |
Get border color. More... | |
BorderInfo | GetBorderInfo () |
Get border information. More... | |
string | GetContent () |
Get content. More... | |
RectI | GetDeviceRect (Matrix2D matrix) |
Get annotation rectangle in device coordinate system. More... | |
PDFDictionary | GetDict () |
Get annotation's dictionary object. More... | |
Matrix2D | GetDisplayMatrix (Matrix2D page_display_matrix) |
Get the display matrix, from PDF coordinate system to targeted device coordinate system. More... | |
int | GetFlags () |
Get annotation flags. More... | |
int | GetIndex () |
Get the index of current annotation in the page which current annotation belongs to. More... | |
DateTime | GetModifiedDateTime () |
Get last modified date time. More... | |
PDFDictionary | GetOptionalContent () |
Get the PDF dictionary of annotation's optional content. More... | |
PDFPage | GetPage () |
Get the related PDF page. More... | |
RectF | GetRect () |
Get rectangle, in PDF coordinate system. More... | |
Annot.Type | GetType () |
Get actual annotation type of current annotation. More... | |
string | GetUniqueID () |
Get unique ID. More... | |
bool | HasProperty (Annot.Property property) |
Whether current annotation has the specified annotation's property. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | IsMarkup () |
Check if current annotation is a markup annotation. More... | |
bool | Move (RectF rect) |
Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] (foxit.pdf.PDFPage). More... | |
bool | Move (RectF rect, bool is_reset_appearance) |
Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] (foxit.pdf.PDFPage). More... | |
bool | RemoveProperty (Annot.Property property) |
Remove a specified annotation's property. More... | |
bool | ResetAppearanceStream () |
Reset appearance stream. More... | |
bool | ResetAppearanceStream (bool is_generate_new_appearance_obj) |
Reset appearance stream. More... | |
void | SetBorderColor (int color) |
Set border color. More... | |
void | SetBorderInfo (BorderInfo border) |
Set border information. More... | |
void | SetContent (string content) |
Set content. More... | |
void | SetFlags (int flags) |
Set annotation flags. More... | |
void | SetModifiedDateTime (DateTime date_time) |
Set last modified date time. More... | |
void | SetUniqueID (string unique_id) |
Set unique ID. More... | |
A link annotation represents an action to be performed.
Class foxit.pdf.annots.Link is derived from Annot , and offers functions to get/set link annotation's properties and reset appearance stream of a link annotation.
|
inline |
Constructor, with parent class object.
[in] | annot | Parent class object. |
|
inline |
Get action.
|
inline |
Get highlighting mode.
|
inline |
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.
|
inline |
Remove action.
|
inline |
Set action.
[in] | action | New action to be set. It should be valid. Currently only support following types as the new action: foxit.pdf.actions.Action.Type.e_TypeGoto , foxit.pdf.actions.Action.Type.e_TypeURI , foxit.pdf.actions.Action.Type.e_TypeJavaScript , foxit.pdf.actions.Action.Type.e_TypeNamed , foxit.pdf.actions.Action.Type.e_TypeGoToR , foxit.pdf.actions.Action.Type.e_TypeGoToE , foxit.pdf.actions.Action.Type.e_TypeSubmitForm , foxit.pdf.actions.Action.Type.e_TypeResetForm , foxit.pdf.actions.Action.Type.e_TypeHide , foxit.pdf.actions.Action.Type.e_TypeLaunch , foxit.pdf.actions.Action.Type.e_TypeImportData , foxit.pdf.actions.Action.Type.e_TypeRendition . |
|
inline |
Set highlighting mode.
[in] | mode | New highlighting mode value. Please refer to values starting from foxit.pdf.annots.Annot.HighlightingMode.e_HighlightingNone and this should be one of these values except foxit.pdf.annots.Annot.HighlightingMode.e_HighlightingToggle . |
|
inline |
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 Annot.ResetAppearanceStream after setting quadrilaterals.
[in] | quad_points_array | A valid array of quadrilaterals. It should not be an empty array. |