Class HtmlOutput

append(addedContent)

Appends new content to the content of this HtmlOutput. Use this only for content from a trusted source, because it is not escaped.

 

 // Log "<b>Hello, world!</b><p>Hello again, world.</p>"
 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 output.append('<p>Hello again, world.</p>');
 Logger.log(output.getContent());
 

Parameters

Return

HtmlOutput — this HtmlOutput itself, useful for chaining

See also

• appendUntrusted(addedContent)

appendUntrusted(addedContent)

Appends new content to the content of this HtmlOutput, using contextual escaping.

This method will correctly escape content based on the current state of the HtmlOutput, so that the result will be a safe string with no markup or side affects. Use this instead of using append whenever you are adding content from an untrusted source, such as from a user, to avoid accidentally allowing a cross site scripting (XSS) bug where content or markup that you append causes unexpected code execution.

 

 // Log "<b>Hello, world!</b>&lt;p&gt;Hello again, world.&lt;/p&gt;"
 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 output.appendUntrusted('<p>Hello again, world.</p>');
 Logger.log(output.getContent());
 

Parameters

Return

HtmlOutput — this HtmlOutput itself, useful for chaining

See also

• append(addedContent)

asTemplate()

Returns an HtmlTemplate backed by this HtmlOutput. This method can be used to build up a template incrementally. Future changes to HtmlOutput will affect the contents of the HtmlTemplate as well.

 

 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 var template = output.asTemplate();
 

Return

HtmlTemplate — the new HtmlTemplate

clear()

Clears the current content.

 

 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 output.clear();
 

Return

HtmlOutput — the HtmlOutput itself, useful for chaining

getAs(contentType)

Return the data inside this object as a blob converted to the specified content type. This method adds the appropriate extension to the filename — for example, "myfile.pdf". However, it assumes that the part of the filename that follows the last period (if any) is an existing extension that should be replaced. Consequently, "ChristmasList.12.25.2014" will become "ChristmasList.12.25.pdf".

Parameters

Return

Blob — the data as a blob

getBlob()

Return the data inside this object as a blob.

Return

Blob — the data as a blob

getContent()

Gets the content of this HtmlOutput.

 

 // Log "<b>Hello, world!</b>"
 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 Logger.log(output.getContent());
 

Return

String — the content that will be served

getHeight()

Gets the initial height of the custom dialog in Google Docs, Sheets, or Forms. If the HtmlOutput is published as a web app instead, this method returns null. To resize a dialog that is already open, call google.script.host.setHeight(height) in client-side code.

 

 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 output.setHeight(200);
 Logger.log(output.getHeight());
 

Return

Integer — the height, in pixels

getTitle()

Gets the title of the output page. Note that the <title> HTML element is ignored.

 

 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 Logger.log(output.getTitle());
 

Return

String — the title of the page

getWidth()

Gets the initial width of the custom dialog or sidebar in Google Docs, Sheets, or Forms. If the HtmlOutput is published as a web app instead, this method returns null. To resize a dialog that is already open, call google.script.host.setWidth(width) in client-side code. Sidebars that are already open cannot be resized.

 

 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 output.setWidth(200);
 Logger.log(output.getWidth());
 

Return

Integer — the width in pixels

setContent(content)

Sets the content of this HtmlOutput.

 

 var output = HtmlService.createHtmlOutput();
 output.setContent('<b>Hello, world!</b>');
 

Parameters

Return

HtmlOutput — this HtmlOutput itself, useful for chaining

setHeight(height)

Sets the initial height of the custom dialog in Google Docs, Sheets, or Forms. If the HtmlOutput is published as a web app instead, this method has no effect. To resize a dialog that is already open, call google.script.host.setHeight(height) in client-side code.

 

 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 output.setHeight(200);
 

Parameters

Return

HtmlOutput — this HtmlOutput itself, useful for chaining

setSandboxMode(mode)

Sets the sandbox mode used for client-side scripts. To protect users from being served malicious HTML or JavaScript, client-side code served from HTML service executes in a security sandbox that imposes restrictions on the code. This method allows script authors to choose between different versions of the sandbox. For more information, see the guide to restrictions in HTML service.

If a script does not set a sandbox mode, Apps Script uses NATIVE mode as the default. Prior to February 2014, the default was EMULATED. The default is subject to change.

The IFRAME mode imposes many fewer restrictions than the other sandbox modes and runs fastest, but does not work at all in certain older browsers, including Internet Explorer 9. By contrast, EMULATED mode is more likely to work in older browsers that do not support ECMAScript 5 strict mode, most notably Internet Explorer 9. NATIVE mode is the middle ground. If NATIVE mode is set but not supported in the user's browser, the sandbox mode falls back to EMULATED mode for that user.

 

 // Serve HTML with a defined sandbox mode (in Apps Script server-side code).
 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 output.setSandboxMode(HtmlService.SandboxMode.IFRAME);
 

 

 <!-- Read the sandbox mode (in a client-side script). -->
 <script>
   alert(google.script.sandbox.mode);
 </script>
 

Parameters

Return

HtmlOutput — this HtmlOutput itself, useful for chaining

setTitle(title)

Sets the title of the output page. For web apps, this will be the title of the entire page, while for HtmlOutput shown in Google Sheets, this will be the dialog title.

 

 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 output.setTitle('My First Page');
 

Parameters

Return

HtmlOutput — this HtmlOutput itself, useful for chaining

setWidth(width)

Sets the initial width of a custom dialog or sidebar in Google Docs, Sheets, or Forms. If the HtmlOutput is published as a web app instead, this method has no effect. To resize a dialog that is already open, call google.script.host.setWidth(width) in client-side code. Sidebars that are already open cannot be resized.

 

 var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
 output.setWidth(200);
 

Parameters

Return

HtmlOutput — this HtmlOutput itself, useful for chaining