Tcl Requires Chilkat v11.7.0+

Exclude Rotated Margin Text from PDF Extraction

See more PDF Text Extraction Examples

Demonstrates the "rotatedText" filter. Text that is not aligned with the page, such as a vertical "CONFIDENTIAL" label in the margin, is included by default (after the upright text) and flagged in the quality report; "exclude" leaves it out. Tcl

load ./chilkat.dll

set success 0

#  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 rotated_margin.pdf

set pdf [new_CkPdf]

set success [CkPdf_LoadFile $pdf "qa_data/pdf/rotated_margin.pdf"]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    exit
}

set json [new_CkJsonObject]

set jsonOut [new_CkJsonObject]

#  The page has a paragraph and, rotated 90 degrees along the left margin, "CONFIDENTIAL - DRAFT - NOT FOR DISTRIBUTION".
set success [CkPdf_ExtractText $pdf "text" $json $jsonOut]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonOut
    exit
}

puts "---- default (rotated text included) ----"
puts [CkJsonObject_stringOf $jsonOut text]
puts "issue: [CkJsonObject_stringOf $jsonOut {quality.pages[0].issues[0].code}]"

CkJsonObject_UpdateString $json "rotatedText" "exclude"
set success [CkPdf_ExtractText $pdf "text" $json $jsonOut]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonOut
    exit
}

puts "---- rotatedText: exclude ----"
puts [CkJsonObject_stringOf $jsonOut text]

#  Sample output:

#  ---- default (rotated text included) ----
#  Restoration Budget Summary
#  
#  Spending for the season came in slightly under the approved budget, largely because the parapet work took less time than expected. The lens loan carries no fee, but the society is responsible for insurance and for the specialist cleaning.
#  
#  CONFIDENTIAL - DRAFT - NOT FOR DISTRIBUTION
#  issue: rotatedText
#  ---- rotatedText: exclude ----
#  Restoration Budget Summary
#  
#  Spending for the season came in slightly under the approved budget, largely because the parapet work took less time than expected. The lens loan carries no fee, but the society is responsible for insurance and for the specialist cleaning.

delete_CkPdf $pdf
delete_CkJsonObject $json
delete_CkJsonObject $jsonOut