API referenceForms

pdfGetCheckBoxChar

Set/get the document-global default ZapfDingbats

C
int32_t __stdcall pdfGetCheckBoxChar(PPDF IPDF);
int32_t __stdcall pdfGetCheckBoxCharEx(PPDF IPDF, uint32_t AField);
BOOL32 __stdcall pdfSetCheckBoxChar(PPDF IPDF, int32_t CheckBoxChar);
Delphi
function pdfGetCheckBoxChar(const IPDF: PPDF): Integer; stdcall;
function pdfGetCheckBoxCharEx(const IPDF: PPDF; AField: Cardinal): Integer; stdcall;
function pdfSetCheckBoxChar(const IPDF: PPDF; CheckBoxChar: Integer): LongBool; stdcall;

Purpose. Set/get the document-global default ZapfDingbats checkbox glyph character (pdfGetCheckBoxChar/pdfSetCheckBoxChar, taking no field handle — a genuinely different mechanism from the FCurrentFieldHandle color cursor in Field Appearance and Style, this is a true document-wide default) applied to newly-created checkboxes that don't specify their own; pdfGetCheckBoxCharEx reads a specific field's own character (falling back to the document default if that field has no override).

Parameters.

ParameterDescription
IPDFDocument handle.
AField*(Ex only)* Target field handle.
CheckBoxChar*(Set only)* The new document-global default character code.

Return value. The character code; 0 if IPDF invalid (or, for Ex, AField doesn't resolve). pdfSetCheckBoxChar: True if IPDF valid.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfGetCheckBoxChar(IntPtr IPDF);
Area
Forms
Category

Getters

Exported names

pdfGetCheckBoxChar

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.