API referenceCore SDK

pdfBeginTemplate

Begin capturing content into a new reusable template (Form

C
int32_t __stdcall pdfBeginTemplate(PPDF IPDF, double Width, double Height);
int32_t __stdcall pdfBeginTemplateEx(PPDF IPDF, TPDFRect* BBox, TCTM* Matrix);
Delphi
function pdfBeginTemplate(const IPDF: PPDF; Width, Height: Double): Integer; stdcall;
function pdfBeginTemplateEx(const IPDF: PPDF; BBox: PPDFRect; Matrix: PCTM): Integer; stdcall;

Purpose. Begin capturing content into a new reusable template (Form XObject) — pdfBeginTemplate sizes it from the origin ([0,0,Width,Height]); pdfBeginTemplateEx supplies a full bounding box (with a non-zero origin supported) plus an initial content-space transform matrix.

Return value. The new template's handle; 0 if IPDF is invalid.

See also. pdfEndTemplate, pdfPlaceTemplate.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfBeginTemplate(IntPtr IPDF, double Width, double Height);
Area
Core SDK
Category

Core

Exported names

pdfBeginTemplate

String variants

The …A form takes UTF-8, …W takes UTF-16; a bare name aliases the ANSI form.

See working code

Worked examples — complete programs in ten languages.