Unicode C++ Requires Chilkat v11.7.0+

Get a PDF Field Value by its Label (Value to the Right)

See more PDF Text Extraction Examples

Demonstrates the "label" option, which captures the text that belongs to a caption such as "Invoice Number:" without needing coordinates. With labelValue "right", the value is the rest of the label's line. Label matching ignores case, extra spaces and a trailing colon. Unicode C++

#include <CkPdfW.h>
#include <CkJsonObjectW.h>

void ChilkatSample(void)
    {
    bool success = false;

    //  This example requires the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    //  The invoice used in this example is available at invoice_labels.pdf

    CkPdfW pdf;
    success = pdf.LoadFile(L"qa_data/pdf/invoice_labels.pdf");
    if (success == false) {
        wprintf(L"%s\n",pdf.lastErrorText());
        return;
    }

    CkJsonObjectW json;
    CkJsonObjectW jsonOut;

    //  The invoice has lines such as "Invoice Number:   INV-2026-0412".
    //  The label option restricts the "text" operation to the text belonging to the label.
    json.UpdateString(L"label",L"Invoice Number");

    //  "right" means the value is the rest of the label's line.
    //  (The default, "auto", uses the rest of the line if there is text there, otherwise the block below.)
    json.UpdateString(L"labelValue",L"right");

    success = pdf.ExtractText(L"text",json,jsonOut);
    if (success == false) {
        wprintf(L"%s\n",pdf.lastErrorText());
        return;
    }

    //  The value is returned as the text.
    wprintf(L"Invoice Number: %s\n",jsonOut.stringOf(L"text"));

    //  The labelMatches array tells where the label was found and how it appeared in the PDF.
    wprintf(L"Found on page %d as \"%s\"\n",jsonOut.IntOf(L"labelMatches[0].page"),jsonOut.stringOf(L"labelMatches[0].label"));

    //  Matching ignores case and the trailing colon, so these all work:
    json.UpdateString(L"label",L"CUSTOMER:");
    success = pdf.ExtractText(L"text",json,jsonOut);
    if (success == false) {
        wprintf(L"%s\n",pdf.lastErrorText());
        return;
    }

    wprintf(L"Customer: %s\n",jsonOut.stringOf(L"text"));

    json.UpdateString(L"label",L"due date");
    success = pdf.ExtractText(L"text",json,jsonOut);
    if (success == false) {
        wprintf(L"%s\n",pdf.lastErrorText());
        return;
    }

    wprintf(L"Due Date: %s\n",jsonOut.stringOf(L"text"));

    //  The totals at the foot of the invoice are right-aligned labels with the amount beside them.
    json.UpdateString(L"label",L"Total Due");
    success = pdf.ExtractText(L"text",json,jsonOut);
    if (success == false) {
        wprintf(L"%s\n",pdf.lastErrorText());
        return;
    }

    wprintf(L"Total Due: %s\n",jsonOut.stringOf(L"text"));

    //  A label that is not found is not an error.  The text is empty, labelMatches is empty,
    //  and the quality report has an issue with the code "labelNotFound".
    json.UpdateString(L"label",L"Tracking Number");
    success = pdf.ExtractText(L"text",json,jsonOut);
    if (success == false) {
        wprintf(L"%s\n",pdf.lastErrorText());
        return;
    }

    if (jsonOut.SizeOfArray(L"labelMatches") == 0) {
        wprintf(L"Tracking Number: (not found) %s\n",jsonOut.stringOf(L"quality.pages[0].issues[0].code"));
    }

    //  Sample output:

    //  Invoice Number: INV-2026-0412
    //  Found on page 1 as "Invoice Number:"
    //  Customer: Northwind Traders
    //  Due Date: April 13, 2026
    //  Total Due: $1,234.53
    //  Tracking Number: (not found) labelNotFound
    }