PDF transformations, forms, images and charts
PDFBoxTools works primarily on existing files and paths. Initialize the module:
Dim tools As PDFBoxTools
tools.Initialize
Merge documents
Dim files As List
files.Initialize
files.Add(File.Combine(File.DirApp, "contract.pdf"))
files.Add(File.Combine(File.DirApp, "attachments.pdf"))
If tools.MergePDFs(files, File.DirApp, "package.pdf") Then
Log("PDF package created")
Else
Log("Merge failed")
End If
Use case: combine contracts, appendices and evidence in one document. Keep the output distinct from input files.
Pages: split, extract, insert and rotate
Dim pages As Int = tools.GetPageCount(File.DirApp, "package.pdf")
Log("Pages: " & pages)
Dim parts As Int = tools.SplitPDF(File.DirApp, "package.pdf", File.DirApp, "page")
Log("Files created: " & parts)
Dim extracted As Boolean = tools.ExtractPages( _
File.Combine(File.DirApp, "package.pdf"), _
File.Combine(File.DirApp, "extract.pdf"), 0, 1)
Dim inserted As Boolean = tools.InsertDocumentAt( _
File.Combine(File.DirApp, "base.pdf"), _
File.Combine(File.DirApp, "appendix.pdf"), _
File.Combine(File.DirApp, "result.pdf"), 1)
Page indices in these APIs are zero-based. Validate input ranges.
Text and images
Dim text As String = tools.ExtractText(File.DirApp, "contract.pdf")
Log(text)
Dim exported As Boolean = tools.PDFToImage( _
File.DirApp, "contract.pdf", 0, 150, File.DirApp, "cover.png")
Use cases: indexing searchable documents and producing thumbnail images.
AcroForm fields
Dim fields As Map
fields.Initialize
fields.Put("Name", "Ana Torres")
fields.Put("City", "Manta")
Dim filled As Boolean = tools.FillForm( _
File.DirApp, "template.pdf", fields, File.DirApp, "filled.pdf")
Log("Filled: " & filled)
Use field names present in the original form; check GetFormFieldNames(pdfPath). FlattenForm(inPath, outPath) creates a non-editable output after filling, if required.
Encryption and watermarks
Dim protected As Boolean = tools.EncryptPDF( _
File.DirApp, "input.pdf", File.DirApp, "protected.pdf", _
"example-user-password", "example-owner-password")
Dim marked As Boolean = tools.AddTextWatermark( _
File.Combine(File.DirApp, "input.pdf"), _
File.Combine(File.DirApp, "draft.pdf"), "DRAFT", 48, 0.25)
Never hard-code production passwords. Encryption is not digital signing; see Digital signatures.
Charts and QR codes
Dim chart As PDFChartHelper
chart.Initialize
Dim months As List = Array("Jan", "Feb", "Mar")
Dim values As List = Array(10, 20, 15)
Dim bmp As B4XBitmap = chart.CreateBarChart("Sales", months, values, "")
Dim imagePath As String = chart.SaveTempBitmap(bmp, "sales")
' Use the generated temporary file as an image.
' Call chart.ClearTempFiles only after the file is no longer needed.
Dim qr As QRCodeGenerator
qr.Initialize(300)
Dim code As B4XBitmap = qr.Create("https://example.com/verify/123")
Use case: data reports and verification QR codes. Check SaveTempBitmap output before passing it to a file-based PDF API.
Other operations include AddTextAt, ImagesToPDF, FillFormField, AddTextField, GetPDFMetadata, ExtractEmbeddedImages, DeletePages, RotatePages, StampPageNumbers, PrintPDF, PrintPDFToPrinter and GetSystemPrinters. See Public API for exact signatures.