API referenceForms

pdfGetFieldHighlightMode

Get/set a field's /H mouse-down highlight mode — the

C
int32_t __stdcall pdfGetFieldHighlightMode(PPDF IPDF, uint32_t AField);
BOOL32 __stdcall pdfSetFieldHighlightMode(PPDF IPDF, uint32_t AField, int32_t Mode);
Delphi
function pdfGetFieldHighlightMode(const IPDF: PPDF; AField: Cardinal): Integer; stdcall;
function pdfSetFieldHighlightMode(const IPDF: PPDF; AField: Cardinal; Mode: Integer): LongBool; stdcall;

Purpose. Get/set a field's /H mouse-down highlight mode — the form-field counterpart of pdfSetAnnotHighlightMode (Annotation Appearance and Properties) and pdfSetLinkHighlightMode's document-global default (Links).

Return value. Getter: the mode; 0 if AField doesn't resolve. Setter: True on success.

See also. pdfSetAnnotHighlightMode.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfGetFieldHighlightMode(IntPtr IPDF, uint AField);
Area
Forms
Category

Forms

Exported names

pdfGetFieldHighlightMode

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.