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

AddPDFText Method

Adds text to a PDF file.

void AddPDFText(string InputFileName,
                string OutputFileName,
                int From,
                int To,
                double Left,
                double Top,
                string Text,
                double Size,
                prcDefaultFont Font,
                Color Color)

Sub AddPDFText(InputFileName As String, _
               OutputFileName As String, _
               From As Integer, _
               To As Integer, _
               Left As Double, _
               Top As Double, _
               Text As String, _
               Size As Double, _
               Font As prcDefaultFont, _
               Color As Color)

def AddPDFText(self,
               InputFileName,
               OutputFileName,
               From,
               To,
               Left,
               Top,
               Text,
               Size,
               Font,
               Color)
void AddPDFText(String InputFileName,
                String OutputFileName,
                int From,
                int To,
                double Left,
                double Top,
                String Text,
                double Size,
                prcDefaultFont Font,
                int Color) throws PDFProcessorException

function AddPDFText($InputFileName,
                    $OutputFileName,
                    $From,
                    $To,
                    $Left,
                    $Top,
                    $Text,
                    $Size,
                    $Font,
                    $Color) 

BclPrcResult AddPDFText(const BclPDFProcessorSettings* pSettings,
                        const wchar_t* InputFileName,
                        const wchar_t* OutputFileName,
                        int From,
                        int To,
                        double Left,
                        double Top,
                        const wchar_t* Text,
                        double Size,
                        BclPrcDefaultFont Font,
                        BclColor Color);
Sub AddPDFText(InputFileName As String, _
               OutputFileName As String, _
               From As Long, _
               To As Long, _
               Left As Double, _
               Top As Double, _
               Text As String, _
               Size As Double, _
               Font As prcDefaultFont, _
               Color As OLE_COLOR)

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 supports only basic Latin characters (ISO-8859-1).

Note 4: 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.AddPDFText "C:\test\input.pdf", _
                       "C:\test\output.pdf", _
                       0, _
                       0, _
                       30, _
                       30, _
                       "PDFText test here.", _
                       24, _
                       PRC_DEFFONT_HELVETICA, _
                       RGB(255, 0, 0)