Visual FoxPro 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. Visual FoxPro

LOCAL lnSuccess
LOCAL loPdf
LOCAL loJson
LOCAL loJsonOut

lnSuccess = 0

*  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

loPdf = CreateObject('Chilkat.Pdf')
lnSuccess = loPdf.LoadFile("qa_data/pdf/invoice_labels.pdf")
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    CANCEL
ENDIF

loJson = CreateObject('Chilkat.JsonObject')
loJsonOut = CreateObject('Chilkat.JsonObject')

*  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.
loJson.UpdateString("label","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.)
loJson.UpdateString("labelValue","right")

lnSuccess = loPdf.ExtractText("text",loJson,loJsonOut)
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    RELEASE loJson
    RELEASE loJsonOut
    CANCEL
ENDIF

*  The value is returned as the text.
? "Invoice Number: " + loJsonOut.StringOf("text")

*  The labelMatches array tells where the label was found and how it appeared in the PDF.
? "Found on page " + STR(loJsonOut.IntOf("labelMatches[0].page")) + ' as "' + loJsonOut.StringOf("labelMatches[0].label") + '"'

*  Matching ignores case and the trailing colon, so these all work:
loJson.UpdateString("label","CUSTOMER:")
lnSuccess = loPdf.ExtractText("text",loJson,loJsonOut)
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    RELEASE loJson
    RELEASE loJsonOut
    CANCEL
ENDIF

? "Customer: " + loJsonOut.StringOf("text")

loJson.UpdateString("label","due date")
lnSuccess = loPdf.ExtractText("text",loJson,loJsonOut)
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    RELEASE loJson
    RELEASE loJsonOut
    CANCEL
ENDIF

? "Due Date: " + loJsonOut.StringOf("text")

*  The totals at the foot of the invoice are right-aligned labels with the amount beside them.
loJson.UpdateString("label","Total Due")
lnSuccess = loPdf.ExtractText("text",loJson,loJsonOut)
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    RELEASE loJson
    RELEASE loJsonOut
    CANCEL
ENDIF

? "Total Due: " + loJsonOut.StringOf("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".
loJson.UpdateString("label","Tracking Number")
lnSuccess = loPdf.ExtractText("text",loJson,loJsonOut)
IF (lnSuccess = 0) THEN
    ? loPdf.LastErrorText
    RELEASE loPdf
    RELEASE loJson
    RELEASE loJsonOut
    CANCEL
ENDIF

IF (loJsonOut.SizeOfArray("labelMatches") = 0) THEN
    ? "Tracking Number: (not found) " + loJsonOut.StringOf("quality.pages[0].issues[0].code")
ENDIF

*  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

RELEASE loPdf
RELEASE loJson
RELEASE loJsonOut