Skip to main content

linkStyles

Type​

property

Summary​

An array of styles to apply to links

Syntax​

get the linkStyles of <widget>
set the linkStyles of <widget> to <array>

Description​

The linkStyles is a numerically indexed array of styles that can be drawn over the rect of a link in the document. If there is no style for a link type then nothing will be drawn to indicate the link on the page.

Each element of the array is an array with the following keys:

  • "type": one of goto, remotegoto, launch, uri or unsupported
  • "fillColor": in R,G,B,A form with each item between 0 and 255. If unset or empty then no fill is applied.
  • "lineColor": in R,G,B,A form with each item between 0 and 255. If unset or empty then the borderColor of the widget will be used to draw the line if the style is not "none"
  • "lineWidth": Optional with default 1. The line width is in PDF points and will therefore scale with the zoom of the widget.
  • "style": one of "none", "underline", "box". Optional with default "none"
  • "prefix": An optional prefix to match the uripath of uri type links or filename of remotegoto or launch type links
  • "suffix": An optional suffix to match the uripath of uri type links or filename of remotegoto or launch type links

Compatibility and Support​

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile