Description
Gets a form field at the specified index or name in a PDF document.
Applies to
Syntax
PDFFormField GetFormField (long index)
PDFFormField GetFormField (string name)
Argument |
Description |
---|---|
index |
The index of the form field object. |
name |
The name of the form field object. |
Return value
Returns the PDFFormField object if it succeeds and -1 if an error occurs. For the full list of error codes, see Error Codes.
Examples
This example gets the form field object at the index 1 in the PDFDocExtractor lpdf_docex.
PDFformfield lpdf_form lpdf_form = lpdf_docex.getformfield(1)
This example gets the form field object with the name "check1" in the PDFDocExtractor lpdf_docex.
PDFformfieldcheckbox lpdf_checkbox lpdf_checkbox = lpdf_docex.getformfield("check1")
See also