Objective-C 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. Objective-C

#import <CkoPdf.h>
#import <CkoJsonObject.h>

BOOL success = NO;

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

CkoPdf *pdf = [[CkoPdf alloc] init];
success = [pdf LoadFile: @"qa_data/pdf/invoice_labels.pdf"];
if (success == NO) {
    NSLog(@"%@",pdf.LastErrorText);
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
CkoJsonObject *jsonOut = [[CkoJsonObject alloc] init];

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

success = [pdf TextReplace: @"check" jsonIn: json jsonOut: jsonOut];
if (success == NO) {
    NSLog(@"%@",pdf.LastErrorText);
    return;
}

NSLog(@"%@%d%@%@%@%@",@"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" value: @"ignore"];
success = [pdf TextReplace: @"apply" jsonIn: json jsonOut: jsonOut];
if (success == NO) {
    NSLog(@"%@",pdf.LastErrorText);
    return;
}

NSLog(@"%@%d%@%d",@"ignore: applied = ",[jsonOut BoolOf: @"applied"],@", replacements: ",[[jsonOut SizeOfArray: @"replacements"] intValue]);

success = [pdf WriteFile: @"qa_output/invoice_renumbered.pdf"];
if (success == NO) {
    NSLog(@"%@",pdf.LastErrorText);
    return;
}

//  Sample output:

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