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

AddFreeText Method

Adds text annotation to a PDF file.

Sub AddFreeText(InputFileName As String,
                OutputFileName As String,
                From As Long,
                To As Long,
                Left As Double,
                Top As Double,
                Text As String,
                Author As String,
                Subject As String,
                Size As Double,
                Font As prcDefaultFont,
                Color As OLE_COLOR)

void AddFreeText(string InputFileName,
                 string OutputFileName,
                 int From,
                 int To,
                 double Left,
                 double Top,
                 string Text,
                 string Author,
                 string Subject,
                 double Size,
                 prcDefaultFont Font,
                 System.UInt32 Color)

void AddFreeText(String InputFileName,
                 String OutputFileName,
                 int From,
                 int To,
                 double Left,
                 double Top,
                 String Text,
                 String Author,
                 String Subject,
                 double Size,
                 prcDefaultFont Font,
                 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.

Note 3: This method adds text to a PDF file. Although the added text will be directly displayed to the screen just like the rest of the text, and the text is searchable under Adobe Reader, this is not inserted as part of the real text content, but rather inserted as a type of annotation. If you need to add text as part of the real text content, use the AddPDFText method instead.

Note 4: This method supports only basic Latin characters (ISO-8859-1).

Note 5: You can insert page number by using "%p" (current page) and "%P" (total page). Example: "Page %p of %P".

Example Usage

Set oProcessor = CreateObject("easyPDF.PDFProcessor.8")
 
oProcessor.AddFreeText "C:\test\input.pdf", _
                       "C:\test\output.pdf", _
                       0, _
                       0, _
                       10, _
                       10, _
                       "FreeText test here.", _
                       "Author", _
                       "Subject", _
                       24, _
                       PRC_DEFFONT_HELVETICA, _
                       RGB(0, 0, 255)