Skip to contents

Create a new text page-object on a page

Source: R/obj_creators.R
pdf_text_new.Rd

Wraps FPDFPageObj_NewTextObj (when font is a standard-font name) or FPDFPageObj_CreateTextObj (when font is a custom pdfium_font handle from pdf_font_load_standard() / pdf_font_load()). Either path is followed by an optional FPDFText_SetText, FPDFPageObj_Transform, and FPDFPage_InsertObject.

Usage

pdf_text_new(page, text, font = "Helvetica", font_size = 12, x = 0, y = 0)

Arguments

page

A pdfium_page from pdf_page_load(). Parent doc must be readwrite.

text

Character scalar — the text content. Pass "" to create an empty text object you'll populate later via pdf_text_set_content().

font

Either a character scalar — one of the 14 PDF standard font names (see pdf_font_load_standard() for the list) — or a pdfium_font handle from pdf_font_load_standard() or pdf_font_load(). Default "Helvetica". Pass a pdfium_font handle when you need a custom TrueType / Type1 font; the standard-font shortcut is purely for convenience.

font_size

Numeric scalar — font size in points. Default 12.

x, y

Numeric scalars — baseline position in PDF user-space points. Default 0, 0.

Value

The new pdfium_obj (type "text"), inserted on the page.

See also

pdf_text_set_content(), pdf_text_set_render_mode(), pdf_obj_set_matrix(), pdf_font_load_standard(), pdf_font_load().