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

local chilkat = require("chilkat")

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

local pdf = chilkat.Pdf.new()
local success = pdf:load_file("qa_data/pdf/order_confirmation.pdf")
if not success then
    print(pdf.last_error_text)
    return
end

local json = chilkat.JsonObject.new()
local jsonOut = chilkat.JsonObject.new()

-- Both pages have "Status:   Pending".  With pages "2", only page 2 is searched.
json:update_string("pages", "2")
json:update_string("labels[0].label", "Status:")
json:update_string("labels[0].value", "Shipped")
success = pdf:text_replace("check", json, jsonOut)
if not success then
    print(pdf.last_error_text)
    return
end

print("pages 2: found on page(s) " .. jsonOut:string_of("replacements[0].pages"))

-- With every page searched, the default occurrence ("first") still replaces one -- the first in reading order.
json:update_string("pages", "all")
success = pdf:text_replace("check", json, jsonOut)
if not success then
    print(pdf.last_error_text)
    return
end

print("pages all, first occurrence: found on page(s) " .. jsonOut:string_of("replacements[0].pages"))

-- Every occurrence on every page.
json:update_string("labels[0].occurrence", "all")
success = pdf:text_replace("apply", json, jsonOut)
if not success then
    print(pdf.last_error_text)
    return
end

print("pages all, every occurrence: " .. jsonOut:int_of("replacements[0].count") .. " replaced on page(s) " .. jsonOut:string_of("replacements[0].pages"))

success = pdf:write_file("qa_output/order_shipped.pdf")
if not success then
    print(pdf.last_error_text)
    return
end

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