API referenceCore SDK

pdfGetTabOrderMode

Set/get the document's /Tabs page-attribute default (form

C
const char* __stdcall pdfGetTabOrderModeA(PPDF IPDF);
const wchar_t* __stdcall pdfGetTabOrderModeW(PPDF IPDF);
int32_t __stdcall pdfSetTabOrderModeA(PPDF IPDF, const char* Mode);
int32_t __stdcall pdfSetTabOrderModeW(PPDF IPDF, const wchar_t* Mode);
Delphi
function pdfGetTabOrderModeA(const IPDF: PPDF): PAnsiChar; stdcall;
function pdfGetTabOrderModeW(const IPDF: PPDF): PWideChar; stdcall;
function pdfSetTabOrderModeA(const IPDF: PPDF; Mode: PAnsiChar): Integer; stdcall;
function pdfSetTabOrderModeW(const IPDF: PPDF; Mode: PWideChar): Integer; stdcall;

Purpose. Set/get the document's /Tabs page-attribute default (form field keyboard tab order — Row/Column/Structure order), stored as a string rather than an enum in this ABI.

Description. Unlike pdfGetTabLen/pdfSetSpaceWidthFactor above, this pair is realSetTabsMode genuinely stores the requested tab order mode for use in the /Tabs page attribute at serialization.

Parameters.

ParameterDescription
IPDFDocument handle.
ModeThe tab-order mode string (e.g. "R"/"C"/"S").

Return value. Getter: the current mode string, or nil if unset / IPDF invalid. Setter: 1 on success; 0 if IPDF invalid.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern IntPtr pdfGetTabOrderModeW(IntPtr IPDF);
public static extern IntPtr pdfGetTabOrderMode(IntPtr IPDF);
public static extern IntPtr pdfGetTabOrderModeA(IntPtr IPDF);
Area
Core SDK
Category

Getters

Exported names

pdfGetTabOrderModeW pdfGetTabOrderMode pdfGetTabOrderModeA

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.