Visual FoxPro Requires Chilkat v11.7.0+

Replace the Second (or Every) Occurrence of a Label in a PDF

See more PDF Text Replacement Examples

Demonstrates the "occurrence" member of a label entry. By default the first occurrence of a label, in reading order across the selected pages, is replaced; "occurrence" can be a number for the nth, or "all" for every occurrence. The invoice template has "Ref:" twice. Visual FoxPro

LOCAL lnSuccess
LOCAL loPdf
LOCAL loJson
LOCAL loJsonOut

lnSuccess = 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 invoice_template.pdf

loPdf = CreateObject('Chilkat.Pdf')
lnSuccess = loPdf.LoadFile("qa_data/pdf/invoice_template.pdf")
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    CANCEL
ENDIF

loJson = CreateObject('Chilkat.JsonObject')
loJsonOut = CreateObject('Chilkat.JsonObject')

*  This template's {{placeholders}} are not being filled here: "keep" leaves them as they are
*  (the default, "error", would refuse to apply while a placeholder on the page has no value).
loJson.UpdateString("unusedPlaceholders","keep")

*  "Ref:" appears twice on the page (A-1 near the top, A-2 below the totals).
*  The default replaces the first occurrence only.
loJson.UpdateString("labels[0].label","Ref:")
loJson.UpdateString("labels[0].value","B-7")
lnSuccess = loPdf.TextReplace("check",loJson,loJsonOut)
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    RELEASE loJson
    RELEASE loJsonOut
    CANCEL
ENDIF

? "default: " + STR(loJsonOut.IntOf("replacements[0].count")) + " occurrence replaced"

*  The second occurrence only.
loJson.UpdateString("labels[0].occurrence","2")
lnSuccess = loPdf.TextReplace("check",loJson,loJsonOut)
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    RELEASE loJson
    RELEASE loJsonOut
    CANCEL
ENDIF

? "occurrence 2: " + STR(loJsonOut.IntOf("replacements[0].count")) + " occurrence replaced"

*  Every occurrence.
loJson.UpdateString("labels[0].occurrence","all")
lnSuccess = loPdf.TextReplace("apply",loJson,loJsonOut)
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    RELEASE loJson
    RELEASE loJsonOut
    CANCEL
ENDIF

? "occurrence all: " + STR(loJsonOut.IntOf("replacements[0].count")) + " occurrences replaced"

lnSuccess = loPdf.WriteFile("qa_output/invoice_refs.pdf")
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    RELEASE loJson
    RELEASE loJsonOut
    CANCEL
ENDIF

*  Sample output:

*  default: 1 occurrence replaced
*  occurrence 2: 1 occurrence replaced
*  occurrence all: 2 occurrences replaced

RELEASE loPdf
RELEASE loJson
RELEASE loJsonOut