Visão Geral de Edição
O PDF Oxide oferece dois níveis de API para editar PDFs existentes: a classe Pdf de alto nível (recomendada) e o DocumentEditor de nível mais baixo. Ambos permitem abrir um PDF, modificar seu conteúdo e metadados, acompanhar alterações e salvar o resultado.
Cobertura dos bindings para edição. A superfície de edição mais completa está em Python, Rust e WASM — eles expõem operações de página, edição de texto/imagem, trabalho com anotações, criptografia e redação. Go expõe uma API de editor substancial (metadados, rotação/movimentação/exclusão de páginas, apagamento de região, preenchimento/achatamento de formulários, corte, merge, salvar criptografado). C# atualmente expõe edição de metadados (
Title/Author/Subject), preenchimento de formulário (SetFormFieldValue),FlattenFormseSave/SaveAsyncnoDocumentEditor; operações em nível de página, criptografia, redação e edição de texto/imagem ainda não estão disponíveis na API pública do C# — use os bindings CLI, Go, Python ou Rust para essas operações.
Abrindo um PDF para Edição
Python
from pdf_oxide import PdfDocument
doc = PdfDocument("input.pdf")
O editor é inicializado de forma preguiçosa na primeira modificação. Você pode começar a ler imediatamente e o editor é ativado quando você chama qualquer método de mutação, como set_title() ou page().
WASM
import { WasmPdfDocument } from "pdf-oxide-wasm";
const bytes = new Uint8Array(/* file bytes */);
const doc = new WasmPdfDocument(bytes);
Rust
Use a API unificada Pdf:
use pdf_oxide::api::Pdf;
let mut doc = Pdf::open("input.pdf")?;
Ou use o DocumentEditor diretamente para controle de mais baixo nível:
use pdf_oxide::editor::DocumentEditor;
let mut editor = DocumentEditor::open("input.pdf")?;
Go
package main
import (
"log"
pdfoxide "github.com/yfedoseev/pdf_oxide/go"
)
func main() {
editor, err := pdfoxide.OpenEditor("input.pdf")
if err != nil { log.Fatal(err) }
defer editor.Close()
}
C#
using PdfOxide;
using var editor = DocumentEditor.Open("input.pdf");
Java
import fyi.oxide.pdf.DocumentEditor;
import java.nio.file.Path;
try (DocumentEditor editor = DocumentEditor.open(Path.of("input.pdf"))) {
// ...
}
Kotlin
import fyi.oxide.pdf.DocumentEditor
import java.nio.file.Path
DocumentEditor.open(Path.of("input.pdf")).use { editor ->
// ...
}
Scala
import fyi.oxide.pdf.DocumentEditor
import scala.util.Using
Using.resource(DocumentEditor.open("input.pdf")) { editor =>
// ...
}
Clojure
(require '[pdf-oxide.core :as pdf])
(with-open [editor (pdf/editor "input.pdf")]
;; ...
)
Ruby
require 'pdf_oxide'
PdfOxide::DocumentEditor.open('input.pdf') do |editor|
# ...
end
PHP
use PdfOxide\DocumentEditor;
$editor = DocumentEditor::open('input.pdf');
C++
#include <pdf_oxide/pdf_oxide.hpp>
auto editor = pdf_oxide::DocumentEditor::open("input.pdf");
Swift
import PdfOxide
let editor = try DocumentEditor.open("input.pdf")
Dart
import 'package:pdf_oxide/pdf_oxide.dart';
final editor = DocumentEditor.open('input.pdf');
R
library(pdfoxide)
editor <- pdf_editor_open("input.pdf")
Julia
using PdfOxide
editor = open_editor("input.pdf")
Zig
const pdf_oxide = @import("pdf_oxide");
var editor = try pdf_oxide.DocumentEditor.open("input.pdf");
defer editor.deinit();
Objective-C
#import "POXPdfOxide.h"
NSError *err = nil;
POXDocumentEditor *editor = [POXDocumentEditor openEditor:@"input.pdf" error:&err];
Elixir
{:ok, editor} = PdfOxide.open_editor("input.pdf")
Verificando Modificações
Antes de salvar, você pode verificar se alguma alteração foi feita:
Python
doc = PdfDocument("input.pdf")
print(doc.is_modified) # False -- no changes yet
doc.set_title("Updated Title")
print(doc.is_modified) # True
Rust
let mut doc = Pdf::open("input.pdf")?;
assert!(!doc.is_modified());
doc.editor().unwrap().set_title("Updated Title");
assert!(doc.is_modified());
Go
editor, _ := pdfoxide.OpenEditor("input.pdf")
defer editor.Close()
modified, _ := editor.IsModified()
fmt.Println(modified) // false
_ = editor.SetTitle("Updated Title")
modified, _ = editor.IsModified()
fmt.Println(modified) // true
C#
using var editor = DocumentEditor.Open("input.pdf");
Console.WriteLine(editor.IsModified); // false
editor.Title = "Updated Title";
Console.WriteLine(editor.IsModified); // true
PHP
$editor = DocumentEditor::open('input.pdf');
var_dump($editor->isModified()); // false
$editor->setProducer('pdf_oxide');
var_dump($editor->isModified()); // true
C++
auto editor = pdf_oxide::DocumentEditor::open("input.pdf");
bool before = editor.is_modified(); // false
editor.set_producer("pdf_oxide");
bool after = editor.is_modified(); // true
Swift
let editor = try DocumentEditor.open("input.pdf")
try editor.isModified() // false
try editor.setProducer("pdf_oxide")
try editor.isModified() // true
Dart
final editor = DocumentEditor.open('input.pdf');
editor.isModified(); // false
editor.setProducer('pdf_oxide');
editor.isModified(); // true
R
editor <- pdf_editor_open("input.pdf")
pdf_editor_is_modified(editor) # FALSE
pdf_editor_set_producer(editor, "pdf_oxide")
pdf_editor_is_modified(editor) # TRUE
Julia
editor = open_editor("input.pdf")
is_modified(editor) # false
set_producer(editor, "pdf_oxide")
is_modified(editor) # true
Zig
var editor = try pdf_oxide.DocumentEditor.open("input.pdf");
defer editor.deinit();
_ = editor.isModified(); // false
try editor.setProducer("pdf_oxide");
_ = editor.isModified(); // true
Objective-C
NSError *err = nil;
POXDocumentEditor *editor = [POXDocumentEditor openEditor:@"input.pdf" error:&err];
[editor isModified]; // NO
[editor setProducer:@"pdf_oxide" error:&err];
[editor isModified]; // YES
Elixir
{:ok, editor} = PdfOxide.open_editor("input.pdf")
PdfOxide.editor_modified?(editor) # false
PdfOxide.set_producer(editor, "pdf_oxide")
PdfOxide.editor_modified?(editor) # true
Salvando
Python
doc = PdfDocument("input.pdf")
doc.set_title("New Title")
doc.save("output.pdf")
WASM
import { WasmPdfDocument } from "pdf-oxide-wasm";
const bytes = new Uint8Array(/* file bytes */);
const doc = new WasmPdfDocument(bytes);
doc.setTitle("New Title");
const output = doc.save();
doc.free();
Rust
let mut doc = Pdf::open("input.pdf")?;
doc.editor().unwrap().set_title("New Title");
doc.save("output.pdf")?;
// Or save to a new path
doc.save_as("copy.pdf")?;
Go
editor, _ := pdfoxide.OpenEditor("input.pdf")
defer editor.Close()
_ = editor.SetTitle("New Title")
_ = editor.Save("output.pdf")
C#
using var editor = DocumentEditor.Open("input.pdf");
editor.Title = "New Title";
editor.Save("output.pdf");
PHP
$editor = DocumentEditor::open('input.pdf');
$editor->setProducer('pdf_oxide');
$editor->saveTo('output.pdf');
C++
auto editor = pdf_oxide::DocumentEditor::open("input.pdf");
editor.set_producer("pdf_oxide");
editor.save("output.pdf");
Swift
let editor = try DocumentEditor.open("input.pdf")
try editor.setProducer("pdf_oxide")
try editor.save("output.pdf")
Dart
final editor = DocumentEditor.open('input.pdf');
editor.setProducer('pdf_oxide');
editor.save('output.pdf');
R
editor <- pdf_editor_open("input.pdf")
pdf_editor_set_producer(editor, "pdf_oxide")
pdf_editor_save(editor, "output.pdf")
Julia
editor = open_editor("input.pdf")
set_producer(editor, "pdf_oxide")
save(editor, "output.pdf")
Zig
var editor = try pdf_oxide.DocumentEditor.open("input.pdf");
defer editor.deinit();
try editor.setProducer("pdf_oxide");
try editor.save("output.pdf");
Objective-C
NSError *err = nil;
POXDocumentEditor *editor = [POXDocumentEditor openEditor:@"input.pdf" error:&err];
[editor setProducer:@"pdf_oxide" error:&err];
[editor saveToPath:@"output.pdf" error:&err];
Elixir
{:ok, editor} = PdfOxide.open_editor("input.pdf")
PdfOxide.set_producer(editor, "pdf_oxide")
PdfOxide.editor_save(editor, "output.pdf")
O método save() realiza uma reescrita completa do PDF por padrão. Para opções avançadas de salvamento (atualizações incrementais, criptografia), consulte Criptografia e Segurança.
Metadados do Documento
Leia e escreva os campos de metadados padrão do PDF: título, autor, assunto e palavras-chave.
Python
from pdf_oxide import PdfDocument
doc = PdfDocument("input.pdf")
# Set metadata
doc.set_title("Quarterly Report")
doc.set_author("Jane Smith")
doc.set_subject("Q4 2025 Financial Results")
doc.set_keywords("finance, quarterly, 2025")
doc.save("output.pdf")
WASM
import { WasmPdfDocument } from "pdf-oxide-wasm";
const bytes = new Uint8Array(/* file bytes */);
const doc = new WasmPdfDocument(bytes);
// Set metadata
doc.setTitle("Quarterly Report");
doc.setAuthor("Jane Smith");
doc.setSubject("Q4 2025 Financial Results");
doc.setKeywords("finance, quarterly, 2025");
const output = doc.save();
doc.free();
Rust
use pdf_oxide::editor::DocumentEditor;
let mut editor = DocumentEditor::open("input.pdf")?;
// Read metadata
if let Some(title) = editor.title()? {
println!("Current title: {}", title);
}
if let Some(author) = editor.author()? {
println!("Current author: {}", author);
}
if let Some(subject) = editor.subject()? {
println!("Current subject: {}", subject);
}
if let Some(keywords) = editor.keywords()? {
println!("Current keywords: {}", keywords);
}
// Set metadata
editor.set_title("Quarterly Report");
editor.set_author("Jane Smith");
editor.set_subject("Q4 2025 Financial Results");
editor.set_keywords("finance, quarterly, 2025");
editor.save("output.pdf")?;
Go
editor, _ := pdfoxide.OpenEditor("input.pdf")
defer editor.Close()
if t, err := editor.Title(); err == nil { fmt.Println("Current title:", t) }
if a, err := editor.Author(); err == nil { fmt.Println("Current author:", a) }
_ = editor.SetTitle("Quarterly Report")
_ = editor.SetAuthor("Jane Smith")
_ = editor.SetSubject("Q4 2025 Financial Results")
_ = editor.Save("output.pdf")
C#
using var editor = DocumentEditor.Open("input.pdf");
if (editor.Title is { } t) Console.WriteLine($"Current title: {t}");
if (editor.Author is { } a) Console.WriteLine($"Current author: {a}");
if (editor.Subject is { } s) Console.WriteLine($"Current subject: {s}");
editor.Title = "Quarterly Report";
editor.Author = "Jane Smith";
editor.Subject = "Q4 2025 Financial Results";
editor.Save("output.pdf");
Informações do Documento
Caminho de Origem e Versão
use pdf_oxide::editor::DocumentEditor;
let editor = DocumentEditor::open("input.pdf")?;
// Path to the original file
println!("Source: {}", editor.source_path());
// PDF version as (major, minor)
let (major, minor) = editor.version();
println!("PDF version: {}.{}", major, minor);
// Number of pages
println!("Pages: {}", editor.current_page_count());
Referência Completa da API
DocumentEditor
| Método | Retorno | Descrição |
|---|---|---|
open(path) |
Result<DocumentEditor> |
Abrir um PDF para edição |
is_modified() |
bool |
Verificar se há alterações |
source_path() |
&str |
Caminho para o PDF de origem |
source() |
&PdfDocument |
Acesso somente leitura ao documento de origem |
version() |
(u8, u8) |
Versão do PDF (maior, menor) |
current_page_count() |
usize |
Número de páginas no documento |
title() |
Result<Option<String>> |
Obter o título do documento |
set_title(title) |
() |
Definir o título do documento |
author() |
Result<Option<String>> |
Obter o autor do documento |
set_author(author) |
() |
Definir o autor do documento |
subject() |
Result<Option<String>> |
Obter o assunto do documento |
set_subject(subject) |
() |
Definir o assunto do documento |
keywords() |
Result<Option<String>> |
Obter as palavras-chave do documento |
set_keywords(keywords) |
() |
Definir as palavras-chave do documento |
save(path) |
Result<()> |
Salvar com reescrita completa |
save_with_options(path, options) |
Result<()> |
Salvar com opções personalizadas |
Pdf (API Unificada)
| Método | Retorno | Descrição |
|---|---|---|
Pdf::open(path) |
Result<Pdf> |
Abrir um PDF para edição |
Pdf::open_editor(path) |
Result<DocumentEditor> |
Abrir diretamente como DocumentEditor |
is_modified() |
bool |
Verificar se há alterações |
save(path) |
Result<()> |
Salvar o documento |
save_as(path) |
Result<()> |
Salvar em um novo caminho |
page(index) |
Result<PdfPage> |
Obter uma página para edição DOM |
save_page(page) |
Result<()> |
Salvar uma página modificada de volta |
editor() |
Option<&mut DocumentEditor> |
Acessar o editor subjacente |
Trait EditableDocument
O trait EditableDocument define o contrato central de edição:
pub trait EditableDocument {
fn get_info(&mut self) -> Result<DocumentInfo>;
fn set_info(&mut self, info: DocumentInfo) -> Result<()>;
fn page_count(&mut self) -> Result<usize>;
fn get_page_info(&mut self, index: usize) -> Result<PageInfo>;
fn remove_page(&mut self, index: usize) -> Result<()>;
fn move_page(&mut self, from: usize, to: usize) -> Result<()>;
fn duplicate_page(&mut self, index: usize) -> Result<usize>;
fn save(&mut self, path: impl AsRef<Path>) -> Result<()>;
fn save_with_options(&mut self, path: impl AsRef<Path>, options: SaveOptions) -> Result<()>;
}
Lista Completa de Métodos do DocumentEditor
As tabelas abaixo enumeram toda a superfície pública de métodos do DocumentEditor / editor Pdf em Rust. Cada linha tem um link para o guia detalhado quando aplicável. A disponibilidade dos bindings está indicada; consulte as páginas individuais para exemplos em Go / C#.
Metadados
| Método | Rust | Python | WASM | Go | C# | Página |
|---|---|---|---|---|---|---|
title / set_title |
✓ | ✓ | ✓ | ✓ | ✓ | Visão Geral |
author / set_author |
✓ | ✓ | ✓ | ✓ | ✓ | Visão Geral |
subject / set_subject |
✓ | ✓ | ✓ | ✓ | ✓ | Visão Geral |
keywords / set_keywords |
✓ | ✓ | ✓ | ✓ | — | Visão Geral |
producer / set_producer |
✓ | ✓ | — | ✓ | — | Visão Geral |
creation_date / set_creation_date |
✓ | ✓ | — | ✓ | — | Visão Geral |
apply_metadata(info) |
✓ | ✓ | — | ✓ | — | Visão Geral |
Operações de página
| Método | Rust | Python | WASM | Go | C# | Página |
|---|---|---|---|---|---|---|
remove_page / delete_page |
✓ | ✓ | ✓ | ✓ | — | Páginas |
move_page(from, to) |
✓ | ✓ | — | ✓ | — | Páginas |
duplicate_page(i) |
✓ | ✓ | — | — | — | Páginas |
get_page_rotation / set_page_rotation |
✓ | ✓ | ✓ | ✓ | — | Páginas |
rotate_page_by(i, deg) |
✓ | ✓ | — | — | — | Páginas |
rotate_all_pages(deg) |
✓ | ✓ | ✓ | — | — | Páginas |
get_page_media_box / set_page_media_box |
✓ | ✓ | ✓ | — | — | Páginas |
get_page_crop_box / set_page_crop_box |
✓ | ✓ | ✓ | — | — | Páginas |
crop_margins(l, r, t, b) |
✓ | ✓ | ✓ | ✓ | — | Páginas |
erase_region(page, rect) |
✓ | ✓ | ✓ | ✓ | — | Páginas |
erase_regions(page, rects) |
✓ | ✓ | ✓ | — | — | Páginas |
clear_erase_regions(page) |
✓ | ✓ | — | — | — | Páginas |
Mesclar / dividir
| Método | Rust | Python | WASM | Go | C# | Página |
|---|---|---|---|---|---|---|
merge_from(path) |
✓ | ✓ | — | ✓ | — | Mesclar e Dividir |
merge_pages_from(path, pages) |
✓ | ✓ | — | — | — | Mesclar e Dividir |
extract_pages(pages, output) |
✓ | ✓ | ✓ | — | — | Mesclar e Dividir |
Merge([]paths) nível superior |
— | — | — | ✓ | — | Mesclar e Dividir |
Formulários
| Método | Rust | Python | WASM | Go | C# | Página |
|---|---|---|---|---|---|---|
get_form_fields() |
✓ | ✓ | ✓ | ✓ | ✓ | Formulários |
get_form_field_value(name) |
✓ | ✓ | ✓ | — | — | Formulários |
has_form_field(name) |
✓ | ✓ | — | — | — | Formulários |
set_form_field_value(name, value) |
✓ | ✓ | ✓ | ✓ | ✓ | Formulários |
add_form_field(widget, page) |
✓ | — | — | — | — | Criação de Formulários |
add_parent_field / add_child_field |
✓ | — | — | — | — | Criação de Formulários |
remove_form_field(name) |
✓ | ✓ | — | — | — | Formulários |
set_form_field_* (readonly, required, tooltip, rect, max_length, alignment, colors, flags) |
✓ | ✓ | — | — | — | Formulários |
flatten_forms_on_page(page) |
✓ | ✓ | ✓ | ✓ | — | Formulários |
flatten_forms() |
✓ | ✓ | ✓ | ✓ | ✓ | Formulários |
export_form_data_fdf(path) |
✓ | ✓ | ✓ | — | — | Formulários |
export_form_data_xfdf(path) |
✓ | ✓ | ✓ | — | — | Formulários |
Anotações
| Método | Rust | Python | WASM | Go | C# | Página |
|---|---|---|---|---|---|---|
flatten_page_annotations(page) |
✓ | ✓ | ✓ | ✓ | — | Anotações |
flatten_all_annotations() |
✓ | ✓ | ✓ | ✓ | — | Anotações |
is_page_marked_for_annotation_flatten(page) |
✓ | ✓ | — | — | — | Anotações |
unmark_page_for_annotation_flatten(page) |
✓ | ✓ | — | — | — | Anotações |
Redação
| Método | Rust | Python | WASM | Go | C# | Página |
|---|---|---|---|---|---|---|
apply_page_redactions(page) |
✓ | ✓ | ✓ | — | — | Redação |
apply_all_redactions() |
✓ | ✓ | ✓ | — | — | Redação |
is_page_marked_for_redaction(page) |
✓ | ✓ | — | — | — | Redação |
unmark_page_for_redaction(page) |
✓ | ✓ | — | — | — | Redação |
XFA
| Método | Rust | Python | WASM | Go | C# | Página |
|---|---|---|---|---|---|---|
has_xfa() |
✓ | ✓ | ✓ | ✓ | ✓ | Formulários XFA |
analyze_xfa() |
✓ | ✓ | — | — | — | Formulários XFA |
convert_xfa_to_acroform(opts) |
✓ | — | — | — | — | Formulários XFA |
Salvar
| Método | Rust | Python | WASM | Go | C# | Página |
|---|---|---|---|---|---|---|
save(path) |
✓ | ✓ | ✓ | ✓ | ✓ | Visão Geral |
save_with_options(path, opts) |
✓ | ✓ | — | — | — | Criptografia |
save_encrypted(path, user, owner) |
✓ | ✓ | ✓ | ✓ | — | Criptografia |
save_with_encryption(path, cfg) |
✓ | ✓ | — | — | — | Criptografia |
save_async / SaveAsync |
— | — | — | — | ✓ | Assíncrono |
Utilitários (conveniências do Go)
Métodos expostos como métodos do DocumentEditor no Go; equivalentes via editor.source() no Rust:
| Método | Rust | Python | WASM | Go | C# |
|---|---|---|---|---|---|
IsModified |
is_modified() |
is_modified |
— | IsModified() |
IsModified |
SourcePath |
source_path() |
source_path |
— | SourcePath() |
SourcePath |
Version |
version() |
version() |
— | Version() |
— |
PageCount |
current_page_count() |
page_count() |
pageCount() |
PageCount() |
PageCount |
RemoveHeaders / RemoveFooters / RemoveArtifacts |
✓ | ✓ | — | ✓ | ✓ |
Close / Dispose |
Drop |
context manager | free() |
Close() |
Dispose() |
Fluxo de Edição Completo
Este exemplo demonstra uma sessão de edição completa: abrir, inspecionar, modificar metadados, editar conteúdo e salvar.
Python
from pdf_oxide import PdfDocument
# Open the document
doc = PdfDocument("report.pdf")
print(f"Pages: {doc.page_count()}")
# Update metadata
doc.set_title("Annual Report 2025")
doc.set_author("Finance Team")
# Edit text on page 0
page = doc.page(0)
for text in page.find_text_containing("DRAFT"):
page.set_text(text.id, "FINAL")
doc.save_page(page)
# Save
doc.save("report-final.pdf")
Rust
use pdf_oxide::api::Pdf;
let mut doc = Pdf::open("report.pdf")?;
println!("Pages: {}", doc.page_count()?);
// Update metadata
{
let editor = doc.editor().unwrap();
editor.set_title("Annual Report 2025");
editor.set_author("Finance Team");
}
// Edit text on page 0
let mut page = doc.page(0)?;
let drafts = page.find_text_containing("DRAFT");
for t in &drafts {
page.set_text(t.id(), "FINAL")?;
}
doc.save_page(page)?;
// Save
doc.save("report-final.pdf")?;
Páginas Relacionadas
- Edição de Texto – localizar e substituir texto, modificar fontes e posicionamento
- Operações de Página – rotação, corte, mesclagem e extração de páginas
- Edição de Campos de Formulário – preencher, adicionar e achatar campos de formulário
- Criptografia e Segurança – proteger com senha e definir permissões