THotPDF.IsFormFieldRequired Method
Determines whether a specified form field in the loaded PDF document is marked as required
Declaration
function IsFormFieldRequired(FieldIndex: Integer): boolean;Unit
HPDFDoc
Parameters
| Name | Purpose |
|---|---|
FieldIndex | The zero-based index of the form field |
Return value
Returns True if the Required bit (bit 2) is set in the field's Ff (Field Flags); otherwise returns False
Usage notes
- The Required flag corresponds to bit 2 of the PDF specification's field flags (counting from 1) and marks the field as mandatory before submission
- Returns False when the index is out of range; you should confirm the total number of fields before calling