Java Requires Chilkat v11.7.0+

What PDF Text Replacement Does Not Change: Metadata, Links, Form Fields

See more PDF Text Replacement Examples

TextReplace changes the page content only. A placeholder that also appears in the document's metadata (the Title, Author, Subject, Keywords, Creator or Producer), in a link's target URL, or in a form field's value is left as it is and reported in "notReplaced" with "where" saying which. The invoice template's title is "Invoice for {{customer}}" and its "View this invoice online" link points at a URL that holds {{customer}}. Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

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

    CkPdf pdf = new CkPdf();
    success = pdf.LoadFile("qa_data/pdf/invoice_template.pdf");
    if (success == false) {
        System.out.println(pdf.lastErrorText());
        return;
        }

    CkJsonObject json = new CkJsonObject();
    json.UpdateString("placeholders.customer","Acme Corp");
    //  (The other placeholders are left as they are for this example.)
    json.UpdateString("unusedPlaceholders","keep");

    CkJsonObject jsonOut = new CkJsonObject();
    success = pdf.TextReplace("apply",json,jsonOut);
    if (success == false) {
        System.out.println(pdf.lastErrorText());
        return;
        }

    System.out.println("In the page content, customer was replaced " + jsonOut.IntOf("replacements[0].count") + " times.");

    //  Where else the placeholder occurs, untouched:
    int i = 0;
    int count_i = jsonOut.SizeOfArray("notReplaced");
    while (i < count_i) {
        jsonOut.put_I(i);
        System.out.println("not replaced: {{" + jsonOut.stringOf("notReplaced[i].field") + "}} in " + jsonOut.stringOf("notReplaced[i].where"));
        i = i+1;
        }

    success = pdf.WriteFile("qa_output/invoice_customer.pdf");
    if (success == false) {
        System.out.println(pdf.lastErrorText());
        return;
        }

    //  Sample output:

    //  In the page content, customer was replaced 2 times.
    //  not replaced: {{customer}} in metadata
    //  not replaced: {{customer}} in linkTarget
  }
}