表单字段创建

向 PDF 文档添加交互式表单字段。PDF Oxide 支持所有标准 AcroForm 控件类型：文本字段、复选框、单选按钮组、组合框（下拉框）、列表框和按钮。

绑定覆盖（v0.3.38）。 FluentPageBuilder 在 Rust、Python、Node/TypeScript、C#、Go 和 WASM 中提供 text_field、checkbox、combo_box、radio_group 和 push_button（参见 DocumentBuilder → AcroForm 控件）。本页中较底层、仅限 Rust 的 PdfWriter::text_field / checkbox 等 API 暴露了额外的逐项控件设置（多行文本、密码字段、列表框、边框颜色），当你需要精细的 AcroForm 控制时使用它们。填写和扁平化现有表单在所有绑定中均可用 — 参见表单字段编辑与填充 PDF 表单。

快速示例

Rust

use pdf_oxide::writer::{PdfWriter, TextFieldWidget, CheckboxWidget};
use pdf_oxide::geometry::Rect;

let mut writer = PdfWriter::new();
{
    let mut page = writer.add_letter_page();
    page.add_text("Name:", 72.0, 720.0, "Helvetica", 12.0);
    page.text_field("name", Rect::new(130.0, 716.0, 200.0, 20.0));
    page.add_text("I agree to terms:", 72.0, 690.0, "Helvetica", 12.0);
    page.checkbox("agree", Rect::new(200.0, 686.0, 15.0, 15.0));
    page.finish();
}
writer.save("form.pdf")?;

Python

from pdf_oxide import DocumentBuilder

(DocumentBuilder()
    .letter_page()
        .at(72, 720).text("Name:")
        .text_field("name", 130, 716, 200, 20)
        .at(72, 690).text("I agree to terms:")
        .checkbox("agree", 200, 686, 15, 15, False)
    .done()
    .save("form.pdf"))

Node / TypeScript

import { DocumentBuilder } from "pdf-oxide";

await new DocumentBuilder()
  .letterPage()
    .at(72, 720).text("Name:")
    .textField("name", 130, 716, 200, 20)
    .at(72, 690).text("I agree to terms:")
    .checkbox("agree", 200, 686, 15, 15, false)
  .done()
  .save("form.pdf");

C#

DocumentBuilder.Create()
    .LetterPage()
        .At(72, 720).Text("Name:")
        .TextField("name", 130, 716, 200, 20)
        .At(72, 690).Text("I agree to terms:")
        .Checkbox("agree", 200, 686, 15, 15, false)
    .Done()
    .Save("form.pdf");

Go

builder := pdfoxide.NewDocumentBuilder()
builder.LetterPage().
    At(72, 720).Text("Name:").
    TextField("name", 130, 716, 200, 20, "").
    At(72, 690).Text("I agree to terms:").
    Checkbox("agree", 200, 686, 15, 15, false).
    Done()
_ = builder.Save("form.pdf")

控件类型

TextFieldWidget – Text Input

单行或多行文本输入字段。

use pdf_oxide::writer::TextFieldWidget;
use pdf_oxide::geometry::Rect;

// Basic text field
let field = TextFieldWidget::new("username", Rect::new(72.0, 700.0, 200.0, 20.0));

// Fully configured text field
let field = TextFieldWidget::new("email", Rect::new(72.0, 670.0, 250.0, 20.0))
    .with_value("user@example.com")
    .with_default_value("")
    .with_max_length(100)
    .required()
    .with_tooltip("Enter your email address")
    .with_font("Helv", 12.0)
    .with_text_color(0.0, 0.0, 0.0)
    .with_border_color(0.5, 0.5, 0.5)
    .with_background_color(1.0, 1.0, 0.95);

// Password field (characters are masked)
let password = TextFieldWidget::new("password", Rect::new(72.0, 640.0, 200.0, 20.0))
    .password();

// Multi-line text area
let notes = TextFieldWidget::new("notes", Rect::new(72.0, 550.0, 300.0, 80.0))
    .multiline();

关键方法：

Method	描述
.with_value(s)	设置当前文本值
.with_default_value(s)	设置重置值
.with_max_length(n)	最大字符数
.required()	标记为必填字段
.read_only()	禁止编辑
.password()	掩码输入字符
.multiline()	允许多行
.with_tooltip(s)	悬停提示文本
.with_font(name, size)	设置字体和大小
.with_text_color(r, g, b)	设置文本颜色 (0.0-1.0 RGB)
.with_border_color(r, g, b)	设置边框颜色
.with_background_color(r, g, b)	设置背景颜色

CheckboxWidget – Checkbox

带有开/关状态的切换字段。

use pdf_oxide::writer::CheckboxWidget;
use pdf_oxide::geometry::Rect;

// Basic checkbox
let cb = CheckboxWidget::new("agree", Rect::new(72.0, 700.0, 15.0, 15.0));

// Pre-checked checkbox with custom export value
let cb = CheckboxWidget::new("newsletter", Rect::new(72.0, 680.0, 15.0, 15.0))
    .checked()
    .with_export_value("subscribed")
    .with_tooltip("Subscribe to newsletter");

关键方法：

Method	描述
.checked()	设置初始状态为选中
.with_export_value(s)	表单提交时发送的值
.with_tooltip(s)	悬停提示文本
.read_only()	防止切换

RadioButtonGroup – Radio Buttons

互斥选项组。组内所有按钮共享相同的字段名称；选择一个会取消其他按钮的选择。

use pdf_oxide::writer::RadioButtonGroup;
use pdf_oxide::geometry::Rect;

let group = RadioButtonGroup::new("color")
    .add_button("Red", Rect::new(72.0, 700.0, 15.0, 15.0))
    .add_button("Green", Rect::new(72.0, 680.0, 15.0, 15.0))
    .add_button("Blue", Rect::new(72.0, 660.0, 15.0, 15.0))
    .with_selected("Green");  // Pre-select "Green"

关键方法：

Method	描述
.add_button(value, rect)	添加单选选项
.with_selected(value)	预选一个选项
.no_toggle_off()	防止取消选择所有选项

ComboBoxWidget – Dropdown

带有可选可编辑文本的下拉选择字段。

use pdf_oxide::writer::ComboBoxWidget;
use pdf_oxide::writer::form_fields::ChoiceOption;
use pdf_oxide::geometry::Rect;

let combo = ComboBoxWidget::new("country", Rect::new(72.0, 700.0, 200.0, 20.0))
    .add_option("US", "United States")
    .add_option("GB", "United Kingdom")
    .add_option("DE", "Germany")
    .add_option("JP", "Japan")
    .with_selected("US");

关键方法：

Method	描述
.add_option(value, label)	添加可选选项
.with_selected(value)	预选一个选项
.editable()	允许输入自定义值
.sorted()	按字母顺序排列选项

ListBoxWidget – Multi-Select List

支持单选或多选的可滚动列表字段。

use pdf_oxide::writer::ListBoxWidget;
use pdf_oxide::geometry::Rect;

let list = ListBoxWidget::new("languages", Rect::new(72.0, 600.0, 200.0, 80.0))
    .add_option("rust", "Rust")
    .add_option("python", "Python")
    .add_option("go", "Go")
    .add_option("typescript", "TypeScript")
    .multi_select()
    .with_selected("rust");

关键方法：

Method	描述
.add_option(value, label)	添加可选选项
.with_selected(value)	预选一个选项
.multi_select()	允许选择多个项目
.sorted()	按字母顺序排列选项

PushButtonWidget – Button

可点击的按钮，触发操作（提交、重置或 JavaScript）。

use pdf_oxide::writer::PushButtonWidget;
use pdf_oxide::geometry::Rect;

let submit = PushButtonWidget::new("submit", Rect::new(72.0, 500.0, 100.0, 30.0))
    .with_label("Submit")
    .submit_form("https://example.com/submit");

let reset = PushButtonWidget::new("reset", Rect::new(180.0, 500.0, 100.0, 30.0))
    .with_label("Reset")
    .reset_form();

高级示例

完整注册表单

use pdf_oxide::writer::{
    PdfWriter, PdfWriterConfig,
    TextFieldWidget, CheckboxWidget, RadioButtonGroup,
    ComboBoxWidget, PushButtonWidget,
};
use pdf_oxide::geometry::Rect;

let config = PdfWriterConfig::default()
    .with_title("Registration Form")
    .with_author("HR Department");

let mut writer = PdfWriter::with_config(config);
{
    let mut page = writer.add_letter_page();

    // Title
    page.add_text("Employee Registration Form", 72.0, 740.0, "Helvetica-Bold", 18.0);

    // Personal Information
    page.add_text("First Name:", 72.0, 700.0, "Helvetica", 12.0);
    page.add_text_field(
        TextFieldWidget::new("first_name", Rect::new(170.0, 696.0, 200.0, 20.0))
            .required()
    );

    page.add_text("Last Name:", 72.0, 670.0, "Helvetica", 12.0);
    page.add_text_field(
        TextFieldWidget::new("last_name", Rect::new(170.0, 666.0, 200.0, 20.0))
            .required()
    );

    page.add_text("Email:", 72.0, 640.0, "Helvetica", 12.0);
    page.add_text_field(
        TextFieldWidget::new("email", Rect::new(170.0, 636.0, 250.0, 20.0))
            .required()
            .with_tooltip("Work email address")
    );

    // Department dropdown
    page.add_text("Department:", 72.0, 610.0, "Helvetica", 12.0);
    page.add_combo_box(
        ComboBoxWidget::new("department", Rect::new(170.0, 606.0, 200.0, 20.0))
            .add_option("eng", "Engineering")
            .add_option("sales", "Sales")
            .add_option("hr", "Human Resources")
            .add_option("ops", "Operations")
    );

    // Employment type radio buttons
    page.add_text("Employment Type:", 72.0, 570.0, "Helvetica", 12.0);
    page.add_text("Full-time", 95.0, 550.0, "Helvetica", 10.0);
    page.add_text("Part-time", 95.0, 530.0, "Helvetica", 10.0);
    page.add_text("Contract", 95.0, 510.0, "Helvetica", 10.0);
    page.add_radio_group(
        RadioButtonGroup::new("employment_type")
            .add_button("fulltime", Rect::new(72.0, 548.0, 15.0, 15.0))
            .add_button("parttime", Rect::new(72.0, 528.0, 15.0, 15.0))
            .add_button("contract", Rect::new(72.0, 508.0, 15.0, 15.0))
            .with_selected("fulltime")
    );

    // Agreement checkbox
    page.add_text("I agree to the terms and conditions", 95.0, 470.0, "Helvetica", 10.0);
    page.add_checkbox(
        CheckboxWidget::new("agree_terms", Rect::new(72.0, 468.0, 15.0, 15.0))
            .with_export_value("agreed")
    );

    // Submit button
    page.add_push_button(
        PushButtonWidget::new("submit", Rect::new(72.0, 420.0, 120.0, 30.0))
            .with_label("Submit Form")
    );

    page.finish();
}

writer.save("registration_form.pdf")?;

向现有 PDF 添加表单字段

使用 DocumentEditor 向现有 PDF 文档添加字段：

use pdf_oxide::editor::DocumentEditor;
use pdf_oxide::writer::TextFieldWidget;
use pdf_oxide::geometry::Rect;

let mut editor = DocumentEditor::open("template.pdf")?;

let field = TextFieldWidget::new("signature", Rect::new(72.0, 100.0, 250.0, 25.0))
    .with_tooltip("Sign here");

editor.add_form_field(0, field)?;  // Add to page 0
editor.save("signed_template.pdf")?;

相关页面

• DocumentBuilder 底层 API – 使用流畅 API 构建页面
• 注释创建 – 非交互式注释类型
• PdfBuilder 流畅 API – High-level PDF 创建