Java Requires Chilkat v11.7.0+

A PDF Label That Is Not on the Page: notFound or Ignore

See more PDF Text Replacement Examples

Demonstrates the "unmatchedValues" option. A label or placeholder given a value but not found on the selected pages is a problem with the reason notFound, which stops "apply", because a missing label usually means the wrong document or a typo in the label. With unmatchedValues "ignore" such a value is skipped and the rest is applied -- the right choice when one set of values serves several document layouts. Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Pdf;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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_labels.pdf

        Pdf pdf = new Pdf();
        try {
            pdf.loadFile("qa_data/pdf/invoice_labels.pdf");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        JsonObject json = new JsonObject();
        JsonObject jsonOut = new JsonObject();

        // "Tracking Number:" is not on this invoice.
        json.updateString("labels[0].label", "Invoice Number:");
        json.updateString("labels[0].value", "INV-2026-0500");
        json.updateString("labels[1].label", "Tracking Number:");
        json.updateString("labels[1].value", "1Z999AA10123456784");

        try {
            pdf.textReplace("check", json, jsonOut);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("default: ok = " + jsonOut.boolOf("ok") + ", problem: \"" + jsonOut.stringOf("problems[0].label") + "\" " + jsonOut.stringOf("problems[0].reason"));

        // With "ignore", the label that is not there is skipped.
        json.updateString("unmatchedValues", "ignore");
        try {
            pdf.textReplace("apply", json, jsonOut);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("ignore: applied = " + jsonOut.boolOf("applied") + ", replacements: " + jsonOut.sizeOfArray("replacements"));

        try {
            pdf.writeFile("qa_output/invoice_renumbered.pdf");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Sample output:

        // default: ok = false, problem: "Tracking Number:" notFound
        // ignore: applied = true, replacements: 1
    }
}