DL Logo

PDLinkAnnot Definitions

CastToPDLinkAnnot

Header: PDExpT.h:449

Description

Casts a generic annotation or a text annotation to a link annotation.

Related Methods

CastToPDAnnot CastToPDTextAnnot

Syntax

#define CastToPDLinkAnnot ( a ) *( PDLinkAnnot *) &( a )

Parameters

a
The generic annotation or text annotation to cast.

PDLinkAnnot Typedefs

PDLinkAnnot

Header: PDExpT.h:366

Description

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.

Related Methods

CastToPDLinkAnnot PDPageRemoveAnnot

Syntax

typedef OPAQUE_64_BITS PDLinkAnnot;

Used By

PDLinkAnnot Structures

_t_PDLinkAnnotBorder

Header: PDExpT.h:1039

Description

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.

Syntax

struct _t_PDLinkAnnotBorder {
ASInt32 hCornerRadius;
ASInt32 vCornerRadius;
ASInt32 width;
ASInt32 dashArrayLen;
ASFixed dashArray [PDAnnotMaxDashes];
} PDLinkAnnotBorder;

Used By

PDLinkAnnot Functions

PDLinkAnnotGetAction

Header: PDProcs.h:703

Description

Gets a link annotation's action. After you obtain the action, you can execute it with AVDocPerformAction().

Related Methods

Syntax

PDAction PDLinkAnnotGetAction(PDLinkAnnot aLinkAnnot);

Parameters

aLinkAnnot
IN/OUT The link annotation whose action is obtained.

Returns

The link annotation's action.

PDLinkAnnotGetBorder

Header: PDProcs.h:663

Description

Gets the border of a link annotation.

Related Methods

Syntax

void PDLinkAnnotGetBorder(PDLinkAnnot aLinkAnnot, PDLinkAnnotBorder *border);

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.

PDLinkAnnotRemoveAction

Header: PDProcs.h:7951

Description

Removes a link annotation's action.

Related Methods

PDLinkAnnotGetAction PDLinkAnnotSetAction

Syntax

void PDLinkAnnotRemoveAction(PDLinkAnnot aLinkAnnot);

Parameters

aLinkAnnot
The link annotation whose action is removed.

Exceptions

PDLinkAnnotSetAction

Header: PDProcs.h:691

Description

Sets a link annotation's action.

Related Methods

Syntax

void PDLinkAnnotSetAction(PDLinkAnnot aLinkAnnot, PDAction action);

Parameters

aLinkAnnot
IN/OUT The link annotation whose action is set.
action
IN/OUT The new action for the link annotation.

PDLinkAnnotSetBorder

Header: PDProcs.h:679

Description

Sets a link annotation's border.

Related Methods

Syntax

void PDLinkAnnotSetBorder(PDLinkAnnot aLinkAnnot, const PDLinkAnnotBorder *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.

Exceptions

PDAnnotDidChange
PDAnnotWillChange