FormFields Property

Summary

Gets a list of the form fields found on this page.

Syntax

C++/CLI

Java

Python

public IList<PDFFormField> FormFields {get;}

public java.util.List<PDFFormField> getFormFields();

public: 
property IList<PDFFormField^>^ FormFields { 
   IList<PDFFormField^>^ get(); 
}

FormFields # get  (PDFDocumentPage)

Property Value

An IList of PDFFormField items that contains the form fields found on the page. The default value is null.

Remarks

By default, the Annotations, Objects, FormFields, Signatures and Hyperlinks lists are not populated when a new PDFDocument is created and the values of these properties are null. You must call the PDFDocument.ParsePages method to parse the items are you interested in (depending on the PDFParsePagesOptions passed as the options parameter to the method). This is done for performance reasons and to give the user the ability to parse only the objects and pages of interest.

The FormFields list will be populated if PDFParsePagesOptions.FormFields is passed as part of the options parameter to PDFDocument.ParsePages. After this method returns, all the pages parsed will have their FormFields properties populated either with a list of the form fields found in the page or an empty list (with IList.Count equal to 0).

When parsing is finished, the FormFields property will contain a list of the PDFFormField items found in the page.

Requirements

Target Platforms