BCL easyPDF SDK
easyPDF SDK Usermanual
PDF Creator Programming API  |  Download Free Trial  |  Contact Us to Purchase

AddAttachment Method

Adds an attachment to a PDF file.

Sub AddAttachment(From As Long,
                  To As Long,
                  Left As Double,
                  Top As Double,
                  Attachment As String,
                  Author As String,
                  Subject As String,
                  Description As String,
                  Icon As prcAttachIcon,
                  Color As OLE_COLOR)

void AddAttachment(int From,
                   int To,
                   double Left,
                   double Top,
                   string Attachment,
                   string Author,
                   string Subject,
                   string Description,
                   prcAttachIcon Icon,
                   System.UInt32 Color)

void AddAttachment(int From,
                   int To,
                   double Left,
                   double Top,
                   String Attachment,
                   String Author,
                   String Subject,
                   String Description,
                   prcAttachIcon Icon,
                   int Color) throws PDFProcessorException

Parameters

Return Values

N/A.

Remarks

Note 1: Coordinate system information:
1. The unit size of PDF user space is 1/72 inch (1 inch = 72 PDF user space unit).
2. The location of the origin (0, 0) is at top-left corner.
3. To get page size information from a PDF file, use GetPageSize method.

The page number uses zero-based index, meaning that page number starts from 0.

Note 2: OLE_COLOR conversion from various programming languages:

C++:

static_cast<OLE_COLOR>(RGB(0, 0, 255))

VB6:

RGB(0, 0, 255)

VB.NET:

Convert.ToUInt32(System.Drawing.ColorTranslator.ToOle(Color.FromArgb(0, 0, 255))

C#: (uint)System.Drawing.ColorTranslator.ToOle(Color.FromArgb(0, 0, 255))
Others: 32 bit integer value in following format: 0x00bbggrr (in BGR format, not in RGB)

For more information about color translation, refer to MSDN Knowledge Base article Q131101.

Example Usage in VBScript

Set oProcessor = CreateObject("easyPDF.PDFProcessor.8")
Set oProcessorHandle = oProcessor.OpenFile("C:\test\input.pdf", "C:\test\output.pdf")

oProcessorHandle.AddAttachment 0, _
                               0, _
                               120, _
                               80, _
                               "C:\test\attachment.jpg", _
                               "Author", _
                               "Subject", _
                               "Description", _
                               PRC_ATTACHICON_PAPERCLIP,
                               RGB(0, 0, 255)
oProcessorHandle.Close

Example Usage in VB.NET

Dim oProcessor As PDFProcessor = New PDFProcessor


Dim oProcessorHandle As PDFProcessorHandle = oProcessor.OpenFile("C:\test\input.pdf", "C:\test\output.pdf")
   oProcessorHandle.AddAttachment(0, _
                                  0, _
                                  120, _
                                  80, _
                                  "C:\test\attachment.jpg", _
                                  "Author", _
                                  "Subject", _
                                  "Description", _
                                  prcAttachIcon.PRC_ATTACHICON_PAPERCLIP, _
                                  Convert.ToUInt32(System.Drawing.ColorTranslator.ToOle(Color.FromArgb(0, 0, 255))))
oProcessorHandle.Close()

Example Usage in C#

PDFProcessor oProcessor = new PDFProcessor();
PDFProcessorHandle oProcessorHandle = oProcessor.OpenFile(@"C:\test\input.pdf", @"C:\test\output.pdf", null);
   oProcessorHandle.AddAttachment(0,
                                  0,
                                  120,
                                  80,
                                  @"C:\test\attachment.jpg",
                                  "Author",
                                  "Subject",
                                  "Description",
                                  prcAttachIcon.PRC_ATTACHICON_PAPERCLIP,
                                  (uint)System.Drawing.ColorTranslator.ToOle(Color.FromArgb(0, 0, 255)));
oProcessorHandle.Close();