Edición de Campos de Formulario
PDF Oxide ofrece soporte completo para campos de formulario: leer valores existentes, rellenar campos mediante código, añadir nuevos campos, configurar propiedades, aplanar formularios a contenido estático y exportar datos en formato FDF/XFDF. Los formularios XFA pueden analizarse y convertirse a AcroForm.
Leer Campos de Formulario
Obtener todos los campos
Rust
use pdf_oxide::editor::DocumentEditor;
let mut editor = DocumentEditor::open("form.pdf")?;
let fields = editor.get_form_fields()?;
for field in &fields {
println!("Field: {} = {:?}", field.name(), field.value());
if let Some(ft) = field.field_type() {
println!(" Type: {:?}", ft);
}
if let Some(tooltip) = field.tooltip() {
println!(" Tooltip: {}", tooltip);
}
}
WASM
const doc = new WasmPdfDocument(bytes);
const fields = doc.getFormFields();
for (const f of fields) {
console.log(`${f.name} (${f.fieldType}) = ${f.value}`);
}
Python
from pdf_oxide import PdfDocument
doc = PdfDocument("form.pdf")
fields = doc.get_form_fields()
for field in fields:
print(f"{field.name} ({field.field_type}) = {field.value}")
Go
doc, _ := pdfoxide.Open("form.pdf")
defer doc.Close()
fields, _ := doc.FormFields()
for _, f := range fields {
fmt.Printf("%s (%s) = %s\n", f.Name, f.Type, f.Value)
}
C#
using var doc = PdfDocument.Open("form.pdf");
foreach (var f in doc.GetFormFields())
Console.WriteLine($"{f.Name} ({f.Type}) = {f.Value}");
Java
try (PdfDocument doc = PdfDocument.open(java.nio.file.Path.of("form.pdf"))) {
for (fyi.oxide.pdf.form.FormField f : doc.formFields()) {
System.out.println(f.name() + " (" + f.type() + ") = " + f.value().orElse(""));
}
}
Kotlin
PdfDocument.open(java.nio.file.Path.of("form.pdf")).use { doc ->
for (f in doc.formFields()) {
println("${f.name()} (${f.type()}) = ${f.value().orElse("")}")
}
}
Scala
Using.resource(PdfDocument.open("form.pdf")) { doc =>
doc.formFieldsSeq.foreach { f =>
println(s"${f.name} (${f.`type`}) = ${f.valueOption.getOrElse("")}")
}
}
Clojure
(with-open [doc (pdf/open "form.pdf")]
(doseq [f (pdf/form-fields doc)]
(println (.name f) "(" (.type f) ") =" (.orElse (.value f) ""))))
Ruby
PdfOxide::PdfDocument.open('form.pdf') do |doc|
doc.form_fields.each do |f|
puts "#{f[:name]} (#{f[:type]}) = #{f[:value]}"
end
end
C++
auto doc = pdf_oxide::Document::open("form.pdf");
for (const auto& f : doc.get_form_fields())
std::cout << f.name << " (" << f.type << ") = " << f.value << "\n";
Swift
let doc = try Document.open("form.pdf")
for f in try doc.formFields() {
print("\(f.name) (\(f.type)) = \(f.value)")
}
Dart
final doc = PdfDocument.open('form.pdf');
for (final f in doc.getFormFields()) {
print('${f.name} (${f.type}) = ${f.value}');
}
R
doc <- pdf_open("form.pdf")
for (f in pdf_get_form_fields(doc)) {
cat(sprintf("%s (%s) = %s\n", f$name, f$type, f$value))
}
Julia
doc = open_document("form.pdf")
for f in get_form_fields(doc)
println("$(f.name) ($(f.type)) = $(f.value)")
end
Zig
var doc = try pdf_oxide.Document.open("form.pdf");
var fields = try doc.formFields();
defer fields.deinit();
const n = try fields.count();
var i: i32 = 0;
while (i < n) : (i += 1) {
const name = try fields.getName(a, i);
defer a.free(name);
const ftype = try fields.getType(a, i);
defer a.free(ftype);
const value = try fields.getValue(a, i);
defer a.free(value);
std.debug.print("{s} ({s}) = {s}\n", .{ name, ftype, value });
}
Objective-C
NSError *err = nil;
POXDocument *doc = [POXDocument openPath:@"form.pdf" error:&err];
for (POXFormField *f in [doc formFieldsWithError:&err]) {
NSLog(@"%@ (%@) = %@", f.name, f.type, f.value);
}
Elixir
{:ok, doc} = PdfOxide.open("form.pdf")
{:ok, fields} = PdfOxide.form_fields(doc)
for f <- fields do
IO.puts("#{f.name} (#{f.type}) = #{f.value}")
end
Obtener el valor de un campo concreto
Rust
let mut editor = DocumentEditor::open("form.pdf")?;
let value = editor.get_form_field_value("first_name")?;
println!("First name: {:?}", value);
WASM
const value = doc.getFormFieldValue("first_name");
console.log(`First name: ${value}`);
Python
value = doc.get_form_field_value("first_name")
print(f"First name: {value}")
Comprobar si un campo existe
let mut editor = DocumentEditor::open("form.pdf")?;
if editor.has_form_field("email")? {
println!("Email field exists");
}
Establecer Valores de Campos
Establecer el valor de un campo
Rust
use pdf_oxide::editor::DocumentEditor;
use pdf_oxide::editor::form_fields::FormFieldValue;
let mut editor = DocumentEditor::open("form.pdf")?;
// Set a text field
editor.set_form_field_value("first_name", FormFieldValue::Text("Jane".to_string()))?;
// Set a checkbox
editor.set_form_field_value("agree_terms", FormFieldValue::Boolean(true))?;
// Set a choice field
editor.set_form_field_value("country", FormFieldValue::Choice("United States".to_string()))?;
editor.save("filled.pdf")?;
WASM
const doc = new WasmPdfDocument(bytes);
doc.setFormFieldValue("first_name", "Jane");
doc.setFormFieldValue("agree_terms", true);
doc.setFormFieldValue("country", "United States");
writeFileSync("filled.pdf", doc.save());
doc.free();
Python
doc = PdfDocument("form.pdf")
doc.set_form_field_value("first_name", "Jane")
doc.set_form_field_value("agree_terms", True)
doc.set_form_field_value("country", "United States")
doc.save("filled.pdf")
Go
editor, _ := pdfoxide.OpenEditor("form.pdf")
defer editor.Close()
_ = editor.SetFormFieldValue("first_name", "Jane")
_ = editor.SetFormFieldValue("agree_terms", "Yes")
_ = editor.SetFormFieldValue("country", "United States")
_ = editor.Save("filled.pdf")
C#
using var editor = DocumentEditor.Open("form.pdf");
editor.SetFormFieldValue("first_name", "Jane");
editor.SetFormFieldValue("agree_terms", "Yes");
editor.SetFormFieldValue("country", "United States");
editor.Save("filled.pdf");
Java
try (DocumentEditor editor = DocumentEditor.open("form.pdf")) {
editor.setFormField("first_name", "Jane");
editor.setFormField("agree_terms", true);
editor.setFormField("country", "United States");
editor.saveTo(java.nio.file.Path.of("filled.pdf"));
}
Kotlin
DocumentEditor.open("form.pdf").use { editor ->
editor.setFormField("first_name", "Jane")
editor.setFormField("agree_terms", true)
editor.setFormField("country", "United States")
editor.saveTo(java.nio.file.Path.of("filled.pdf"))
}
Scala
Using.resource(DocumentEditor.open("form.pdf")) { editor =>
editor.setFormField("first_name", "Jane")
editor.setFormField("agree_terms", true)
editor.setFormField("country", "United States")
editor.saveTo(java.nio.file.Path.of("filled.pdf"))
}
Clojure
(with-open [editor (pdf/editor "form.pdf")]
(.setFormField editor "first_name" "Jane")
(.setFormField editor "agree_terms" true)
(.setFormField editor "country" "United States")
(.saveTo editor (java.nio.file.Path/of "filled.pdf" (into-array String []))))
Ruby
PdfOxide::DocumentEditor.open('form.pdf') do |editor|
editor.set_form_field('first_name', 'Jane')
editor.set_form_field('agree_terms', true)
editor.set_form_field('country', 'United States')
editor.save_to('filled.pdf')
end
C++
auto editor = pdf_oxide::DocumentEditor::open("form.pdf");
editor.set_form_field_value("first_name", "Jane");
editor.set_form_field_value("agree_terms", "Yes");
editor.set_form_field_value("country", "United States");
editor.save("filled.pdf");
Swift
let editor = try DocumentEditor.open("form.pdf")
try editor.setFormFieldValue("first_name", "Jane")
try editor.setFormFieldValue("agree_terms", "Yes")
try editor.setFormFieldValue("country", "United States")
try editor.save("filled.pdf")
Dart
final editor = DocumentEditor.open('form.pdf');
editor.setFormFieldValue('first_name', 'Jane');
editor.setFormFieldValue('agree_terms', 'Yes');
editor.setFormFieldValue('country', 'United States');
editor.save('filled.pdf');
R
editor <- pdf_editor_open("form.pdf")
pdf_editor_set_form_field_value(editor, "first_name", "Jane")
pdf_editor_set_form_field_value(editor, "agree_terms", "Yes")
pdf_editor_set_form_field_value(editor, "country", "United States")
pdf_editor_save(editor, "filled.pdf")
Julia
editor = open_editor("form.pdf")
set_form_field_value(editor, "first_name", "Jane")
set_form_field_value(editor, "agree_terms", "Yes")
set_form_field_value(editor, "country", "United States")
save(editor, "filled.pdf")
Zig
var editor = try pdf_oxide.DocumentEditor.openEditor("form.pdf");
defer editor.deinit();
try editor.setFormFieldValue("first_name", "Jane");
try editor.setFormFieldValue("agree_terms", "Yes");
try editor.setFormFieldValue("country", "United States");
try editor.save("filled.pdf");
Objective-C
NSError *err = nil;
POXDocumentEditor *editor = [POXDocumentEditor openEditor:@"form.pdf" error:&err];
[editor setFormField:@"first_name" value:@"Jane" error:&err];
[editor setFormField:@"agree_terms" value:@"Yes" error:&err];
[editor setFormField:@"country" value:@"United States" error:&err];
[editor saveToPath:@"filled.pdf" error:&err];
Elixir
{:ok, editor} = PdfOxide.open_editor("form.pdf")
PdfOxide.set_form_field_value(editor, "first_name", "Jane")
PdfOxide.set_form_field_value(editor, "agree_terms", "Yes")
PdfOxide.set_form_field_value(editor, "country", "United States")
PdfOxide.editor_save(editor, "filled.pdf")
Variantes de FormFieldValue
| Variante | Descripción | Ejemplo |
|---|---|---|
Text(String) |
Valor de campo de texto | FormFieldValue::Text("Hello".into()) |
Boolean(bool) |
Estado de casilla/radio | FormFieldValue::Boolean(true) |
Choice(String) |
Selección única | FormFieldValue::Choice("Option A".into()) |
MultiChoice(Vec<String>) |
Selección múltiple | FormFieldValue::MultiChoice(vec!["A".into(), "B".into()]) |
None |
Sin valor / limpiar campo | FormFieldValue::None |
Añadir Campos de Formulario
Añadir un nuevo campo
use pdf_oxide::editor::DocumentEditor;
use pdf_oxide::writer::form_fields::TextFieldWidget;
let mut editor = DocumentEditor::open("document.pdf")?;
// Create a text input field on page 0
let widget = TextFieldWidget::new("user_name")
.with_rect(100.0, 700.0, 200.0, 20.0)
.with_default_value("Enter name");
editor.add_form_field(widget, 0)?;
editor.save("with-form.pdf")?;
Añadir campos jerárquicos
Crea relaciones padre-hijo entre campos para formularios estructurados.
use pdf_oxide::editor::form_fields::ParentFieldConfig;
let mut editor = DocumentEditor::open("document.pdf")?;
// Create a parent field
let parent = ParentFieldConfig::new("address");
editor.add_parent_field(parent)?;
// Add child fields under the parent
let street = TextFieldWidget::new("street")
.with_rect(100.0, 600.0, 300.0, 20.0);
editor.add_child_field(street, 0, "address")?;
let city = TextFieldWidget::new("city")
.with_rect(100.0, 570.0, 150.0, 20.0);
editor.add_child_field(city, 0, "address")?;
editor.save("hierarchical-form.pdf")?;
Eliminar un campo de formulario
let mut editor = DocumentEditor::open("form.pdf")?;
editor.remove_form_field("obsolete_field")?;
editor.save("cleaned.pdf")?;
Propiedades de Campos de Formulario
Configurar propiedades
Configura propiedades individuales de campo por nombre.
let mut editor = DocumentEditor::open("form.pdf")?;
// Access control
editor.set_form_field_readonly("signature_date", true)?;
editor.set_form_field_required("email", true)?;
// Tooltip
editor.set_form_field_tooltip("phone", "Enter phone number with area code")?;
// Position and size
editor.set_form_field_rect("name", pdf_oxide::geometry::Rect::new(100.0, 700.0, 200.0, 20.0))?;
// Text constraints
editor.set_form_field_max_length("zip_code", 10)?;
editor.set_form_field_alignment("amount", 2)?; // 0=left, 1=center, 2=right
// Appearance
editor.set_form_field_background_color("highlight_field", [1.0, 1.0, 0.8])?;
editor.set_form_field_border_color("name", [0.0, 0.0, 0.0])?;
editor.set_form_field_border_width("name", 1.0)?;
editor.set_form_field_default_appearance("name", "/Helv 12 Tf 0 g")?;
// Raw flags
editor.set_form_field_flags("options", 0x100000)?;
editor.save("styled-form.pdf")?;
Propiedades de FormFieldWrapper
Al trabajar con objetos FormFieldWrapper devueltos por get_form_fields():
| Método | Devuelve | Descripción |
|---|---|---|
name() |
&str |
Nombre completo del campo |
partial_name() |
&str |
Nombre parcial (sin prefijo padre) |
value() |
FormFieldValue |
Valor actual del campo |
set_value(value) |
() |
Establece el valor del campo |
field_type() |
Option<&FieldType> |
Tipo de campo |
page_index() |
usize |
Página que contiene el campo |
bounds() |
Option<Rect> |
Posición y tamaño del campo |
tooltip() |
Option<&str> |
Texto de información emergente |
is_modified() |
bool |
Si el valor ha sido modificado |
is_new() |
bool |
Si el campo fue añadido (no del original) |
is_readonly() |
bool |
Indicador de solo lectura |
set_readonly(bool) |
() |
Establece el indicador de solo lectura |
is_required() |
bool |
Indicador de campo obligatorio |
set_required(bool) |
() |
Establece el indicador de campo obligatorio |
is_no_export() |
bool |
Indicador de no exportar |
set_no_export(bool) |
() |
Establece el indicador de no exportar |
set_tooltip(text) |
() |
Establece el texto de información emergente |
set_rect(rect) |
() |
Establece la posición y el tamaño |
set_max_length(len) |
() |
Establece la longitud máxima del texto |
get_max_length() |
Option<u32> |
Obtiene la longitud máxima del texto |
set_alignment(align) |
() |
Establece la alineación del texto |
get_alignment() |
Option<u32> |
Obtiene la alineación del texto |
set_background_color(rgb) |
() |
Establece el color de fondo |
get_background_color() |
Option<[f32; 3]> |
Obtiene el color de fondo |
set_border_color(rgb) |
() |
Establece el color del borde |
get_border_color() |
Option<[f32; 3]> |
Obtiene el color del borde |
set_border_width(width) |
() |
Establece el ancho del borde |
get_border_width() |
Option<f32> |
Obtiene el ancho del borde |
set_default_appearance(da) |
() |
Establece la cadena de apariencia predeterminada |
get_default_appearance() |
Option<&str> |
Obtiene la cadena de apariencia predeterminada |
set_default_value(value) |
() |
Establece el valor predeterminado |
get_default_value() |
Option<&FormFieldValue> |
Obtiene el valor predeterminado |
has_parent() |
bool |
Comprueba si hay campo padre |
parent_name() |
Option<&str> |
Nombre del campo padre |
Aplanar Formularios
El aplanado convierte los campos de formulario interactivos en contenido estático de página. Los valores de los campos pasan a formar parte del dibujo de la página y ya no pueden editarse.
Aplanar una sola página
Rust
let mut editor = DocumentEditor::open("form.pdf")?;
editor.flatten_forms_on_page(0)?;
editor.save("flat-page0.pdf")?;
WASM
const doc = new WasmPdfDocument(bytes);
doc.flattenFormsOnPage(0);
writeFileSync("flat-page0.pdf", doc.save());
doc.free();
C++
auto editor = pdf_oxide::DocumentEditor::open("form.pdf");
editor.flatten_forms_on_page(0);
editor.save("flat-page0.pdf");
Swift
let editor = try DocumentEditor.open("form.pdf")
try editor.flattenFormsOnPage(0)
try editor.save("flat-page0.pdf")
Dart
final editor = DocumentEditor.open('form.pdf');
editor.flattenFormsOnPage(0);
editor.save('flat-page0.pdf');
R
editor <- pdf_editor_open("form.pdf")
pdf_editor_flatten_forms_on_page(editor, 0)
pdf_editor_save(editor, "flat-page0.pdf")
Julia
editor = open_editor("form.pdf")
flatten_forms_on_page(editor, 0)
save(editor, "flat-page0.pdf")
Zig
var editor = try pdf_oxide.DocumentEditor.openEditor("form.pdf");
defer editor.deinit();
try editor.flattenFormsOnPage(0);
try editor.save("flat-page0.pdf");
Objective-C
NSError *err = nil;
POXDocumentEditor *editor = [POXDocumentEditor openEditor:@"form.pdf" error:&err];
[editor flattenFormsOnPage:0 error:&err];
[editor saveToPath:@"flat-page0.pdf" error:&err];
Elixir
{:ok, editor} = PdfOxide.open_editor("form.pdf")
PdfOxide.flatten_forms_on_page(editor, 0)
PdfOxide.editor_save(editor, "flat-page0.pdf")
Aplanar todos los formularios
Rust
let mut editor = DocumentEditor::open("form.pdf")?;
editor.flatten_forms()?;
editor.save("flat.pdf")?;
WASM
const doc = new WasmPdfDocument(bytes);
doc.flattenForms();
writeFileSync("flat.pdf", doc.save());
doc.free();
Go
editor, _ := pdfoxide.OpenEditor("form.pdf")
defer editor.Close()
_ = editor.FlattenForms()
_ = editor.Save("flat.pdf")
C#
using var editor = DocumentEditor.Open("form.pdf");
editor.FlattenForms();
editor.Save("flat.pdf");
C++
auto editor = pdf_oxide::DocumentEditor::open("form.pdf");
editor.flatten_forms();
editor.save("flat.pdf");
Swift
let editor = try DocumentEditor.open("form.pdf")
try editor.flattenForms()
try editor.save("flat.pdf")
Dart
final editor = DocumentEditor.open('form.pdf');
editor.flattenForms();
editor.save('flat.pdf');
R
editor <- pdf_editor_open("form.pdf")
pdf_editor_flatten_forms(editor)
pdf_editor_save(editor, "flat.pdf")
Julia
editor = open_editor("form.pdf")
flatten_forms(editor)
save(editor, "flat.pdf")
Zig
var editor = try pdf_oxide.DocumentEditor.openEditor("form.pdf");
defer editor.deinit();
try editor.flattenForms();
try editor.save("flat.pdf");
Objective-C
NSError *err = nil;
POXDocumentEditor *editor = [POXDocumentEditor openEditor:@"form.pdf" error:&err];
[editor flattenForms:&err];
[editor saveToPath:@"flat.pdf" error:&err];
Elixir
{:ok, editor} = PdfOxide.open_editor("form.pdf")
PdfOxide.flatten_forms(editor)
PdfOxide.editor_save(editor, "flat.pdf")
Comprobar el estado del aplanado
editor.flatten_forms_on_page(0)?;
assert!(editor.is_page_marked_for_form_flatten(0));
assert!(editor.will_remove_acroform());
Exportar Datos de Formulario
Exporta los valores de los campos a formato FDF o XFDF para procesamiento externo.
Exportar a FDF
Rust
let mut editor = DocumentEditor::open("filled-form.pdf")?;
editor.export_form_data_fdf("form-data.fdf")?;
WASM
const doc = new WasmPdfDocument(bytes);
const fdfData = doc.exportFormData("fdf");
writeFileSync("form-data.fdf", fdfData);
doc.free();
Python
doc = PdfDocument("filled-form.pdf")
doc.export_form_data("form-data.fdf", format="fdf")
C++
auto doc = pdf_oxide::Document::open("filled-form.pdf");
auto fdf = doc.export_form_data_to_bytes(0); // 0 = FDF
std::ofstream("form-data.fdf", std::ios::binary)
.write(reinterpret_cast<const char*>(fdf.data()), fdf.size());
Swift
let doc = try Document.open("filled-form.pdf")
let fdf = try doc.exportFormData(formatType: 0) // 0 = FDF
try Data(fdf).write(to: URL(fileURLWithPath: "form-data.fdf"))
Dart
final doc = PdfDocument.open('filled-form.pdf');
final fdf = doc.exportFormDataToBytes(0); // 0 = FDF
File('form-data.fdf').writeAsBytesSync(fdf);
R
doc <- pdf_open("filled-form.pdf")
fdf <- pdf_export_form_data_to_bytes(doc, 0) # 0 = FDF
writeBin(fdf, "form-data.fdf")
Julia
doc = open_document("filled-form.pdf")
fdf = export_form_data_to_bytes(doc, 0) # 0 = FDF
write("form-data.fdf", fdf)
Zig
var doc = try pdf_oxide.Document.open("filled-form.pdf");
const fdf = try doc.exportFormDataToBytes(a, 0); // 0 = FDF
defer a.free(fdf);
try std.fs.cwd().writeFile(.{ .sub_path = "form-data.fdf", .data = fdf });
Objective-C
NSError *err = nil;
POXDocument *doc = [POXDocument openPath:@"filled-form.pdf" error:&err];
NSData *fdf = [doc exportFormDataToBytes:0 error:&err]; // 0 = FDF
[fdf writeToFile:@"form-data.fdf" atomically:YES];
Elixir
{:ok, doc} = PdfOxide.open("filled-form.pdf")
{:ok, fdf} = PdfOxide.export_form_data_to_bytes(doc, 0) # 0 = FDF
File.write!("form-data.fdf", fdf)
Exportar a XFDF
Rust
let mut editor = DocumentEditor::open("filled-form.pdf")?;
editor.export_form_data_xfdf("form-data.xfdf")?;
WASM
const doc = new WasmPdfDocument(bytes);
const xfdfData = doc.exportFormData("xfdf");
writeFileSync("form-data.xfdf", xfdfData);
doc.free();
C++
auto doc = pdf_oxide::Document::open("filled-form.pdf");
auto xfdf = doc.export_form_data_to_bytes(1); // 1 = XFDF
std::ofstream("form-data.xfdf", std::ios::binary)
.write(reinterpret_cast<const char*>(xfdf.data()), xfdf.size());
Swift
let doc = try Document.open("filled-form.pdf")
let xfdf = try doc.exportFormData(formatType: 1) // 1 = XFDF
try Data(xfdf).write(to: URL(fileURLWithPath: "form-data.xfdf"))
Dart
final doc = PdfDocument.open('filled-form.pdf');
final xfdf = doc.exportFormDataToBytes(1); // 1 = XFDF
File('form-data.xfdf').writeAsBytesSync(xfdf);
R
doc <- pdf_open("filled-form.pdf")
xfdf <- pdf_export_form_data_to_bytes(doc, 1) # 1 = XFDF
writeBin(xfdf, "form-data.xfdf")
Julia
doc = open_document("filled-form.pdf")
xfdf = export_form_data_to_bytes(doc, 1) # 1 = XFDF
write("form-data.xfdf", xfdf)
Zig
var doc = try pdf_oxide.Document.open("filled-form.pdf");
const xfdf = try doc.exportFormDataToBytes(a, 1); // 1 = XFDF
defer a.free(xfdf);
try std.fs.cwd().writeFile(.{ .sub_path = "form-data.xfdf", .data = xfdf });
Objective-C
NSError *err = nil;
POXDocument *doc = [POXDocument openPath:@"filled-form.pdf" error:&err];
NSData *xfdf = [doc exportFormDataToBytes:1 error:&err]; // 1 = XFDF
[xfdf writeToFile:@"form-data.xfdf" atomically:YES];
Elixir
{:ok, doc} = PdfOxide.open("filled-form.pdf")
{:ok, xfdf} = PdfOxide.export_form_data_to_bytes(doc, 1) # 1 = XFDF
File.write!("form-data.xfdf", xfdf)
Importar Datos de Formulario
La operación inversa a la exportación: carga valores de campos desde un archivo FDF o XFDF (o desde bytes FDF/XFDF en bruto) de vuelta a un documento. Esto permite tomar datos rellenados en otro lugar —un lector de PDF de escritorio, otra biblioteca, un pipeline de servidor— y aplicarlos a los campos AcroForm.
¿Cómo importo datos FDF o XFDF a un PDF?
El C ABI declara una familia dedicada de funciones de importación, y el binding de Swift expone los cuatro puntos de entrada:
| Símbolo C ABI | Método Swift | Fuente de datos |
|---|---|---|
pdf_form_import_from_file |
importFormFromFile(_:) |
Ruta de archivo FDF/XFDF |
pdf_document_import_form_data |
importFormData(_:) |
Ruta de archivo FDF/XFDF |
pdf_editor_import_fdf_bytes |
importFdfBytes(_:) |
Bytes FDF en memoria |
pdf_editor_import_xfdf_bytes |
importXfdfBytes(_:) |
Bytes XFDF en memoria |
Firmas exactas del C ABI (de include/pdf_oxide_c/pdf_oxide.h):
bool pdf_form_import_from_file(const void *document, const char *filename, int32_t *error_code);
int32_t pdf_document_import_form_data(const void *document, const char *data_path, int32_t *error_code);
int32_t pdf_editor_import_fdf_bytes(const void *document, const uint8_t *data, uintptr_t data_len, int32_t *error_code);
int32_t pdf_editor_import_xfdf_bytes(const void *document, const uint8_t *data, uintptr_t data_len, int32_t *error_code);
Disponibilidad en v0.3.69. Estos cuatro puntos de entrada están declarados en el C ABI y expuestos por el wrapper de Swift, pero la implementación subyacente aún no está conectada: en v0.3.69, cada uno devuelve el estado
Unsupported(código de error8) en tiempo de ejecución. Los bindings de Python, Node.js, Go y WASM no los exponen en absoluto, y tampoco existe un lector FDF/XFDF a nivel de Rust (el módulopdf_oxide::fdfsolo incluye el lado de exportaciónFdfWriter/XfdfWriter). Hasta que el camino de importación esté implementado, usa la solución alternativa de “analizar y rellenar” que se describe a continuación, que funciona en todos los bindings hoy.
Swift (la interfaz existe; lanza Unsupported hasta que llegue el backend)
import PdfOxide
let editor = try DocumentEditor.open(path: "form.pdf")
// From a file on disk (FDF or XFDF):
try editor.importFormFromFile("submission.fdf") // -> Bool
try editor.importFormData("submission.xfdf") // -> Int32 status
// From in-memory bytes:
let fdf = Array("%FDF-1.2\n...".utf8)
try editor.importFdfBytes(fdf) // -> Int32 status
let xfdf = Array("<?xml version=\"1.0\"?><xfdf>...</xfdf>".utf8)
try editor.importXfdfBytes(xfdf) // -> Int32 status
try editor.save(to: "filled.pdf")
Cada método devuelve el código de estado FFI (o Bool para importFormFromFile) y lanza PdfOxideError con código de error distinto de cero, por lo que hoy debes esperar un error Unsupported en lugar de campos modificados.
¿Cómo aplico datos FDF/XFDF ahora (solución alternativa entre lenguajes)?
Dado que todos los bindings ya exponen set_form_field_value, la forma portable de importar datos de formulario en v0.3.69 es analizar el FDF/XFDF tú mismo y escribir cada par nombre -> valor en el documento. Ambos formatos son formatos de texto pequeños y bien especificados: FDF envuelve los valores en sintaxis de diccionario PDF, y XFDF es XML simple.
Python – importar un archivo XFDF
# `defusedxml` guards against XXE and billion-laughs attacks when parsing
# untrusted XFDF (the stdlib xml parsers are unsafe by default):
# pip install defusedxml
import defusedxml.ElementTree as ET
from pdf_oxide import PdfDocument
# XFDF: <xfdf><fields><field name="..."><value>...</value></field></fields></xfdf>
tree = ET.parse("submission.xfdf")
ns = {"x": "http://ns.adobe.com/xfdf/"}
doc = PdfDocument("form.pdf")
for field in tree.findall(".//x:field", ns) or tree.findall(".//field"):
name = field.get("name")
value_el = field.find("x:value", ns)
if value_el is None:
value_el = field.find("value")
if name and value_el is not None:
doc.set_form_field_value(name, value_el.text or "")
doc.save("filled.pdf")
Rust – importar un archivo XFDF mediante DocumentEditor
use pdf_oxide::editor::DocumentEditor;
use pdf_oxide::editor::form_fields::FormFieldValue;
fn import_xfdf(pdf: &str, xfdf: &str, out: &str) -> Result<(), Box<dyn std::error::Error>> {
let mut editor = DocumentEditor::open(pdf)?;
let xml = std::fs::read_to_string(xfdf)?;
// Minimal extraction of <field name="..."><value>...</value></field> pairs.
for chunk in xml.split("<field ").skip(1) {
let name = chunk
.split("name=\"").nth(1)
.and_then(|s| s.split('"').next());
let value = chunk
.split("<value>").nth(1)
.and_then(|s| s.split("</value>").next());
if let (Some(name), Some(value)) = (name, value) {
editor.set_form_field_value(name, FormFieldValue::Text(value.to_string()))?;
}
}
editor.save(out)?;
Ok(())
}
Node.js – importar un archivo XFDF
const fs = require("fs");
const { PdfDocument } = require("pdf-oxide");
const xfdf = fs.readFileSync("submission.xfdf", "utf8");
const doc = new PdfDocument("form.pdf");
const re = /<field\s+name="([^"]+)"[^>]*>\s*<value>([\s\S]*?)<\/value>/g;
let m;
while ((m = re.exec(xfdf)) !== null) {
doc.setFormFieldValue(m[1], m[2]);
}
fs.writeFileSync("filled.pdf", doc.save());
doc.close();
El mismo patrón funciona para FDF: analiza cada entrada /T (name) /V (value) del array /Fields y llama a set_form_field_value. Una vez que el camino de importación nativo esté implementado, podrás eliminar el análisis manual y llamar a importFdfBytes / importXfdfBytes / importFormFromFile directamente.
Soporte para Formularios XFA
PDF Oxide puede detectar, analizar y convertir formularios XFA a AcroForm estándar.
Comprobar si hay XFA
Rust
let mut editor = DocumentEditor::open("xfa-form.pdf")?;
if editor.has_xfa()? {
println!("Document contains XFA form data");
}
WASM
const doc = new WasmPdfDocument(bytes);
if (doc.hasXfa()) {
console.log("Document contains XFA form data");
}
Python
doc = PdfDocument("xfa-form.pdf")
if doc.has_xfa():
print("Document contains XFA form data")
C++
auto doc = pdf_oxide::Document::open("xfa-form.pdf");
if (doc.has_xfa())
std::cout << "Document contains XFA form data\n";
Swift
let doc = try Document.open("xfa-form.pdf")
if try doc.hasXfa() {
print("Document contains XFA form data")
}
Dart
final doc = PdfDocument.open('xfa-form.pdf');
if (doc.hasXfa()) {
print('Document contains XFA form data');
}
R
doc <- pdf_open("xfa-form.pdf")
if (pdf_has_xfa(doc)) {
cat("Document contains XFA form data\n")
}
Julia
doc = open_document("xfa-form.pdf")
if has_xfa(doc)
println("Document contains XFA form data")
end
Zig
var doc = try pdf_oxide.Document.open("xfa-form.pdf");
if (doc.hasXfa()) {
std.debug.print("Document contains XFA form data\n", .{});
}
Objective-C
NSError *err = nil;
POXDocument *doc = [POXDocument openPath:@"xfa-form.pdf" error:&err];
if ([doc hasXfa]) {
NSLog(@"Document contains XFA form data");
}
Elixir
{:ok, doc} = PdfOxide.open("xfa-form.pdf")
if PdfOxide.has_xfa?(doc) do
IO.puts("Document contains XFA form data")
end
Analizar la estructura XFA
let mut editor = DocumentEditor::open("xfa-form.pdf")?;
let analysis = editor.analyze_xfa()?;
println!("XFA analysis: {:?}", analysis);
Convertir XFA a AcroForm
Convierte formularios XFA a campos AcroForm estándar para mayor compatibilidad.
let mut editor = DocumentEditor::open("xfa-form.pdf")?;
editor.convert_xfa_to_acroform(&Default::default())?;
editor.save("acroform.pdf")?;
Referencia Completa de la API
Operaciones con campos
| Método | Devuelve | Descripción |
|---|---|---|
get_form_fields() |
Result<Vec<FormFieldWrapper>> |
Listar todos los campos de formulario |
get_form_field_value(name) |
Result<FormFieldValue> |
Obtener el valor de un campo |
has_form_field(name) |
Result<bool> |
Comprobar si el campo existe |
set_form_field_value(name, value) |
Result<()> |
Establecer el valor de un campo |
add_form_field(widget, page) |
Result<()> |
Añadir un nuevo campo |
add_parent_field(config) |
Result<()> |
Añadir un campo padre |
add_child_field(widget, page, parent) |
Result<()> |
Añadir un campo hijo |
remove_form_field(name) |
Result<()> |
Eliminar un campo |
Propiedades de campo (por nombre)
| Método | Devuelve | Descripción |
|---|---|---|
set_form_field_readonly(name, bool) |
Result<()> |
Establecer solo lectura |
set_form_field_required(name, bool) |
Result<()> |
Establecer campo obligatorio |
set_form_field_tooltip(name, text) |
Result<()> |
Establecer información emergente |
set_form_field_rect(name, rect) |
Result<()> |
Establecer posición y tamaño |
set_form_field_max_length(name, len) |
Result<()> |
Establecer longitud máxima del texto |
set_form_field_alignment(name, align) |
Result<()> |
Establecer alineación del texto |
set_form_field_background_color(name, rgb) |
Result<()> |
Establecer color de fondo |
set_form_field_border_color(name, rgb) |
Result<()> |
Establecer color del borde |
set_form_field_border_width(name, width) |
Result<()> |
Establecer ancho del borde |
set_form_field_default_appearance(name, da) |
Result<()> |
Establecer apariencia predeterminada |
set_form_field_flags(name, flags) |
Result<()> |
Establecer indicadores de campo en bruto |
Aplanado
| Método | Devuelve | Descripción |
|---|---|---|
flatten_forms_on_page(page) |
Result<()> |
Aplanar formularios en una página |
flatten_forms() |
Result<()> |
Aplanar todos los formularios |
is_page_marked_for_form_flatten(page) |
bool |
Comprobar estado del aplanado |
will_remove_acroform() |
bool |
Comprobar si se eliminará el AcroForm |
Exportación
| Método | Devuelve | Descripción |
|---|---|---|
export_form_data_fdf(path) |
Result<()> |
Exportar a archivo FDF |
export_form_data_xfdf(path) |
Result<()> |
Exportar a archivo XFDF |
Importación (C ABI + Swift; devuelve Unsupported en tiempo de ejecución en v0.3.69)
| Símbolo C ABI | Método Swift | Devuelve | Descripción |
|---|---|---|---|
pdf_form_import_from_file |
importFormFromFile(_:) |
bool / Bool |
Importar FDF/XFDF desde ruta de archivo |
pdf_document_import_form_data |
importFormData(_:) |
int32_t / Int32 |
Importar datos de formulario desde ruta de archivo |
pdf_editor_import_fdf_bytes |
importFdfBytes(_:) |
int32_t / Int32 |
Importar FDF desde bytes en memoria |
pdf_editor_import_xfdf_bytes |
importXfdfBytes(_:) |
int32_t / Int32 |
Importar XFDF desde bytes en memoria |
Devuelven código de error 8 (Unsupported) hasta que llegue el backend de importación nativo; usa set_form_field_value para aplicar datos FDF/XFDF analizados hoy.
XFA
| Método | Devuelve | Descripción |
|---|---|---|
has_xfa() |
Result<bool> |
Comprobar datos de formulario XFA |
analyze_xfa() |
Result<XfaAnalysis> |
Analizar estructura XFA |
convert_xfa_to_acroform(options) |
Result<()> |
Convertir XFA a AcroForm |
Ejemplo Avanzado: Relleno por Lotes y Aplanado
use pdf_oxide::editor::DocumentEditor;
use pdf_oxide::editor::form_fields::FormFieldValue;
let mut editor = DocumentEditor::open("template.pdf")?;
// Fill form fields
editor.set_form_field_value("name", FormFieldValue::Text("John Doe".to_string()))?;
editor.set_form_field_value("date", FormFieldValue::Text("2025-12-01".to_string()))?;
editor.set_form_field_value("approved", FormFieldValue::Boolean(true))?;
// Make the completed form non-editable
editor.flatten_forms()?;
// Export data before saving
editor.export_form_data_xfdf("submission.xfdf")?;
editor.save("completed.pdf")?;
Preguntas Frecuentes
¿Puede PDF Oxide importar datos FDF/XFDF de vuelta a un PDF en v0.3.69?
Todavía no mediante una importación nativa de una sola llamada. El C ABI declara pdf_form_import_from_file, pdf_document_import_form_data, pdf_editor_import_fdf_bytes y pdf_editor_import_xfdf_bytes, y el wrapper de Swift los expone, pero devuelven el estado Unsupported (código de error 8) en tiempo de ejecución. Analiza el FDF/XFDF y llama a set_form_field_value para cada campo — eso funciona en todos los bindings hoy.
¿Qué bindings exponen los métodos de importación?
Solo el C ABI y el wrapper de Swift exponen la interfaz de importación. Los bindings de Python, Node.js, Go y WASM no lo hacen. La exportación (export_form_data_fdf / export_form_data_xfdf y export_form_data) está completamente implementada en todos los bindings.
¿Cuál es la diferencia entre FDF y XFDF?
FDF es un contenedor binario/texto derivado de PDF (cabecera %FDF-1.2, array /Fields). XFDF es el equivalente XML (<xfdf><fields>...), que es más fácil de generar y analizar con herramientas estándar. Ambos transportan los mismos datos nombre de campo -> valor; PDF Oxide puede exportar ambos formatos.
¿Es suficientemente rápido el relleno para trabajos por lotes? Sí. El núcleo de extracción de PDF Oxide funciona a una media de 0,8 ms con una tasa de éxito del 100 % en el corpus de referencia, por lo que leer campos, establecer valores y volver a guardar se mantiene muy por debajo de un milisegundo de trabajo a nivel de campo por documento para formularios típicos.
Páginas Relacionadas
- Visión General de Edición – apertura, metadatos y flujo de guardado
- Edición de Texto – modificar contenido de texto directamente
- Edición de Anotaciones – añadir y gestionar anotaciones
- Cifrado y Seguridad – restringir la edición de formularios con permisos