Some test text!

Loading...
Guides
Overview

Document Generation via Template on Cross-Platform (Core)

Overview

PDFTron's office template generation framework enables the dynamic generation of PDFs:

  • You provide a template in the form of an Office document (such as .docx)
  • You provide replacement data in JSON form
  • PDFTron SDK will efficiently generate a PDF by merging the data with the template
  • Fully featured, with support for loops, conditionals, images, table generation, etc.
  • Use your preferred office editor to design attractive templates, and PDFTron will take care of the rest
  • All logic is entirely contained within the SDK, with no external dependencies

Launch Online Demo

Easy to use

The generation framework requires minimal code to get up and running. Simply initiate a normal Office conversion, but with the optional TemplateParamsJson parameter set:

// Start with a PDFDoc (the conversion destination)
PDFDoc doc = new PDFDoc();

// create an options object and add your template
// replacement values to it. If this option is not
// set, the document will convert as if it is a normal
// office documents, with no template generation.
OfficeToPDFOptions options = new OfficeToPDFOptions();
options.SetTemplateParamsJson(json_data_string);

// perform the conversion with the template replacement data
Convert.OfficeToPDF(doc, input_path, options);
doc.Save(output_path, SDFDoc.SaveOptions.e_linearized);

Sample Code API Docs Template Specification

Examples

The following are a series of real examples, generated using the code above. For each example, the template source and the json data source are included below, so that you can try them out yourself.

Simple text replacement (.docx, .json)

Tags in the template document are replaced with a string from the supplied JSON. To control the style of the text, simply modify the style of the template tag as desired:

{
	"short_text": "Lorem ipsum dolor, .etc"
}

Automatic reflow (.docx, .json)

Text reflows according to the rules set in the original template file, and will automatically generate extra pages if needed. Make use of column layouts and justification rules. This example uses a list loop with dynamic item renumbering.

{
	"legal_heading":"End-User Agreement",
	"legal_clauses": [
		{"legal_clause":"Sed ut unde omnis iste natus error sit volup tatem..."},
		{"legal_clause":"Lorem ipsum dolor sit amet, consec  tetuer adipi s..."},
		{"legal_clause":"pretium quis, sem. Nulla conse quat massa quis eni..."},
		{"legal_clause":"idunt. Cras dapibus. Vivamus elem entum semper nis..."}
	]
}

Dynamic tables (.docx, .json)

Dynamically insert or remove rows into tables using loops and conditionals. Table formatting such as row bands are updated. Especially useful for invoice generation.

{
	"items": [
		{"item": "Wireless", "charge": "$42.34"},
		{"item": "Long Distance", "charge": "$12.55"},
		{"item": "Data", "charge": "$14.89"}
	],
	"balance":"$12.52",
	"total_due":"$82.30",
}

Insert images (.docx, .json)

Insert images into the text at any location using the image_url value specifier. Images can be resized as desired, and inserted at any position in the original document.

{
	"logo":{"image_url":"./logo_red.png", "width":40, "height":40}
}

Reflow around figures (.docx, .json)

Automatically flow text around obstacles according to the template.

{
	"long_text": "Sed ut perspiciatis unde omnis iste natus..."
}

PDFTron benefits

  • Securely merge data directly in your application. No need to share confidential data with anyone!
  • Use familiar tools (any word processor such as MS Word or Google Docs) to design professional looking templates with no plugins or extra tools required
  • Top quality PDF generation of your templates with the market leading PDFTron SDK
  • Self-contained, with no third-party dependencies
  • Generated PDFs have automatically generated accessibility tags

Further Reading

For more information, see the following resources:

Detailed specification of the template generation data model
To find out more details about the specification about the data model

Advanced features
For a specification of advanced features, and greater detail on behavior

Live Web Sample
To try a live sample of template filling using our WebViewer

Get the answers you need: Support

Upcoming Webinar: SDK Features Preview and Live Run-Through | July 14, 2022 at 11 am PT

PDFTron SDK

The Platform

NEW

© 2022 PDFTron Systems Inc. All rights reserved.

Privacy

Terms of Use