IsAnnotFormField
Form fields, Annotations and hotspot links
Description
For an annotation to be a form field it must be attached to the document form.
This function checks if the specified annotation is allowed to be attached to the document form and whether it is currently attached.
For an annotation to be attached to the document form it must be a Widget annotation and it cannot be a child of another annotation.
Syntax
Delphi
function TPDFlib.IsAnnotFormField(Index: Integer): Integer;ActiveX
Function PDFlib::IsAnnotFormField(Index As Long) As LongDLL
int DLIsAnnotFormField(int InstanceID, int Index);Parameters
| Index | The index of the annotation. The first annotation on the page has an index of 1. |
|---|
Return values
| 0 | The specified annotation is not a Widget annotation or it is the child of another annotation. |
|---|---|
| 1 | The specified annotation is a form field and is currently attached to the document form. 2 The specified annotation is in the correct format to be a form field but it is not currently attached to the document form. Use the AttachAnnotToForm function to attach it. |