Ruby Requires Chilkat v11.7.0+

Remove a Watermark from a PDF

See more PDF Watermark Examples

Demonstrates remove, which deletes the watermarks matching the filter and reports how many went. The filter is the same one list takes, so the usual sequence is to list what is there and then remove by id, by source, or by text. An empty filter is refused unless "all" is true, so that a whole document cannot be stripped by an empty JSON object. Removing finds nothing is not an error: "removed" is simply 0. An annotation is deleted, the marked content of an artifact and any form it alone used are deleted, and the content of a layer goes with the layer once nothing else uses it. A watermark added with the content approach is part of the page and is never removable. 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 acrobat_watermark.pdf

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

filter = Chilkat::CkJsonObject.new()
jsonOut = Chilkat::CkJsonObject.new()

#  What is in there?  A watermark from another producer is given an id of the form ext1, ext2, ...
success = pdf.Watermark("list",filter,jsonOut)
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

print "watermarks: " + jsonOut.IntOf("count").to_s() + "\n";
jsonOut.put_I(0)
print "first id: " + jsonOut.stringOf("watermarks[i].id") + " text: " + jsonOut.stringOf("watermarks[i].text") + "\n";

#  Add one of our own beside it, so that the filters below have two to choose between.
json = Chilkat::CkJsonObject.new()
json.UpdateString("type","text")
json.UpdateString("text","SUPERSEDED")
json.UpdateString("id","superseded")
success = pdf.Watermark("add",json,jsonOut)
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

#  Remove only what Acrobat put there, leaving ours in place.
filter.UpdateString("source","acrobat")
success = pdf.Watermark("remove",filter,jsonOut)
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

print "removed (acrobat): " + jsonOut.IntOf("removed").to_s() + "\n";

empty = Chilkat::CkJsonObject.new()
success = pdf.Watermark("detect",empty,jsonOut)
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

print "left in the document: " + jsonOut.IntOf("count").to_s() + "\n";

#  An empty filter is refused for remove: say all explicitly to strip everything.
success = pdf.Watermark("remove",empty,jsonOut)
if (success == false)
    print "An empty filter was refused, as it should be." + "\n";
end

empty.UpdateBool("all",true)
success = pdf.Watermark("remove",empty,jsonOut)
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

print "removed (all): " + jsonOut.IntOf("removed").to_s() + "\n";

#  The changes are in memory until the file is written.
success = pdf.WriteFile("qa_output/acrobat_unwatermarked.pdf")
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

#  Sample output:

#  watermarks: 1
#  first id: ext1 text: Sample
#  removed (acrobat): 1
#  left in the document: 1
#  An empty filter was refused, as it should be.
#  removed (all): 1