C Requires Chilkat v11.7.0+

Get the Text Block Below a PDF Caption

See more PDF Text Extraction Examples

Demonstrates the "label" option with labelValue "below", which captures the block of text directly under a caption such as "Ship To", ending at the next gap or heading. Combined with layout "lines", the lines of an address block are kept separate. C

#include <C_CkPdf.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkPdf pdf;
    HCkJsonObject json;
    HCkJsonObject jsonOut;

    success = FALSE;

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

    //  The packing slip used in this example is available at packing_slip.pdf

    pdf = CkPdf_Create();
    success = CkPdf_LoadFile(pdf,"qa_data/pdf/packing_slip.pdf");
    if (success == FALSE) {
        printf("%s\n",CkPdf_lastErrorText(pdf));
        CkPdf_Dispose(pdf);
        return;
    }

    json = CkJsonObject_Create();
    jsonOut = CkJsonObject_Create();

    //  The packing slip has the captions "Bill To" and "Ship To" side by side,
    //  each with an address block below it.
    CkJsonObject_UpdateString(json,"label","Ship To");

    //  "below" means the value is the block of text directly under the label.
    CkJsonObject_UpdateString(json,"labelValue","below");

    //  With the default "flow" layout the lines of the block would be joined into one paragraph.
    //  "lines" keeps each line of the address on its own line.
    CkJsonObject_UpdateString(json,"layout","lines");

    success = CkPdf_ExtractText(pdf,"text",json,jsonOut);
    if (success == FALSE) {
        printf("%s\n",CkPdf_lastErrorText(pdf));
        CkPdf_Dispose(pdf);
        CkJsonObject_Dispose(json);
        CkJsonObject_Dispose(jsonOut);
        return;
    }

    printf("Ship To:\n");
    printf("%s\n",CkJsonObject_stringOf(jsonOut,"text"));
    printf("\n");

    CkJsonObject_UpdateString(json,"label","Bill To");
    success = CkPdf_ExtractText(pdf,"text",json,jsonOut);
    if (success == FALSE) {
        printf("%s\n",CkPdf_lastErrorText(pdf));
        CkPdf_Dispose(pdf);
        CkJsonObject_Dispose(json);
        CkJsonObject_Dispose(jsonOut);
        return;
    }

    printf("Bill To:\n");
    printf("%s\n",CkJsonObject_stringOf(jsonOut,"text"));
    printf("\n");

    //  A caption over a short paragraph works the same way.  Here the flow layout is better,
    //  because the two lines are one piece of text.
    CkJsonObject_UpdateString(json,"label","Special Instructions");
    CkJsonObject_UpdateString(json,"layout","flow");
    success = CkPdf_ExtractText(pdf,"text",json,jsonOut);
    if (success == FALSE) {
        printf("%s\n",CkPdf_lastErrorText(pdf));
        CkPdf_Dispose(pdf);
        CkJsonObject_Dispose(json);
        CkJsonObject_Dispose(jsonOut);
        return;
    }

    printf("Special Instructions:\n");
    printf("%s\n",CkJsonObject_stringOf(jsonOut,"text"));

    //  Sample output:

    //  Ship To:
    //  Frank Delgado
    //  c/o Harbor Pet Boarding
    //  9 Ferry Lane
    //  Portside, WA 98001
    //  
    //  Bill To:
    //  Frank Delgado
    //  Apartment 3B
    //  41 Mill Street
    //  Portside, WA 98000
    //  
    //  Special Instructions:
    //  Leave the carton with the boarding office if no one answers. Do not leave it outside; the cat tree is not packed for rain.


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

    }