Namespace DRIT.Pdf.Forms

Classes

AcroForm

The interactive form (AcroForm) associated with a PDF document. Access via Form.

Appearance model for button fields (spec §12.7.4.4). Supports per-trigger caption text (label) and icon (form XObject) so that a push button or toggle button can display different content for the normal, rollover, and down states. The caption text entries map to the appearance-characteristics dictionary (/MK): /CA (normal), /RC (rollover), /AC (alternate/down).

ButtonField

A push button that triggers an action.

CheckBoxField

A check box that toggles between checked and unchecked.

ChoiceField

Abstract base for choice fields (spec §12.7.3.3). Choice fields present a list of options from which the user selects. The two concrete subtypes are DropdownField (combo box) and ListBoxField (scrollable list).

ChoiceOptionCollection

An ordered collection of ChoiceOption entries backing a choice field's /Opt array (spec §12.7.3).

DropdownField

A combo box (drop-down list, optionally editable).

FieldAction

Base type for button actions.

FieldActionList

Action list for push button fields.

FieldAppearance

Controls the visual appearance of a form field widget. Call Refresh() to mark that an appearance should be generated; then Get() returns a non-null token usable as a guard in flatten logic. Supports per-trigger caption text (Normal/Rollover/Down) for full appearance state coverage (spec §12.7.4.4, /AP sub-dictionaries).

FieldSelection

Selection options for reset/submit form actions.

FormField

Base class for all interactive form fields.

FormFieldCollection

A collection of interactive form fields. Add fields using the various Add* methods and access existing fields by name via the indexer.

ImportFormDataAction

Import form data action (/S /ImportData).

ListBoxField

A scrollable list box that may allow multiple selection.

RadioButtonField

An individual radio button widget belonging to a mutually exclusive group. Setting Value changes the whole group's selected value.

ResetFormAction

Reset form action (/S /ResetForm).

SignatureAppearance

Visual appearance options for a signature field widget.

SignatureField

A digital signature form field. Create it with AddSignature(). Call Sign(Signer) to attach a signer so the document will be signed on next save.

SignatureLockedFieldCollection

A formalised collection of locked field names associated with a signature field's lock dictionary (spec §12.7.4.5, "Signature Field Lock Dictionary", /Lock /Fields array).

SignatureLockedFieldOptions

Options controlling field locks associated with a signature field (spec §12.7.4.5, "Signature Field Lock Dictionary" — the /Lock entry).

SignaturePolicyIdentifier

Identifies a signature policy for PAdES/ETSI signatures (ETSI EN 319 142-1, signature policy identifier). A signature policy is referenced by its OID and, optionally, by the hash of the policy document. When the hash is absent the policy is identified by OID alone (an "implied" policy).

SubmitFormAction

Submit form action (/S /SubmitForm).

TextField

A single- or multi-line text field.

ToggleButtonField

An on/off toggle button field (spec §12.7.4.2). A toggle button is a button field that toggles between two states — on and off — without belonging to a mutually exclusive radio group. Unlike a check box, the toggle button uses a ButtonAppearance model that supports per-trigger label and icon content.

VariableTextAppearance

Appearance model for variable-text fields (spec §12.7.3.2). Encapsulates the default appearance string (/DA) which carries the font name, font size, and text colour used to render the field's value. A font size of zero means the viewer auto-sizes the text to fit the field.

VariableTextField

Abstract base for fields that use variable-text appearance generation (spec §12.7.3.2). Text fields and choice fields both derive from this class because they share the default-appearance (/DA), justification (/Q), and default-value (/DV) machinery.

XfaForm

XML Forms Architecture (XFA) packets associated with an AcroForm.

Structs

ChoiceOption

A single option in a choice field's /Opt array (spec §12.7.3, Table 226). An option carries an export value (the value submitted) and a display value (the text shown to the user). When both are equal the option is a simple text string; when they differ the /Opt entry is a two-element array [exportValue, displayValue].

Enums

ButtonAppearanceTrigger

The appearance trigger for a button field (spec §12.7.4.4, /AP sub-dictionaries). Determines which appearance state a caption or icon belongs to.

TextJustification

Justification (quadding) for variable-text field content (spec §12.7.3.2, /Q entry).