linkDest¶
Class representing the dest property of an outline entry or a link. Describes the destination to which such entries point.
Attribute |
Short Description |
---|---|
destination |
|
file specification (path, filename) |
|
descriptive flags |
|
is this a MAP? |
|
is this a URI? |
|
kind of destination |
|
top left coordinates |
|
name if named destination |
|
name of new window |
|
page number |
|
bottom right coordinates |
|
URI |
Class API
- class linkDest¶
- dest¶
Target destination name if
linkDest.kind
isLINK_GOTOR
andlinkDest.page
is -1.- Type
str
- fileSpec¶
Contains the filename and path this link points to, if
linkDest.kind
isLINK_GOTOR
orLINK_LAUNCH
.- Type
str
- flags¶
A bitfield describing the validity and meaning of the different aspects of the destination. As far as possible, link destinations are constructed such that e.g.
linkDest.lt
andlinkDest.rb
can be treated as defining a bounding box. But the flags indicate which of the values were actually specified, see Link Destination Flags.- Type
int
- isMap¶
This flag specifies whether to track the mouse position when the URI is resolved. Default value: False.
- Type
bool
- isUri¶
Specifies whether this destination is an internet resource (as opposed to e.g. a local file specification in URI format).
- Type
bool
- kind¶
Indicates the type of this destination, like a place in this document, a URI, a file launch, an action or a place in another file. Look at Link Destination Kinds to see the names and numerical values.
- Type
int
- named¶
This destination refers to some named action to perform (e.g. a javascript, see Adobe PDF References). Standard actions provided are NextPage, PrevPage, FirstPage, and LastPage.
- Type
str
- newWindow¶
If true, the destination should be launched in a new window.
- Type
bool
- page¶
The page number (in this or the target document) this destination points to. Only set if
linkDest.kind
isLINK_GOTOR
orLINK_GOTO
. May be -1 iflinkDest.kind
isLINK_GOTOR
. In this caselinkDest.dest
contains the name of a destination in the target document.- Type
int
- uri¶
The name of the URI this destination points to.
- Type
str