Class to represent link annotation. More...
Inherits Foxit::PDF::Annotations::IAnnot.
Public Member Functions | |
virtual Boolean | IsMarkup () |
Check if current annotation is a markup annotation. More... | |
virtual AnnotType | GetType () |
Get the type of current annotation. More... | |
virtual String^ | GetContents () |
Get the contents data. More... | |
virtual void | SetContents (String^ content) |
Set the contents data. More... | |
virtual DateTime^ | GetModifiedTime () |
Get the last modification time. More... | |
virtual void | SetModifiedTime (DateTime^ modifiedTime) |
Set the last modification time. More... | |
virtual UInt32 | GetFlags () |
Get annotation flags. More... | |
virtual void | SetFlags (UInt32 flags) |
Set annotation flags. More... | |
virtual String^ | GetName () |
Get annotation name string. More... | |
virtual void | SetName (String^ name) |
Get annotation name string. More... | |
virtual RectF^ | GetRect () |
Get rectangle value. More... | |
virtual Boolean | Move (RectF^ rect) |
Move current annotation to a new position specified by a rectangle. More... | |
virtual BorderInfo^ | GetBorderInfo () |
Get border information. More... | |
virtual void | SetBorderInfo (BorderInfo^ border) |
Set border information. More... | |
List< PointF^ >^ | GetQuadPoints () |
Get quadrilaterals points. More... | |
void | SetQuadPoints (const List< PointF^ >^quadPoints) |
Set quadrilaterals points. More... | |
HighlightingMode | GetHighlightingMode () |
Get highlighting mode. More... | |
void | SetHighlightingMode (HighlightingMode highlightingMode) |
Set highlighting mode. More... | |
Int32 | CountActions (ActionTrigger trigger) |
Count actions with specific action trigger. More... | |
Foxit::PDF::Action^ | GetAction (ActionTrigger trigger, Int32 index) |
Get the data of an action specified by index, with specific action trigger. More... | |
void | SetAction (ActionTrigger trigger, Int32 index, Foxit::PDF::Action^ action) |
Set action data to an action specified by index, with specific action trigger. More... | |
Boolean | InsertAction (ActionTrigger trigger, Int32 index, Foxit::PDF::Action^ action) |
Insert a new action, with specific action trigger. More... | |
Boolean | RemoveAction (ActionTrigger trigger, Int32 index) |
Remove an action specified by index, with specific action trigger. More... | |
Boolean | RemoveAllActions (ActionTrigger trigger) |
Remove all actions, with specific action trigger. More... | |
Boolean | ResetApppearanceStream () |
Reset(regenerate) the appearance stream. More... | |
Additional Inherited Members | |
![]() | |
Int64 | pointer |
Pointer to a handle of PDF annotation object. This pointer is not useful outside this SDK. The application should not access the pointer to the handle of the PDF annotation object directly. | |
Class to represent link annotation.
A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.
Int32 Foxit::PDF::Annotations::Link::CountActions | ( | ActionTrigger | trigger | ) |
Count actions with specific action trigger.
[in] | trigger | The trigger of action. Please refer to enumeration Annotations::ActionTrigger and this should be one of its values. |
Foxit::PDF::Action ^ Foxit::PDF::Annotations::Link::GetAction | ( | ActionTrigger | trigger, |
Int32 | index | ||
) |
Get the data of an action specified by index, with specific action trigger.
[in] | trigger | The trigger of action. Please refer to enumeration Annotations::ActionTrigger and this should be one of its values. |
[in] | index | Index of the action to be got. Range: 0 to (actionCount-1). actionCount is returned by function Link::CountActions with same parameter trigger. |
|
virtual |
Get border information.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get the contents data.
Contents data is the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get annotation flags.
Implements Foxit::PDF::Annotations::IAnnot.
HighlightingMode Foxit::PDF::Annotations::Link::GetHighlightingMode | ( | ) |
Get highlighting mode.
|
virtual |
Get the last modification time.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get annotation name string.
The annotation name, a text string uniquely identifying it among all the annotations on its page.
Implements Foxit::PDF::Annotations::IAnnot.
List<PointF^> ^ Foxit::PDF::Annotations::Link::GetQuadPoints | ( | ) |
Get quadrilaterals points.
The order of points of a quadrilateral should be as follows:
(x1, y1) (x2, y2) ---------------- | | | | ---------------- (x3, y3) (x4, y4)
|
virtual |
Get rectangle value.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get the type of current annotation.
Implements Foxit::PDF::Annotations::IAnnot.
Boolean Foxit::PDF::Annotations::Link::InsertAction | ( | ActionTrigger | trigger, |
Int32 | index, | ||
Foxit::PDF::Action^ | action | ||
) |
Insert a new action, with specific action trigger.
[in] | trigger | The trigger of action. Please refer to enumeration Annotations::ActionTrigger and this should be one of its values. |
[in] | index | Index of the action to be got. Range: 0 to (actionCount-1). actionCount is returned by function Link::CountActions with same parameter trigger. If index is out of range, the new action will be inserted to the last. |
[in] | action | A PDF::Action object that specifies the new action data to be inserted. |
|
virtual |
Check if current annotation is a markup annotation.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Move current annotation to a new position specified by a rectangle.
To move an annotation is to reset its rectangle.
[in] | rect | A Foxit::RectF object that specifies the new position. The rect should be "normalized" for PDF page coordination: left is always smaller than right, and bottom is always smaller than top. |
Implements Foxit::PDF::Annotations::IAnnot.
Boolean Foxit::PDF::Annotations::Link::RemoveAction | ( | ActionTrigger | trigger, |
Int32 | index | ||
) |
Remove an action specified by index, with specific action trigger.
[in] | trigger | The trigger of action. Please refer to enumeration Annotations::ActionTrigger and this should be one of its values. |
[in] | index | Index of the action to be got. Range: 0 to (actionCount-1). actionCount is returned by function Link::CountActions with same parameter trigger. |
Boolean Foxit::PDF::Annotations::Link::RemoveAllActions | ( | ActionTrigger | trigger | ) |
Remove all actions, with specific action trigger.
[in] | trigger | The trigger of action. Please refer to enumeration Annotations::ActionTrigger and this should be one of its values. |
Boolean Foxit::PDF::Annotations::Link::ResetApppearanceStream | ( | ) |
Reset(regenerate) the appearance stream.
void Foxit::PDF::Annotations::Link::SetAction | ( | ActionTrigger | trigger, |
Int32 | index, | ||
Foxit::PDF::Action^ | action | ||
) |
Set action data to an action specified by index, with specific action trigger.
[in] | trigger | The trigger of action. Please refer to enumeration Annotations::ActionTrigger and this should be one of its values. |
[in] | index | Index of the action to be got. Range: 0 to (actionCount-1). actionCount is returned by function Link::CountActions with same parameter trigger. |
[in] | action | A PDF::Action object that specifies the new action data to be set. |
|
virtual |
Set border information.
[in] | border | An Annotations::BorderInfo object that specifies the new border information to be set. Please refer to comment of Annotations::BorderInfo for more details. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Set the contents data.
Contents data is the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.
Please ensure that a free text annotation has already been set the default appearance property for keeping its contents data useful.
[in] | content | A String object that specifies the new contents data to be set. It can be nullptr or empty. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Set annotation flags.
[in] | flags | Value of flags. Please refer to enumeration Annotations::Flags and this can be one or combination of its values. |
Implements Foxit::PDF::Annotations::IAnnot.
void Foxit::PDF::Annotations::Link::SetHighlightingMode | ( | HighlightingMode | highlightingMode | ) |
Set highlighting mode.
[in] | highlightingMode | New highlighting mode value. Please refer to enumeration Annotations::HighlightingMode and this should be one of its values. |
|
virtual |
Set the last modification time.
[in] | modifiedTime | A Foxit::DateTime object that specifies the new last modification time data to be set. It should be valid and should not be nullptr. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get annotation name string.
The annotation name, a text string uniquely identifying it among all the annotations on its page.
[in] | name | A String object that specifies the new name string. This can be nullptr or empty. |
Implements Foxit::PDF::Annotations::IAnnot.
void Foxit::PDF::Annotations::Link::SetQuadPoints | ( | const List< PointF^ >^ | quadPoints | ) |
Set quadrilaterals points.
The order of points of a quadrilateral should be as follows:
(x1, y1) (x2, y2) ---------------- | | | | ---------------- (x3, y3) (x4, y4)
[in] | quadPoints | A point array that specifies the new quadrilaterals points. The count of this array should be above 0 and a multiple of 4. |