| Layer | PD_Layer |
| Object | PDLinkAnnot |
A PDLinkAnnot corresponds to a link annotation (see Sections 8.4.5, Annotation Types, in the PDF Reference). You can use any PDAnnot method on a PDLinkAnnot.
Plug-ins can get and set:
Plug-ins can create new link annotations and delete existing ones, using the PDPage methods.
The following are useful macros for casting among PDAnnot and its text annotation and link annotation subclasses:
| Define | ||
|---|---|---|
| CastToPDLinkAnnot
Casts a generic annotation or a text annotation to a link annotation.
|
||
| Typedef | ||
|---|---|---|
| PDLinkAnnot
A link annotation on a page in a PDF file. You can use any PDAnnot method on a PDLinkAnnot.
|
||
| PDLinkAnnotBorder | ||
| Structure | ||
|---|---|---|
| _t_PDLinkAnnotBorder
The border's dash pattern is specified by dashArray and dashArrayLen. This is a normal PostScript dash pattern (an array of on/off stroke lengths used cyclically) except that zero is always used as the offset (phase) and the number of array entries is limited to PDAnnotMaxDashes. The number of valid dashArray entries is specified by dashArrayLen; a dashArrayLen of 0 specifies a solid border.
|
||
| Method | ||
|---|---|---|
|
PDAction PDLinkAnnotGetAction(PDLinkAnnot aLinkAnnot)
Gets a link annotation's action. After you obtain the action, you can execute it with AVDocPerformAction().
|
||
|
Gets the border of a link annotation.
|
||
|
void PDLinkAnnotRemoveAction(PDLinkAnnot aLinkAnnot)
Removes a link annotation's action.
|
||
|
Sets a link annotation's action.
|
||
|
Sets a link annotation's border.
|
||
| CastToPDLinkAnnot |
| Product availability: All |
| Platform availability: All |
#define CastToPDLinkAnnot *(PDLinkAnnot *)&(a)
Casts a generic annotation or a text annotation to a link annotation.
See Also
| File: PDExpT.h |
| Line: 445 |
| PDLinkAnnot |
| Product availability: All |
| Platform availability: All |
typedef OPAQUE_64_BITS PDLinkAnnot;
A link annotation on a page in a PDF file. You can use any PDAnnot method on a PDLinkAnnot.
Applications can:
Get and set the bounding rectangle and color using PDAnnot methods.
Get and set the action that occurs when the link is activated, and the link's border, using PDLinkAnnot methods.
Create new link annotations and delete existing ones using the PDPage methods.
To obtain a link annotation, use any of the PDAnnot calls, followed by CastToPDLinkAnnot(). The annotation passed to CastToPDLinkAnnot() must be a link annotation; other annotation types are not converted into link annotations.
See Also
| File: PDExpT.h |
| Line: 361 |
| PDLinkAnnotBorder |
| Product availability: All |
| Platform availability: All |
typedef _t_PDLinkAnnotBorder PDLinkAnnotBorder;
| File: PDExpT.h |
| Line: 1051 |
| _t_PDLinkAnnotBorder |
| Product availability: All |
| Platform availability: All |
struct _t_PDLinkAnnotBorder {
ASInt32 hCornerRadius;
ASInt32 vCornerRadius;
ASInt32 width;
ASInt32 dashArrayLen;
ASFixed dashArray[PDAnnotMaxDashes];
}
The border's dash pattern is specified by dashArray and dashArrayLen. This is a normal PostScript dash pattern (an array of on/off stroke lengths used cyclically) except that zero is always used as the offset (phase) and the number of array entries is limited to PDAnnotMaxDashes. The number of valid dashArray entries is specified by dashArrayLen; a dashArrayLen of 0 specifies a solid border.
See Also
| File: PDExpT.h |
| Line: 1035 |
| PDLinkAnnotGetAction | () |
| Product availability: All |
| Platform availability: All |
PDAction PDLinkAnnotGetAction(PDLinkAnnot aLinkAnnot)
Gets a link annotation's action. After you obtain the action, you can execute it with AVDocPerformAction().
Parameters
aLinkAnnot — | IN/OUT The link annotation whose action is obtained. |
The link annotation's action. |
See Also
Since
| File: PDProcs.h |
| Line: 702 |
| PDLinkAnnotGetBorder | () |
| Product availability: All |
| Platform availability: All |
void PDLinkAnnotGetBorder(PDLinkAnnot aLinkAnnot, PDLinkAnnotBorder* border)
Gets the border of a link annotation.
Parameters
aLinkAnnot — | IN/OUT The link annotation whose border is obtained. |
|
border — | IN/OUT (Filled by the method) A pointer to a structure containing the link border. Link corner radii are ignored by the Acrobat viewers. |
See Also
Since
| File: PDProcs.h |
| Line: 662 |
| PDLinkAnnotRemoveAction | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
void PDLinkAnnotRemoveAction(PDLinkAnnot aLinkAnnot)
Removes a link annotation's action.
Parameters
aLinkAnnot — | The link annotation whose action is removed. |
See Also
Exceptions
Notifications
Since
| File: PDProcs.h |
| Line: 7790 |
| PDLinkAnnotSetAction | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
void PDLinkAnnotSetAction(PDLinkAnnot aLinkAnnot, PDAction action)
Sets a link annotation's action.
Parameters
aLinkAnnot — | IN/OUT The link annotation whose action is set. |
|
action — | IN/OUT The new action for the link annotation. |
See Also
Notifications
Since
| File: PDProcs.h |
| Line: 690 |
| PDLinkAnnotSetBorder | () |
| Product availability: Acrobat, PDFL |
| Platform availability: Macintosh, Windows, UNIX |
void PDLinkAnnotSetBorder(PDLinkAnnot aLinkAnnot, const PDLinkAnnotBorder* border)
Sets a link annotation's border.
Parameters
aLinkAnnot — | IN/OUT The link annotation whose border is set. |
|
border — | IN/OUT A pointer to a structure containing the link border. Link corner radii are ignored by the Acrobat viewers. |
See Also
Exceptions
Notifications
Since
| File: PDProcs.h |
| Line: 678 |