Xojo Plugin Requires Chilkat v11.7.0+

Clipped, Off-Page and White-on-White Text in PDF Extraction

See more PDF Text Extraction Examples

Demonstrates the "clippedText", "offPageText" and "obscuredText" filters. Text that a reader never sees - hidden by a clipping path, outside the crop box, or drawn in the same color as the box beneath it - is excluded by default, and the quality report notes what was skipped. Each kind can be included. Xojo Plugin

Dim success As Boolean
success = False

//  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 hidden_text.pdf

Dim pdf As New Chilkat.Pdf
success = pdf.LoadFile("qa_data/pdf/hidden_text.pdf")
If (success = False) Then
    System.DebugLog(pdf.LastErrorText)
    Return
End If

Dim json As New Chilkat.JsonObject
Dim jsonOut As New Chilkat.JsonObject

//  The page has a visible paragraph plus three hidden lines: one drawn outside its clipping
//  rectangle, one below the crop box, and one in white on a white box.
success = pdf.ExtractText("text",json,jsonOut)
If (success = False) Then
    System.DebugLog(pdf.LastErrorText)
    Return
End If

System.DebugLog("---- default ----")
System.DebugLog(jsonOut.StringOf("text"))

//  The quality report says what was left out.
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jsonOut.SizeOfArray("quality.pages[0].issues")
While i < count_i
    jsonOut.I = i
    System.DebugLog("issue: " + jsonOut.StringOf("quality.pages[0].issues[i].code"))
    i = i + 1
Wend

//  Include everything.
success = json.UpdateString("clippedText","include")
success = json.UpdateString("offPageText","include")
success = json.UpdateString("obscuredText","include")
success = pdf.ExtractText("text",json,jsonOut)
If (success = False) Then
    System.DebugLog(pdf.LastErrorText)
    Return
End If

System.DebugLog("---- clippedText, offPageText, obscuredText: include ----")
System.DebugLog(jsonOut.StringOf("text"))

//  Sample output:

//  ---- default ----
//  Visible Text
//  
//  This paragraph is visible. The page also carries three kinds of text a reader never sees.
//  
//  End of the visible text.
//  issue: obscuredTextSkipped
//  issue: clippedTextSkipped
//  ---- clippedText, offPageText, obscuredText: include ----
//  Visible Text
//  
//  This paragraph is visible. The page also carries three kinds of text a reader never sees.
//  
//  CLIPPED: this line is drawn outside its clipping rectangle.
//  
//  OBSCURED: this line is white on a white box.
//  
//  End of the visible text.
//  
//  OFFPAGE: this line sits below the crop box.