Xbase++ 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. Xbase++

LOCAL nSuccess
LOCAL oPdf
LOCAL oJson
LOCAL oJsonOut

nSuccess := 0

//  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

oPdf := CreateObject("Chilkat.Pdf")
nSuccess := oPdf:LoadFile("qa_data/pdf/order_confirmation.pdf")
IF (nSuccess == 0)
    ? oPdf:LastErrorText
    oPdf:destroy()
    RETURN
ENDIF

oJson := CreateObject("Chilkat.JsonObject")
oJsonOut := CreateObject("Chilkat.JsonObject")

//  Both pages have "Status:   Pending".  With pages "2", only page 2 is searched.
oJson:UpdateString("pages", "2")
oJson:UpdateString("labels[0].label", "Status:")
oJson:UpdateString("labels[0].value", "Shipped")
nSuccess := oPdf:TextReplace("check", oJson, oJsonOut)
IF (nSuccess == 0)
    ? oPdf:LastErrorText
    oPdf:destroy()
    oJson:destroy()
    oJsonOut:destroy()
    RETURN
ENDIF

? "pages 2: found on page(s) " + oJsonOut:StringOf("replacements[0].pages")

//  With every page searched, the default occurrence ("first") still replaces one -- the first in reading order.
oJson:UpdateString("pages", "all")
nSuccess := oPdf:TextReplace("check", oJson, oJsonOut)
IF (nSuccess == 0)
    ? oPdf:LastErrorText
    oPdf:destroy()
    oJson:destroy()
    oJsonOut:destroy()
    RETURN
ENDIF

? "pages all, first occurrence: found on page(s) " + oJsonOut:StringOf("replacements[0].pages")

//  Every occurrence on every page.
oJson:UpdateString("labels[0].occurrence", "all")
nSuccess := oPdf:TextReplace("apply", oJson, oJsonOut)
IF (nSuccess == 0)
    ? oPdf:LastErrorText
    oPdf:destroy()
    oJson:destroy()
    oJsonOut:destroy()
    RETURN
ENDIF

? "pages all, every occurrence: " + Str(oJsonOut:IntOf("replacements[0].count")) + " replaced on page(s) " + oJsonOut:StringOf("replacements[0].pages")

nSuccess := oPdf:WriteFile("qa_output/order_shipped.pdf")
IF (nSuccess == 0)
    ? oPdf:LastErrorText
    oPdf:destroy()
    oJson:destroy()
    oJsonOut:destroy()
    RETURN
ENDIF

//  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

oPdf:destroy()
oJson:destroy()
oJsonOut:destroy()