Struct TextField 

pub struct TextField {
    pub name: String,
    pub default_value: Option<String>,
    pub value: Option<String>,
    pub max_length: Option<i32>,
    pub multiline: bool,
    pub password: bool,
    pub file_select: bool,
    pub do_not_spell_check: bool,
    pub rich_text: bool,
    pub default_appearance: Option<DefaultAppearance>,
}

Text field for entering text

Fields

name: String

Field name (unique identifier)

default_value: Option<String>

Default value

value: Option<String>

Current value

max_length: Option<i32>

Maximum length of text

multiline: bool

Whether field is multiline

password: bool

Whether field is password field

file_select: bool

Whether field is file select

do_not_spell_check: bool

Whether spellcheck is enabled

rich_text: bool

Whether field allows rich text

default_appearance: Option<DefaultAppearance>

Typed /DA (default appearance) — drives the font/size/colour used to regenerate the field’s /AP/N when Document::fill_field is called. When None, fill_field falls back to Helvetica + WinAnsi (which fails for any non-WinAnsi value — see issue #212).

Implementations

impl TextField

pub fn new(name: impl Into<String>) -> Self

Create a new text field

pub fn with_default_appearance( self, font: Font, font_size: f64, color: Color, ) -> Self

Attach a typed default appearance (font, size, colour) that Document::fill_field will use when regenerating the field’s /AP/N.

Required for non-WinAnsi fills (CJK, Arabic, Cyrillic outside basic Latin, etc.) — the default built-in Helvetica cannot render those and fill_field will otherwise return PdfError::EncodingError.

The font must be registered on the Document via add_font_from_bytes if it’s a Font::Custom(_).

pub fn with_default_value(self, value: impl Into<String>) -> Self

Set the default value

pub fn with_value(self, value: impl Into<String>) -> Self

Set the current value

pub fn with_max_length(self, length: i32) -> Self

Set maximum length

pub fn multiline(self) -> Self

Enable multiline text

pub fn password(self) -> Self

Enable password mode

pub fn to_dict(&self) -> Dictionary

Convert to field dictionary

Trait Implementations

impl Clone for TextField

fn clone(&self) -> TextField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextField

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

Formats the value using the given formatter.