Tcl

Add File Attachments to a PDF

See more PDF Signatures Examples

Demonstrates how to attach files to a PDF. This is also known as embedding a file within a PDF.

Note: This example requires Chilkat v9.5.0.97 or greater.

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.

set pdf [new_CkPdf]

# We'll be adding attachments to this PDF file..
# Note: We are loading the PDF file into memory.  The PDF file is not kept open at this point.
set success [CkPdf_LoadFile $pdf "qa_data/pdf/helloWorld.pdf"]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    exit
}

# Note: The ability to attach files to a PDF was added in Chilkat v9.5.0.97

# Build JSON to provide information about the files to be embedded in the PDF.
set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0

set i 0

# We can attach multiple files in one operation.

# Here we specify the local relative file path of the 1st file to be embedded.
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "files[i].description" "Hello World"
CkJsonObject_UpdateString $json "files[i].localFilePath" "qa_data/xml/helloWorld.xml"
set i [expr $i + 1]

# Specify the 2nd file to be attached.
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "files[i].description" "Image of starfish"
CkJsonObject_UpdateString $json "files[i].localFilePath" "qa_data/jpg/starfish.jpg"
# You can explicitly specify the subType (i.e. MIME type) of the file.
# Otherwise Chilkat will use the default MIME type based on the filename extension.
# If no default MIME type exists, then "application/octet-stream" is used.
CkJsonObject_UpdateString $json "files[i].subType" "image/jpeg"
set i [expr $i + 1]

# You can alternatively provide the file data from base64 encoded data rather than from a local file.
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "files[i].description" "Hello World from Data"
CkJsonObject_UpdateString $json "files[i].fileData" "SGVsbG8gV29ybGQsIEhlbGxvIFdvcmxkLCBIZWxsbyBXb3JsZCwgSGVsbG8gV29ybGQsIEhlbGxvIFdvcmxk"
CkJsonObject_UpdateString $json "files[i].embeddedFilename" "abc.txt"
set i [expr $i + 1]

# By default, the filename used within the PDF is the filename part of the local file path.
# You can change it by specifying the embeddedFilename.
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "files[i].description" "Invoice"
CkJsonObject_UpdateString $json "files[i].localFilePath" "qa_data/xml/invoice.xml"
CkJsonObject_UpdateString $json "files[i].embeddedFilename" "invoice_1234.xml"
CkJsonObject_UpdateString $json "files[i].subType" "application/xml"

# The above JSON provides instructions for attaching 4 files to the PDF.
# Let's attach the files..
# It is perfectly acceptable to write over the PDF file that was loaded,
# but in this example we'll write the PDF with attachments to a new PDF file.
set success [CkPdf_AddEmbeddedFiles $pdf $json "qa_output/helloWorld_withAttachments.pdf"]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    exit
}

# You can alternatively write the PDF file with attachments to a Chilkat BinData object..
set bd [new_CkBinData]

set success [CkPdf_AddEmbeddedFilesBd $pdf $json $bd]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkBinData $bd
    exit
}

# Then you can do what you want with the BinData, which contains the binary image of the PDF with attachments.

puts "Success."

delete_CkPdf $pdf
delete_CkJsonObject $json
delete_CkBinData $bd