GetFormFieldCaptionEx

Form fields

Description

Returns the caption of a form field, based on the specified parameter.

The parameter specifies which string to extract. Otions are for CA, RC and AC strings, but the RC and AC strings are reserved only for pushbuttons. Trying to extract RC or AC string from radiobutton or checkbox will result in null string because these are not used in this types of buttons. More info can be found in PDF format reference manual.

Syntax

Delphi

function TPDFlib.GetFormFieldCaptionEx(Index: Integer; StringType: Integer): WideString;

ActiveX

Function PDFlib::GetFormFieldCaptionEx(Index As Long, StringType As Long) As String

DLL

wchar_t * DLGetFormFieldCaptionEx(int InstanceID, int Index, int StringType);

Parameters

IndexThe index of the form field
StringType1 = CA String 2 = RC String 3 = AC String