text_box

Summary

Inserts text at a specified location.

Usage

pdf( text_box, hash( text, text
                     x,     x_offset,
                     y,     y_offset,
                     width, total width,
                   [ align, text_alignment, ]
                   [ size,  text_size       ] ) )

Parameters

Name	Type	Description	Required
text	string	The text that should be inserted into the box.	Yes.
x	float	X coordinate of the text box.	Yes.
y	float	Y coordinate of the text box.	Yes.
width	float	The width of the text box.	Yes.
align	string	The alignment of the text.	No.
size	float	The font size.	No.

Description

This function creates a text box at the specified place on the current page. The font properties (type, size, and color) are not affected by the "set_font" function.

If the text box is positioned before any other content, the content will flow nicely over and under the text box. If other content is present before the text box is added, the text box will overlap it.

Examples

Example 1

{pdf( 'text_box',  hash( 'text', 'This text appears in a text box.'|wash( 'pdf' ),
                         'x', 250,
                         'y', 400,
                         'width', 30) )}

Path

Table of contents