Class HtmlTemplate Stay organized with collections Save and categorize content based on your preferences.
A template object for dynamically constructing HTML. For more information, see theguide to templates.
Methods
Method | Return type | Brief description |
---|---|---|
evaluate() | Html | Evaluates this template and returns anHtml object. |
get | String | Generates a string of JavaScript code, based on the template file, that can be evaluated. |
get | String | Generates a string of JavaScript code that can be evaluated, with each line of the codecontaining the original line from the template as a comment. |
get | String | Returns the unprocessed content of this template. |
Detailed documentation
evaluate()
Evaluates this template and returns anHtml
object. Any properties set on thisHtml
object will be in scope when evaluating. To debug errors in a template,examine the code using theget
method.
// A template which evaluates to whatever is bound to 'foo'.consttemplate=HtmlService.createTemplate('<?= foo ?>');template.foo='Hello World!';Logger.log(template.evaluate().getContent());// will log 'Hello World!'
Return
Html
— an HtmlOutput object
getCode()
Generates a string of JavaScript code, based on the template file, that can be evaluated. Thismethod produces a string of JavaScript code based on the template file. Callingeval(<code>)
will return a newHtml
object with the content of thetemplate after running all embedded server scripts. The generated code is intended to behuman-readable, and so if you need to debug a template you can callLogger.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 theevaluate()
method, which takes explicit bindings.
consttemplate=HtmlService.createTemplate('<b>The time is <?= new Date() ?></b>',);Logger.log(template.getCode());
Return
String
— a string based on the template, which can be evaluated
getCodeWithComments()
Generates a string of JavaScript code that can be evaluated, with each line of the codecontaining the original line from the template as a comment. This method produces a string ofJavaScript code based on the template file. Callingeval(<code>)
will returna newHtml
object with the content of the template after running all embeddedserver scripts. The generated code is intended to be human-readable, and so if you need todebug a template you can callLogger.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 theevaluate()
method, which takes explicit bindings.
consttemplate=HtmlService.createTemplate('<b>The time is <?= new Date() ?></b>',);Logger.log(template.getCodeWithComments());
Return
String
— an string based on the template, which can be evaluated
getRawContent()
Returns the unprocessed content of this template.
consttemplate=HtmlService.createTemplate('<b>The time is <?= new Date() ?></b>',);Logger.log(template.getRawContent());
Return
String
— the template's raw content
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.