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

import 'package:chilkat/chilkat.dart';

void main() {
  // 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

  final pdf = CkPdf();
  try {
    pdf.loadFile('qa_data/pdf/invoice_labels.pdf');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final json = CkJsonObject();
  final jsonOut = CkJsonObject();

  // "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);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('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);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('ignore: applied = ${jsonOut.boolOf('applied')}, replacements: ${jsonOut.sizeOfArray('replacements')}');

  try {
    pdf.writeFile('qa_output/invoice_renumbered.pdf');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Sample output:

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