Class AcroForm

Namespace

UglyToad.PdfPig.AcroForms

Assembly

UglyToad.PdfPig.dll

A collection of interactive fields for gathering data from a user through dropdowns, textboxes, checkboxes, etc. Each PdfDocument with form functionality contains a single AcroForm spread across one or more pages.

public class AcroForm

Inheritance

object

AcroForm

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AcroFormExtensions.GetFields(AcroForm)

Remarks

The name AcroForm distinguishes this from the other form type called form XObjects which act as templates for repeated sections of content.

Properties

Dictionary

The raw PDF dictionary which is the root form object.

public DictionaryToken Dictionary { get; }

Property Value

DictionaryToken

Fields

All root fields in this form.

public IReadOnlyList<AcroFieldBase> Fields { get; }

Property Value

IReadOnlyList<AcroFieldBase>

NeedAppearances

Whether all widget annotations need appearance dictionaries and streams.

public bool NeedAppearances { get; }

Property Value

bool

SignatureFlags

Document-level characteristics related to signature fields.

public SignatureFlags SignatureFlags { get; }

Property Value

SignatureFlags

Methods

GetFieldsForPage(int)

Get the set of fields which appear on the given page number.

public IEnumerable<AcroFieldBase> GetFieldsForPage(int pageNumber)

Parameters

pageNumber int

Returns

IEnumerable<AcroFieldBase>

ToString()

public override string ToString()

Returns

string