5.4.3.4 Link options for pdftex and dvipdfm

Link options are mostly the same for the pdftex and dvipdfm drivers. The pdftex driver has additional options to specify link dimensions.

Common link options

bcolor

Border color. An array of three numbers in the range 0 to 1, representing a color in DeviceRGB.

Example: \hlstart{name}{bcolor=.1 .5 1}{dest123}Link\hlend

bdash

Array of numbers representing on and off stroke lengths for drawing dashes.

Example: \hlstart{name}{bstyle=D,bdash=2 4}{dest123}Link\hlend

bstyle

Link border style:

S

The border is drawn as a solid line.

D

The border is drawn with a dashed line (the dash pattern is specified by the bdash option).

B

The border is drawn in a beveled style.

I

The border is drawn in an inset style.

U

The border is drawn as a line on the bottom of the link rectangle.

The default is `S'.

Example: \hlstart{name}{bstyle=D,bdash=2 4}{dest123}Link\hlend

bwidth

Border width in PostScript points (72 points per inch). The default is 1.

Example: \hlstart{name}{bwidth=2}{dest123}Link\hlend

cmd

Name of the macro (without the leading `\') containing a pdfTeX command or a dvipdfm \special for the raw link.

See Link types for pdftex and dvipdfm, the description of the raw link, for an example.

file

File name for the filename and filepage link types.

See Link types for pdftex and dvipdfm, the descriptions of the filename and filepage links, for an example.

hlight

Link border highlight modes:

I

The rectangle specified by the bounding box of the link is inverted.

N

No highlighting is done.

O

The border of the link is inverted.

P

The region underneath the bounding box of the link is drawn inset into the page.

The default is `I'.

Example: \hlstart{name}{bstyle=S,hlight=O}{dest123}Link\hlend

newwin

For the filename and filepage links, specifies whether the destination document is opened in the same window or in a new window. The settings are:

0

Open in the same window.

non-0

Open in a new window.

empty

Behavior according to the viewer settings.

The default is empty.

See Link types for pdftex and dvipdfm, the descriptions of the filename and filepage links, for an example.

pagefit

For the page and filepage links, specifies how the page must be fitted to the window. pagefit specification is written to the PDF file as is, so it must conform to the PDF standard.

See Link types for pdftex and dvipdfm, the descriptions of the page and filepage links, for an example.

pdftex-specific link options

The dimension options below must be specified as a TeX rule specification. When set to empty, the corresponding value of the parent box is used (this is the default for all dimension options).

depth

Depth of the link.

height

Height of the link.

width

Width of the link.

Example:

          \hlstart{name}{width=5in,height=20pc,depth=0pt}{dest123}
            Link\hlend