Swift

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.

Swift

func chilkatTest() {
    var success: Bool = false

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let pdf = CkoPdf()!

    // 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.
    success = pdf.loadFile(filePath: "qa_data/pdf/helloWorld.pdf")
    if success == false {
        print("\(pdf.lastErrorText!)")
        return
    }

    // 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.
    let json = CkoJsonObject()!
    json.emitCompact = false

    var i: Int = 0

    // We can attach multiple files in one operation.

    // Here we specify the local relative file path of the 1st file to be embedded.
    json.i = i
    json.updateString(jsonPath: "files[i].description", value: "Hello World")
    json.updateString(jsonPath: "files[i].localFilePath", value: "qa_data/xml/helloWorld.xml")
    i = i + 1

    // Specify the 2nd file to be attached.
    json.i = i
    json.updateString(jsonPath: "files[i].description", value: "Image of starfish")
    json.updateString(jsonPath: "files[i].localFilePath", value: "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.
    json.updateString(jsonPath: "files[i].subType", value: "image/jpeg")
    i = i + 1

    // You can alternatively provide the file data from base64 encoded data rather than from a local file.
    json.i = i
    json.updateString(jsonPath: "files[i].description", value: "Hello World from Data")
    json.updateString(jsonPath: "files[i].fileData", value: "SGVsbG8gV29ybGQsIEhlbGxvIFdvcmxkLCBIZWxsbyBXb3JsZCwgSGVsbG8gV29ybGQsIEhlbGxvIFdvcmxk")
    json.updateString(jsonPath: "files[i].embeddedFilename", value: "abc.txt")
    i = 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.
    json.i = i
    json.updateString(jsonPath: "files[i].description", value: "Invoice")
    json.updateString(jsonPath: "files[i].localFilePath", value: "qa_data/xml/invoice.xml")
    json.updateString(jsonPath: "files[i].embeddedFilename", value: "invoice_1234.xml")
    json.updateString(jsonPath: "files[i].subType", value: "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.
    success = pdf.addEmbeddedFiles(json: json, outFilePath: "qa_output/helloWorld_withAttachments.pdf")
    if success == false {
        print("\(pdf.lastErrorText!)")
        return
    }

    // You can alternatively write the PDF file with attachments to a Chilkat BinData object..
    let bd = CkoBinData()!
    success = pdf.addEmbeddedFilesBd(json: json, bd: bd)
    if success == false {
        print("\(pdf.lastErrorText!)")
        return
    }

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

    print("Success.")

}