SetFormFieldRequired

Form fields

Description

Sets the state of a field's is Required flag.

If this flag is set the field must have a value when the form is exported by a submit-form action.

Syntax

Delphi

function TPDFlib.SetFormFieldRequired(Index, Required: Integer): Integer;

ActiveX

Function PDFlib::SetFormFieldRequired(Index As Long, Required As Long) As Long

DLL

int DLSetFormFieldRequired(int InstanceID, int Index, int Required);

Parameters

IndexThe index of the form field
Required0 = Clear the field's Required flag 1 = Set the field's Required flag

Return values

0Could not find the specified form field The Required flag was set successfully
1