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

use strict;
use warnings;
use Chilkat2;

# 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

my $pdf = Chilkat2::Pdf->new;
my $success = $pdf->LoadFile('qa_data/pdf/invoice_labels.pdf');
if (!$success) {
    print $pdf->LastErrorText, "\n";
    exit;
}

my $json = Chilkat2::JsonObject->new;
my $jsonOut = Chilkat2::JsonObject->new;

# "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');

$success = $pdf->TextReplace('check', $json, $jsonOut);
if (!$success) {
    print $pdf->LastErrorText, "\n";
    exit;
}

print 'default: ok = ', ($jsonOut->BoolOf('ok') ? 1 : 0), ', problem: "', $jsonOut->StringOf('problems[0].label'), '" ', $jsonOut->StringOf('problems[0].reason'), "\n";

# With "ignore", the label that is not there is skipped.
$json->UpdateString('unmatchedValues', 'ignore');
$success = $pdf->TextReplace('apply', $json, $jsonOut);
if (!$success) {
    print $pdf->LastErrorText, "\n";
    exit;
}

print 'ignore: applied = ', ($jsonOut->BoolOf('applied') ? 1 : 0), ', replacements: ', $jsonOut->SizeOfArray('replacements'), "\n";

$success = $pdf->WriteFile('qa_output/invoice_renumbered.pdf');
if (!$success) {
    print $pdf->LastErrorText, "\n";
    exit;
}

# Sample output:

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