API referenceAnnotations

pdfSetLinkHighlightMode

Set/get the document-global default /H highlight mode

C
int32_t __stdcall pdfGetLinkHighlightMode(PPDF IPDF);
BOOL32 __stdcall pdfSetLinkHighlightMode(PPDF IPDF, int32_t Mode);
Delphi
function pdfGetLinkHighlightMode(const IPDF: PPDF): Integer; stdcall;
function pdfSetLinkHighlightMode(const IPDF: PPDF; Mode: Integer): LongBool; stdcall;

Purpose. Set/get the document-global default /H highlight mode applied to newly-created Link annotations — the document-level counterpart of pdfSetAnnotHighlightMode's per-annotation override (Annotation Appearance and Properties).

Parameters.

ParameterDescription
IPDFDocument handle.
ModeNone/Invert/Outline/Push.

Return value. pdfGetLinkHighlightMode: the current default mode. pdfSetLinkHighlightMode: True if IPDF is valid.

See also. pdfSetAnnotHighlightMode.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
[return: MarshalAs(UnmanagedType.Bool)]
Area
Annotations
Category

Setters

Exported names

pdfSetLinkHighlightMode

String variants

The …A form takes UTF-8, …W takes UTF-16; a bare name aliases the ANSI form.

See working code

Worked examples — complete programs in ten languages.