Click or drag to resize

PdfiumFPDFInterForm_GetFormDict Method

Get an AcroForm dictionary

Namespace: Patagames.Pdf
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.94.2704
Syntax
public static IntPtr FPDFInterForm_GetFormDict(
	IntPtr interForm
)

Parameters

interForm  IntPtr
Handle to interactive forms. Returned by FORM_GetInterForm(IntPtr) function.

Return Value

IntPtr
Handle to dictionary.
Remarks
An interactive form (PDF 1.2) — sometimes referred to as an AcroForm — is a collection of fields for gathering information interactively from the user. A PDF document may contain any number of fields appearing on any combination of pages, all of which make up a single, global interactive form spanning the entire document. Arbitrary subsets of these fields can be imported or exported from the document.

Each field in a document’s interactive form is defined by a field dictionary. For purposes of definition and naming, the fields can be organized hierarchically and can inherit attributes from their ancestors in the field hierarchy. A field’s children in the hierarchy may also include widget annotations that define its appearance on the page. A field whose children are widget annotations is called a terminal field.

As a convenience, when a field has only a single associated widget annotation, the contents of the field dictionary and the annotation dictionary may be merged into a single dictionary containing entries that pertain to both a field and an annotation. (This presents no ambiguity, since the contents of the two kinds of dictionaries do not conflict.) If such an object defines an appearance stream, the appearance must be consistent with the object’s current value as a field.

See Also