SetFormFieldCaption

Form fields

Description

Sets the caption of the form field. This applies to buttons, checkboxes and radiobutton form fields only.

Syntax

Delphi

function TPDFlib.SetFormFieldCaption(Index: Integer; Const NewCaption: WideString): Integer;

ActiveX

Function PDFlib::SetFormFieldCaption(Index As Long, NewCaption As String) As Long

DLL

int DLSetFormFieldCaption(int InstanceID, int Index, wchar_t * NewCaption);

Parameters

IndexThe index of the form field
NewCaptionThe new caption for the form field.

Return values

0The form field could not be found or the parameters were invalid The caption of the form field was set successfully
1