Delphi DLL

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.

Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, BinData, Pdf, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
pdf: HCkPdf;
json: HCkJsonObject;
i: Integer;
bd: HCkBinData;

begin
success := False;

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

pdf := CkPdf_Create();

// 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 := CkPdf_LoadFile(pdf,'qa_data/pdf/helloWorld.pdf');
if (success = False) then
  begin
    Memo1.Lines.Add(CkPdf__lastErrorText(pdf));
    Exit;
  end;

// 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.
json := CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,False);

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_putI(json,i);
CkJsonObject_UpdateString(json,'files[i].description','Hello World');
CkJsonObject_UpdateString(json,'files[i].localFilePath','qa_data/xml/helloWorld.xml');
i := i + 1;

// Specify the 2nd file to be attached.
CkJsonObject_putI(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');
i := i + 1;

// You can alternatively provide the file data from base64 encoded data rather than from a local file.
CkJsonObject_putI(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');
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.
CkJsonObject_putI(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.
success := CkPdf_AddEmbeddedFiles(pdf,json,'qa_output/helloWorld_withAttachments.pdf');
if (success = False) then
  begin
    Memo1.Lines.Add(CkPdf__lastErrorText(pdf));
    Exit;
  end;

// You can alternatively write the PDF file with attachments to a Chilkat BinData object..
bd := CkBinData_Create();
success := CkPdf_AddEmbeddedFilesBd(pdf,json,bd);
if (success = False) then
  begin
    Memo1.Lines.Add(CkPdf__lastErrorText(pdf));
    Exit;
  end;
// Then you can do what you want with the BinData, which contains the binary image of the PDF with attachments.

Memo1.Lines.Add('Success.');

CkPdf_Dispose(pdf);
CkJsonObject_Dispose(json);
CkBinData_Dispose(bd);

end;