Ruby Requires Chilkat v11.7.0+

Why a PDF Optimization Was Skipped

See more PDF Optimization Examples

Demonstrates the "skipped" array, which lists the options that were asked for but not applied, each with a reason and, where it is page-specific, the pages. An option is skipped when it is reserved for a later release (mergeFontSubsets, compactType1Fonts), when the rules of the file forbid it (objectStreams in a PDF/A-1 file), or when the content could not be parsed safely (tidyContent and coalesceContent on a page whose content stream the parser does not understand). Nothing is ever changed on a guess: an option that cannot be applied safely is skipped and reported. Ruby

require 'chilkat'

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 grand_canyon_hiking_guide.pdf

pdf = Chilkat::CkPdf.new()
success = pdf.LoadFile("qa_data/pdf/grand_canyon_hiking_guide.pdf")
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

#  Ask for the two options that are reserved for a later release.
json = Chilkat::CkJsonObject.new()
json.UpdateBool("mergeFontSubsets",true)
json.UpdateBool("compactType1Fonts",true)

jsonOut = Chilkat::CkJsonObject.new()
success = pdf.Optimize("audit",json,jsonOut)
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

i = 0
numSkipped = jsonOut.SizeOfArray("skipped")
print "skipped: " + numSkipped.to_s() + "\n";
while i < numSkipped
    jsonOut.put_I(i)
    print "   " + jsonOut.stringOf("skipped[i].option") + " - " + jsonOut.stringOf("skipped[i].reason") + "\n";
    i = i + 1
end

#  A skipped option is not a failure: Optimize returns true, the other options are applied, and the
#  report says exactly what was left undone.