Components for Developers
© 2000-2012, Two Pilots

PDF Library Download Features Manual Tutorials FAQ Pricing HTML2PDF-X Pilot History In the Lab

PDF Creator Pilot documentation

Download CHM version of this manual.
PDF page methods
PDFPAGE_Arc
PDFPAGE_Arc2
PDFPAGE_ArcTo
PDFPAGE_BeginText
PDFPAGE_CanvasCurrentPointX
PDFPAGE_CanvasCurrentPointY
PDFPAGE_CanvasOver
PDFPAGE_Circle
PDFPAGE_Clip
PDFPAGE_ClosePath
PDFPAGE_Comment
PDFPAGE_Concat
PDFPAGE_CurrentTextPositionX
PDFPAGE_CurrentTextPositionY
PDFPAGE_CurveTo
PDFPAGE_DrawWatermark
PDFPAGE_Ellipse
PDFPAGE_EndText
PDFPAGE_EoClip
PDFPAGE_EoFill
PDFPAGE_EoFillAndStroke
PDFPAGE_Fill
PDFPAGE_FillAndStroke
PDFPAGE_GetColorSpace
PDFPAGE_GetColorSpaceType
PDFPAGE_GetTextHeight
PDFPAGE_GetTextWidth
PDFPAGE_GetUnicodeTextHeight
PDFPAGE_GetUnicodeTextWidth
PDFPAGE_GStateRestore
PDFPAGE_GStateSave
PDFPAGE_Height
PDFPAGE_InPath
PDFPAGE_LineTo
PDFPAGE_MoveTo
PDFPAGE_NewPath
PDFPAGE_NoDash
PDFPAGE_Orientation
PDFPAGE_PageRotate
PDFPAGE_Pie
PDFPAGE_Pie2
PDFPAGE_PlayMetaFile
PDFPAGE_PlayMetaFileEx
PDFPAGE_PlayMetaFileExFromFileName
PDFPAGE_PlayMetaFileFromFileName
PDFPAGE_Rectangle
PDFPAGE_RectRotated
PDFPAGE_Resolution
PDFPAGE_Rotate
PDFPAGE_RotateText
PDFPAGE_RoundRect
PDFPAGE_Scale
PDFPAGE_SetActiveFont
PDFPAGE_SetCharacterSpacing
PDFPAGE_SetCMYKColor
PDFPAGE_SetCMYKColorFill
PDFPAGE_SetCMYKColorStroke
PDFPAGE_SetColor
PDFPAGE_SetColorFill
PDFPAGE_SetColorSpace
PDFPAGE_SetColorStroke
PDFPAGE_SetDash
PDFPAGE_SetDefaultCMYKColorSpace
PDFPAGE_SetDefaultGrayColorSpace
PDFPAGE_SetDefaultRGBColorSpace
PDFPAGE_SetFlat
PDFPAGE_SetGray
PDFPAGE_SetGrayFill
PDFPAGE_SetGrayStroke
PDFPAGE_SetHorizontalScaling
PDFPAGE_SetLineCap
PDFPAGE_SetLineJoin
PDFPAGE_SetLineWidth
PDFPAGE_SetLinkToPage
PDFPAGE_SetMiterLimit
PDFPAGE_SetPixel
PDFPAGE_SetRGBColor
PDFPAGE_SetRGBColorFill
PDFPAGE_SetRGBColorStroke
PDFPAGE_SetTextPosition
PDFPAGE_SetTextRenderingMode
PDFPAGE_SetTextRise
PDFPAGE_SetURL
PDFPAGE_SetWordSpacing
PDFPAGE_ShowImage
PDFPAGE_Size
PDFPAGE_SkewText
PDFPAGE_Stroke
PDFPAGE_TextBox
PDFPAGE_TextInitiated
PDFPAGE_TextOut
PDFPAGE_TextOutBox
PDFPAGE_TextOutBox2
PDFPAGE_TextShow
PDFPAGE_Thumbnail
PDFPAGE_Translate
PDFPAGE_UnicodeTextBox
PDFPAGE_UnicodeTextOut
PDFPAGE_UnicodeTextOutBox
PDFPAGE_UnicodeTextOutBox2
PDFPAGE_UnicodeTextShow
PDFPAGE_Watermark
PDFPAGE_Width
Collapse All

This method draws text bounded by a rectangle. If the text does not fit in the box, it is cropped. To fit text in the box using wrapping, call PDFPAGE_TextOutBox.

Syntax

HRESULT PDFPAGE_TextBox (
DOUBLE left,
DOUBLE top,
DOUBLE right,
DOUBLE bottom,
BSTR text,
TxHorJust horizontalJustification,
TxVertJust verticalJustification
)
Parameters
left
X coordinate of the top-left corner of the bounding rectangle

top
Y coordinate of the top-left corner of the bounding rectangle

right
X coordinate of the bottom-right corner of the bounding rectangle

bottom
Y coordinate of the bottom-right corner of the bounding rectangle

text
Text to be displayed.

horizontalJustification
Horizontal justification.

verticalJustification
Vertical justification.

Return value
If successful, this method returns S_OK. If it fails, this method should return one of the error values.

Remarks

This method draws a text string (using the current font) inside an area bounded by a rectangle, with (left, top) and (right, bottom) coordinates for top-left and bottom-right corners, and with the horizontal and vertical justification specified in horizontalJustification and verticalJustification parameters.

Equivalent in new interface: IPDFDocument4::ShowTextAligned.

Example

Drawing Text in a Box

Delphi
[copy to clipboard]
{ PDF object is supposed to be created }
PDF.BeginDoc;
txt := 'Text in the box.'
PDF.PDFPAGE_SetActiveFont('Helvetica', false, false, false, false, 12.0, 0);

PDF.PDFPAGE_Rectangle(100, 100, 230, 130);
PDF.PDFPAGE_Stroke;
PDF.PDFPAGE_TextBox(100, 100, 230, 130, txt, hjLeft, vjUp);

PDF.PDFPAGE_Rectangle(100, 150, 230, 180);
PDF.PDFPAGE_Stroke;
PDF.PDFPAGE_TextBox(100, 150, 230, 180, txt, hjCenter, vjCenter);

PDF.PDFPAGE_Rectangle(100, 200, 230, 230);
PDF.PDFPAGE_Stroke;
PDF.PDFPAGE_TextBox(100, 200, 230, 230, txt, hjRight, vjDown);

PDF.EndDoc;
C/C++
[copy to clipboard]
// PDF object is supposed to be created
PDF->BeginDoc();
CString txt = "Text in the box.";
PDF->PDFPAGE_SetActiveFont("Helvetica", FALSE, FALSE, FALSE, FALSE, 12.0, 0);

PDF->PDFPAGE_Rectangle(100, 100, 230, 130);
PDF->PDFPAGE_Stroke();
PDF->PDFPAGE_TextBox(100, 100, 230, 130, txt, hjLeft, vjUp);

PDF->PDFPAGE_Rectangle(100, 150, 230, 180);
PDF->PDFPAGE_Stroke();
PDF->PDFPAGE_TextBox(100, 150, 230, 180, txt, hjCenter, vjCenter);

PDF->PDFPAGE_Rectangle(100, 200, 230, 230);
PDF->PDFPAGE_Stroke();
PDF->PDFPAGE_TextBox(100, 200, 230, 230, txt, hjRight, vjDown);

PDF->EndDoc();
C#
[copy to clipboard]
' PDF object is supposed to be created
PDF.BeginDoc();
string txt = "Text in the box.";
PDF.PDFPAGE_SetActiveFont("Helvetica", false, false, false, false, 12.0, 0);

PDF.PDFPAGE_Rectangle(100, 100, 230, 130);
PDF.PDFPAGE_Stroke();
PDF.PDFPAGE_TextBox(100, 100, 230, 130, txt, TxHorJust.hjLeft, TxVertJust.vjUp);

PDF.PDFPAGE_Rectangle(100, 150, 230, 180);
PDF.PDFPAGE_Stroke();
PDF.PDFPAGE_TextBox(100, 150, 230, 180, txt, TxHorJust.hjCenter, TxVertJust.vjCenter);

PDF.PDFPAGE_Rectangle(100, 200, 230, 230);
PDF.PDFPAGE_Stroke();
PDF.PDFPAGE_TextBox(100, 200, 230, 230, txt, TxHorJust.hjRight, TxVertJust.vjDown);

PDF.EndDoc();
Visual Basic
[copy to clipboard]
' PDF object is supposed to be created
PDF.BeginDoc
txt = "Text in the box."
PDF.PDFPAGE_SetActiveFont "Helvetica", False, False, False, False, 12.0, 0

PDF.PDFPAGE_Rectangle 100, 100, 230, 130
PDF.PDFPAGE_Stroke
PDF.PDFPAGE_TextBox 100, 100, 230, 130, txt, 0, 0

PDF.PDFPAGE_Rectangle 100, 150, 230, 180
PDF.PDFPAGE_Stroke
PDF.PDFPAGE_TextBox 100, 150, 230, 180, txt, 1, 1

PDF.PDFPAGE_Rectangle 100, 200, 230, 230
PDF.PDFPAGE_Stroke
PDF.PDFPAGE_TextBox 100, 200, 230, 230, txt, 2, 2

PDF.EndDoc

See Also

PDF Library Download Features Manual Tutorials FAQ Pricing HTML2PDF-X Pilot History In the Lab

 

 

PDF Library | Virtual Printer | Converters to PDF

Support | Blog | Forum | Contacts

© 2000-2012, Two Pilots