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

AddNote Method

Adds a note to a PDF file.

Sub AddNote(From As Long,
            To As Long,
            Left As Double,
            Top As Double,
            Text As String,
            Author As String,
            Subject As String,
            Icon As prcNoteIcon,
            Color As OLE_COLOR,
            Opened As Boolean)

void AddNote(int From,
             int To,
             double Left,
             double Top,
             string Text,
             string Author,
             string Subject,
             prcNoteIcon Icon,
             System.UInt32 Color,
             bool Opened)

void AddNote(int From,
             int To,
             double Left,
             double Top,
             String Text,
             String Author,
             String Subject,
             prcNoteIcon Icon,
             int Color,
             boolean Opened) 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.AddNote 0, _
                         0, _
                         100, _
                         80, _
                         "Note text here." + vbCR + vbCR + "Line break with CR is allowed", _
                         "Author", _
                         "Subject", _
                         PRC_NOTEICON_NOTE,
                         RGB(255, 255, 0),
                         False
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.AddNote(0, _
                            0, _
                            100, _
                            80, _
                            "Note text here." + vbCR + vbCR + "Line break with CR is allowed", _
                            "Author", _
                            "Subject", _
                            prcNoteIcon.PRC_NOTEICON_NOTE, _
                            Convert.ToUInt32(System.Drawing.ColorTranslator.ToOle(Color.FromArgb(255, 255, 0))), _
                            False)
oProcessorHandle.Close

Example Usage in C#

PDFProcessor oProcessor = new PDFProcessor();
PDFProcessorHandle oProcessorHandle = oProcessor.OpenFile(@"C:\test\input.pdf", @"C:\test\output.pdf", null);
   oProcessorHandle.AddNote(0,
                            0, 
                            100, 
                            80, 
                            "Note text here.\r\rLine break is allowed", 
                            "Author", 
                            "Subject", 
                            prcNoteIcon.PRC_NOTEICON_NOTE, 
                            (uint)System.Drawing.ColorTranslator.ToOle(Color.FromArgb(255, 255, 0)), 
                            false);
oProcessorHandle.Close();