Delphi DLL 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}}. Delphi DLL

var
success: Boolean;
pdf: HCkPdf;
json: HCkJsonObject;
jsonOut: HCkJsonObject;
i: Integer;
count_i: Integer;

begin
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

pdf := CkPdf_Create();
success := CkPdf_LoadFile(pdf,'qa_data/pdf/invoice_template.pdf');
if (success = False) then
  begin
    Memo1.Lines.Add(CkPdf__lastErrorText(pdf));
    Exit;
  end;

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'placeholders.customer','Acme Corp');
//  (The other placeholders are left as they are for this example.)
CkJsonObject_UpdateString(json,'unusedPlaceholders','keep');

jsonOut := CkJsonObject_Create();
success := CkPdf_TextReplace(pdf,'apply',json,jsonOut);
if (success = False) then
  begin
    Memo1.Lines.Add(CkPdf__lastErrorText(pdf));
    Exit;
  end;

Memo1.Lines.Add('In the page content, customer was replaced ' + IntToStr(CkJsonObject_IntOf(jsonOut,'replacements[0].count')) + ' times.');

//  Where else the placeholder occurs, untouched:
i := 0;
count_i := CkJsonObject_SizeOfArray(jsonOut,'notReplaced');
while i < count_i do
  begin
    CkJsonObject_putI(jsonOut,i);
    Memo1.Lines.Add('not replaced: {{' + CkJsonObject__stringOf(jsonOut,'notReplaced[i].field') + '}} in ' + CkJsonObject__stringOf(jsonOut,'notReplaced[i].where'));
    i := i + 1;
  end;

success := CkPdf_WriteFile(pdf,'qa_output/invoice_customer.pdf');
if (success = False) then
  begin
    Memo1.Lines.Add(CkPdf__lastErrorText(pdf));
    Exit;
  end;

//  Sample output:

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

CkPdf_Dispose(pdf);
CkJsonObject_Dispose(json);
CkJsonObject_Dispose(jsonOut);