Tcl 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. Tcl

load ./chilkat.dll

set success 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

set pdf [new_CkPdf]

set success [CkPdf_LoadFile $pdf "qa_data/pdf/order_confirmation.pdf"]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    exit
}

set json [new_CkJsonObject]

set jsonOut [new_CkJsonObject]

#  Both pages have "Status:   Pending".  With pages "2", only page 2 is searched.
CkJsonObject_UpdateString $json "pages" "2"
CkJsonObject_UpdateString $json "labels[0].label" "Status:"
CkJsonObject_UpdateString $json "labels[0].value" "Shipped"
set success [CkPdf_TextReplace $pdf "check" $json $jsonOut]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonOut
    exit
}

puts "pages 2: found on page(s) [CkJsonObject_stringOf $jsonOut {replacements[0].pages}]"

#  With every page searched, the default occurrence ("first") still replaces one -- the first in reading order.
CkJsonObject_UpdateString $json "pages" "all"
set success [CkPdf_TextReplace $pdf "check" $json $jsonOut]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonOut
    exit
}

puts "pages all, first occurrence: found on page(s) [CkJsonObject_stringOf $jsonOut {replacements[0].pages}]"

#  Every occurrence on every page.
CkJsonObject_UpdateString $json "labels[0].occurrence" "all"
set success [CkPdf_TextReplace $pdf "apply" $json $jsonOut]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonOut
    exit
}

puts "pages all, every occurrence: [CkJsonObject_IntOf $jsonOut {replacements[0].count}] replaced on page(s) [CkJsonObject_stringOf $jsonOut {replacements[0].pages}]"

set success [CkPdf_WriteFile $pdf "qa_output/order_shipped.pdf"]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonOut
    exit
}

#  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

delete_CkPdf $pdf
delete_CkJsonObject $json
delete_CkJsonObject $jsonOut