THotPDF.GetLoadedFormFieldFlags Method
Returns the complete field flag bitmask integer value for the specified form field in the loaded PDF document
Declaration
function GetLoadedFormFieldFlags(FieldIndex: Integer): Integer;Unit
HPDFDoc
Parameters
| Name | Purpose |
|---|---|
FieldIndex | The zero-based index of the form field |
Return value
Returns the full 32-bit integer value of the field's Ff key; returns 0 if the field has no Ff key or the index is out of bounds
Usage notes
- The return value is a bit mask; each bit is defined by the Field Flags entry of the PDF specification (ReadOnly, Required, NoExport and so on)
- Individual flags can be checked via convenient methods like IsFormFieldRequired and IsFormFieldNoExport without manual parsing
- Returns 0 when the index is out of bounds, which is indistinguishable from a field having no flags; you should verify index validity first