AutoIt 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. AutoIt

Local $bSuccess = 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

$oPdf = ObjCreate("Chilkat.Pdf")
$bSuccess = $oPdf.LoadFile("qa_data/pdf/invoice_labels.pdf")
If ($bSuccess = False) Then
    ConsoleWrite($oPdf.LastErrorText & @CRLF)
    Exit
EndIf

$oJson = ObjCreate("Chilkat.JsonObject")
$oJsonOut = ObjCreate("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.
$oJson.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.)
$oJson.UpdateString("labelValue","right")

$bSuccess = $oPdf.ExtractText("text",$oJson,$oJsonOut)
If ($bSuccess = False) Then
    ConsoleWrite($oPdf.LastErrorText & @CRLF)
    Exit
EndIf

;  The value is returned as the text.
ConsoleWrite("Invoice Number: " & $oJsonOut.StringOf("text") & @CRLF)

;  The labelMatches array tells where the label was found and how it appeared in the PDF.
ConsoleWrite("Found on page " & $oJsonOut.IntOf("labelMatches[0].page") & " as """ & $oJsonOut.StringOf("labelMatches[0].label") & """" & @CRLF)

;  Matching ignores case and the trailing colon, so these all work:
$oJson.UpdateString("label","CUSTOMER:")
$bSuccess = $oPdf.ExtractText("text",$oJson,$oJsonOut)
If ($bSuccess = False) Then
    ConsoleWrite($oPdf.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("Customer: " & $oJsonOut.StringOf("text") & @CRLF)

$oJson.UpdateString("label","due date")
$bSuccess = $oPdf.ExtractText("text",$oJson,$oJsonOut)
If ($bSuccess = False) Then
    ConsoleWrite($oPdf.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("Due Date: " & $oJsonOut.StringOf("text") & @CRLF)

;  The totals at the foot of the invoice are right-aligned labels with the amount beside them.
$oJson.UpdateString("label","Total Due")
$bSuccess = $oPdf.ExtractText("text",$oJson,$oJsonOut)
If ($bSuccess = False) Then
    ConsoleWrite($oPdf.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("Total Due: " & $oJsonOut.StringOf("text") & @CRLF)

;  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".
$oJson.UpdateString("label","Tracking Number")
$bSuccess = $oPdf.ExtractText("text",$oJson,$oJsonOut)
If ($bSuccess = False) Then
    ConsoleWrite($oPdf.LastErrorText & @CRLF)
    Exit
EndIf

If ($oJsonOut.SizeOfArray("labelMatches") = 0) Then
    ConsoleWrite("Tracking Number: (not found) " & $oJsonOut.StringOf("quality.pages[0].issues[0].code") & @CRLF)
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