Link Import/Export File Format

AutoBookmark plug-in for Adobe® Acrobat®

Output File Format for Import/Export PDF Links

The table below describes the output file format used for the link import/export process:

Field Number	Field Type	Field Description
1	Integer Number	Page number where a link annotation is located ( IMPORTANT: This is a page number where the link is located, not a destination page number for the link action)
2	Single letter	Link highlight mode (N - "None", O - "Outline", P - "Inset"/"Push", I - "Invert")
3	Single letter	Link border style (S - "Solid", D - "Dashed", B - "Beveled", I - "Inset", U - "Underline)
4	Integer Number	Border width in pixels (0, 1, 2, 3...)
5	Integer Number	Annotation flags (XOR of the various system-defined flags). Typically contains information about link visibility.
6	Integer Number	Color of the link border. Integer number that combines Red, Green and Blue components into a single value. Same as the output of RGB() macro in C or C++.
7	Floating point	X-Coordinate of the left edge of annotation's bounding rectangle, in points. Coordinates are shown in page coordinate system with origin in the lower left corner of the page.
8	Floating point	X-Coordinate of the right edge of annotation's bounding rectangle, in points. Coordinates are shown in page coordinate system with origin in the lower left corner of the page.
9	Floating point	Y-Coordinate of the top edge of annotation's bounding rectangle, in points. Coordinates are shown in page coordinate system with origin in the lower left corner of the page.
10	Floating point	Y-Coordinate of the bottom edge of annotation's bounding rectangle, in points. Coordinates are shown in page coordinate system with origin in the lower left corner of the page.
>10	Various	The rest of the fields represent a link action. The format is different for each action type. See reference tables below.

"Go to a Page in this Document" Action

Format definition for a "Go to a page in this document" action (when using a direct page reference):

Field Number	Field Type	Field Description
1	Integer Number	Destination page number  (Page numbering starts from 1)
2	View Definition	Fit type, view destination rectangle, zoom factor. For example: {XYZ;0.000000;-32768.000000;792.000000;-32768.000000;0.000000}. Value of -32768.0000000 indicates a value that is not set (ignored) in the current view definition.

Using Named Destinations

Format definition for a "Go to a page in this document" action (when using a named destination):

Field Number	Field Type	Field Description
1	String	Destination name starting with @ symbol. For example, @FirstPageView refers to named destination "FirstPageView".

"Go to a Page in Another Document" Action

Format definition for a "Go to a page in another document" action (when using a direct page reference):

Field Number	Field Type	Field Description
1	Integer Number	Destination page number
2	View Definition	Fit type, view destination rectangle, zoom factor. For example: {XYZ;0.000000;-32768.000000;792.000000;-32768.000000;0.000000}. Value of -32768.0000000 indicates a value that is not set (ignored) in the current view definition.
3	String	Relative file path description for a target document. Should always start with file:// keyword. For example: file://mydocument.pdf refers to a file mydocument.pdf that is located in the same folder as a current document. To specify a folder one level below a current one enter the following: FolderName/Filename. For example, file://Help/Index.pdf refers to a file that is located in folder "Help" one level below a current folder (the folder where the originating document is stored).

Using Named Destinations in "Go to a page in another document" Action

Format definition for a "Go to a page in another document" action (when using a named destination):

Field Number	Field Type	Field Description
1	String	Destination name starting with @ symbol. For example, @FirstPageView refers to named destination "FirstPageView".
2	String	Relative file path description for a destination document. Should always start from file:// keyword. For example: file://mydocument.pdf refers to a file mydocument.pdf that is located in the same folder as a current document. To specify a folder one level below a current one enter the following: FolderName/Filename. For example, file://Help/Index.pdf refers to a file that is located in folder "Help" one level below a current folder (the folder where the originating document is stored).

"Open a Web Page" Action

Format definition for a "Open a web page" action:

Field Number	Field Type	Field Description
1	String	URL address of the destination web page. For example: http://www.cnn.com. URL definitions should always start with http:// keyword.

"Execute a Menu" Action

Format definition for a "Execute a menu" action:

Field Number	Field Type	Field Description
1	String	Adobe Acrobat-specific menu name. For example: menu:FirstPage . Should always start with menu: keyword. There are four standard menu names (also known as "named actions") that are always available in any PDF-compliant viewer: NextPage, PrevPage, FirstPage and LastPage. All other menu names are not guaranteed to be always available.

"Open a File" Action

Format definition for a "Open a file" action:

Field Number	Field Type	Field Description
1	String	Relative file path description for a destination file. Should always start with file:// keyword. For example: file://mydocument.doc refers to a file mydocument.doc that is located in the same folder as a current document.To specify a folder one level below a current one enter the following: FolderName/Filename. For example, file://Help/Index.pdf refers to a file that is located in folder "Help" one level below a current folder (the folder where the originating document is stored).