Struct InteractiveForm 

pub struct InteractiveForm {
    pub fields: Vec<FormField>,
    pub calculation_order: Vec<String>,
    pub default_appearance: Option<String>,
    pub default_alignment: Alignment,
}

A parsed interactive form (AcroForm).

Fields

fields: Vec<FormField>

Top-level form fields (may contain children for hierarchical fields).

calculation_order: Vec<String>

Calculation order — field names in the order they should be calculated.

default_appearance: Option<String>

Default appearance string (/DA) from the AcroForm dictionary.

default_alignment: Alignment

Default quadding/alignment (/Q) — 0=Left, 1=Center, 2=Right.

Implementations

impl InteractiveForm

pub fn from_catalog<S: PdfSource>( catalog: &Object, store: &ObjectStore<S>, ) -> DocResult<Option<Self>>

Parse the interactive form from the document catalog.

Returns None if no /AcroForm dictionary is present. Field trees are traversed iteratively for WASM safety.

pub fn calculation_order(&self) -> &[String]

Returns the calculation order field names.

pub fn all_fields(&self) -> Vec<&FormField>

Return a flat iterator over all fields (depth-first).

pub fn field_by_name(&self, name: &str) -> Option<&FormField>

Find a field by its fully qualified name.

pub fn field_by_name_mut(&mut self, name: &str) -> Option<&mut FormField>

Find a field by its fully qualified name (mutable).

pub fn all_field_names(&self) -> Vec<String>

Collect all field names in depth-first order.

This can be combined with Self::field_by_name_mut to iterate mutably.

pub fn default_appearance(&self) -> Option<&str>

Return the default appearance string (/DA) from the AcroForm dictionary.

pub fn get_default_appearance(&self) -> Option<&str>

ADR-019 alias for default_appearance().

Corresponds to CPDF_InteractiveForm::GetDefaultAppearance() in PDFium.

pub fn default_alignment(&self) -> Alignment

Return the default alignment (/Q) from the AcroForm dictionary.

pub fn get_form_alignment(&self) -> Alignment

ADR-019 alias for default_alignment().

Corresponds to CPDF_InteractiveForm::GetFormAlignment() in PDFium.

pub fn check_required_fields(&self) -> Vec<&str>

Check which required fields have empty values.

Returns the names of fields that have the Required flag (bit 2) set but have no value.

pub fn control_at_point(&self, x: f64, y: f64) -> Option<(&str, usize)>

Find a form control (widget) at the given point.

Returns the field name and control index if a control’s rect contains (x, y).

Corresponds to CPDF_InteractiveForm::GetControlAtPoint() in PDFium.

pub fn get_control_at_point(&self, x: f64, y: f64) -> Option<(&str, usize)>

ADR-019 alias for control_at_point().

Corresponds to CPDF_InteractiveForm::GetControlAtPoint() in PDFium.

Trait Implementations

impl Clone for InteractiveForm

fn clone(&self) -> InteractiveForm

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InteractiveForm

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.