Class HtmlTemplate  |  Apps Script  |  Google for Developers (original) (raw)

Class HtmlTemplate

Stay organized with collections Save and categorize content based on your preferences.

HtmlTemplate

A template object for dynamically constructing HTML. For more information, see the guide to templates.

Methods

Detailed documentation

evaluate()

Evaluates this template and returns an [HtmlOutput](/apps-script/reference/html/html-output) object. Any properties set on thisHtmlTemplate object will be in scope when evaluating. To debug errors in a template, examine the code using the [getCode()](#getCode%28%29) method.

// A template which evaluates to whatever is bound to 'foo'. const template = HtmlService.createTemplate(''); template.foo = 'Hello World!'; Logger.log(template.evaluate().getContent()); // will log 'Hello World!'

Return

[HtmlOutput](/apps-script/reference/html/html-output) — an HtmlOutput object

getCode()

Generates a string of JavaScript code, based on the template file, that can be evaluated. This method produces a string of JavaScript code based on the template file. Calling eval(<code>) will return a new [HtmlOutput](/apps-script/reference/html/html-output) object with the content of the template after running all embedded server scripts. The generated code is intended to be human-readable, and so if you need to debug a template you can call Logger.log(<code>) to see what was produced.

Evaluating this code will implicitly bind in all variables in the current scope. In general, it's preferable to use the [evaluate()](#evaluate%28%29) method, which takes explicit bindings.

const template = HtmlService.createTemplate( 'The time is <?= new Date() ?>', ); Logger.log(template.getCode());

Return

String — a string based on the template, which can be evaluated

getRawContent()

Returns the unprocessed content of this template.

const template = HtmlService.createTemplate( 'The time is <?= new Date() ?>', ); Logger.log(template.getRawContent());

Return

String — the template's raw content

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-03 UTC.