Table of Contents

Class PdfFormField

Namespace
PdfEngine.Vector.Forms
Assembly
PdfEngine.Vector.dll

A terminal form field (ISO 32000-2 12.7.4) with its inherited attributes resolved: the full dotted name, kind, flags, value, options and widgets.

public sealed class PdfFormField
Inheritance
PdfFormField
Inherited Members

Properties

DefaultAppearance

public string? DefaultAppearance { get; init; }

Property Value

string

DefaultValue

public string DefaultValue { get; init; }

Property Value

string

Flags

public int Flags { get; init; }

Property Value

int

FullName

public required string FullName { get; init; }

Property Value

string

IsChecked

public bool IsChecked { get; }

Property Value

bool

IsComb

public bool IsComb { get; }

Property Value

bool

IsEditableCombo

public bool IsEditableCombo { get; }

Property Value

bool

IsMultiSelect

public bool IsMultiSelect { get; }

Property Value

bool

IsMultiline

public bool IsMultiline { get; }

Property Value

bool

IsPassword

public bool IsPassword { get; }

Property Value

bool

IsReadOnly

public bool IsReadOnly { get; }

Property Value

bool

IsRequired

public bool IsRequired { get; }

Property Value

bool

IsSigned

A signature field whose /V holds a signature (an empty one is waiting to be signed).

public bool IsSigned { get; init; }

Property Value

bool

Kind

public required PdfFormFieldKind Kind { get; init; }

Property Value

PdfFormFieldKind

MaxLength

public int MaxLength { get; init; }

Property Value

int

ObjectNumber

public required int ObjectNumber { get; init; }

Property Value

int

Options

Choice options: (export value, display text).

public IReadOnlyList<(string Export, string Display)> Options { get; init; }

Property Value

IReadOnlyList<(string Export, string Display)>

Quadding

0 left, 1 centred, 2 right (/Q).

public int Quadding { get; init; }

Property Value

int

RadiosInUnison

Radio buttons with the same on-state turn on and off together (/Ff bit 26).

public bool RadiosInUnison { get; }

Property Value

bool

Scripts

The field's JavaScript actions (/AA, 12.6.3 Table 199) by trigger: K keystroke, F format, V validate, C calculate. Read, never run: PdfFormScripts recognises the standard Acrobat functions they call.

public IReadOnlyDictionary<string, string> Scripts { get; init; }

Property Value

IReadOnlyDictionary<string, string>

Tooltip

public string? Tooltip { get; init; }

Property Value

string

Value

public string Value { get; init; }

Property Value

string

Values

Selected values of a multi-select list box.

public IReadOnlyList<string> Values { get; init; }

Property Value

IReadOnlyList<string>

Widgets

public required IReadOnlyList<PdfFormWidget> Widgets { get; init; }

Property Value

IReadOnlyList<PdfFormWidget>