B4X Requires Chilkat v11.7.0+

Replace PDF Text on Selected Pages Only

See more PDF Text Replacement Examples

Demonstrates the "pages" option, which limits the search for placeholders and labels to the given pages: "all" (the default), "first", "last", "odd", "even", or a list such as "1,3,5-9". The two-page order confirmation carries the same "Status:" label on both pages; the status is changed on page 2 only, then on both pages. B4X

Dim success As Boolean = False

'  This example requires the Chilkat API to have been previously unlocked.
'  See Global Unlock Sample for sample code.

'  The PDF used in this example is available at order_confirmation.pdf

Dim pdf As ChilkatPdf
pdf.Initialize("pdf")
success = pdf.LoadFile("qa_data/pdf/order_confirmation.pdf")
If success = False Then
    Log(pdf.LastErrorText)
    Return
End If


Dim json As ChilkatJsonObject
json.Initialize
Dim jsonOut As ChilkatJsonObject
jsonOut.Initialize

'  Both pages have "Status:   Pending".  With pages "2", only page 2 is searched.
json.UpdateString("pages", "2")
json.UpdateString("labels[0].label", "Status:")
json.UpdateString("labels[0].value", "Shipped")
success = pdf.TextReplace("check", json, jsonOut)
If success = False Then
    Log(pdf.LastErrorText)
    Return
End If

Log("pages 2: found on page(s) " & jsonOut.StringOf("replacements[0].pages"))

'  With every page searched, the default occurrence ("first") still replaces one -- the first in reading order.
json.UpdateString("pages", "all")
success = pdf.TextReplace("check", json, jsonOut)
If success = False Then
    Log(pdf.LastErrorText)
    Return
End If

Log("pages all, first occurrence: found on page(s) " & jsonOut.StringOf("replacements[0].pages"))

'  Every occurrence on every page.
json.UpdateString("labels[0].occurrence", "all")
success = pdf.TextReplace("apply", json, jsonOut)
If success = False Then
    Log(pdf.LastErrorText)
    Return
End If

Log("pages all, every occurrence: " & jsonOut.IntOf("replacements[0].count") & " replaced on page(s) " & jsonOut.StringOf("replacements[0].pages"))

success = pdf.WriteFile("qa_output/order_shipped.pdf")
If success = False Then
    Log(pdf.LastErrorText)
    Return
End If


'  Sample output:

'  pages 2: found on page(s) 2
'  pages all, first occurrence: found on page(s) 1
'  pages all, every occurrence: 2 replaced on page(s) 1,2