HTML
This service allows Apps Script applications to return HTML, usually as a user interface. If you're new to using this class, we recommend you also see the guide to Html Service
.Classes
Name | Brief description |
---|---|
HtmlOutput
|
An HtmlOutput
object that can be served from a script. |
HtmlOutputMetaTag
|
An object that represents a meta tag added to the page by calling HtmlOutput.addMetaTag(name, content)
. |
HtmlService
|
Service for returning HTML and other text content from a script. |
HtmlTemplate
|
A template object for dynamically constructing HTML. |
SandboxMode
|
An enum representing the sandbox modes that can be used for client-side HtmlService
scripts. |
XFrameOptionsMode
|
An enum representing the X-Frame-Options
modes that can be used for client-side HtmlService
scripts. |
HtmlOutput
Methods
Method | Return type | Brief description |
---|---|---|
HtmlOutput
|
Adds a meta tag to the page. | |
HtmlOutput
|
Appends new content to the content of this HtmlOutput
. |
|
HtmlOutput
|
Appends new content to the content of this HtmlOutput
, using contextual escaping. |
|
HtmlTemplate
|
Returns an HtmlTemplate
backed by this HtmlOutput
. |
|
HtmlOutput
|
Clears the current content. | |
Blob
|
Return the data inside this object as a blob converted to the specified content type. | |
Blob
|
Return the data inside this object as a blob. | |
String
|
Gets the content of this HtmlOutput
. |
|
String
|
Gets the URL for a favicon link tag added to the page by calling setFaviconUrl(iconUrl)
. |
|
Integer
|
Gets the initial height of the custom dialog in Google Docs, Sheets, or Forms. | |
HtmlOutputMetaTag[]
|
Gets an array of objects that represent meta tags added to the page by calling addMetaTag(name, content)
. |
|
String
|
Gets the title of the output page. | |
Integer
|
Gets the initial width of the custom dialog in Google Docs, Sheets, or Forms. | |
HtmlOutput
|
Sets the content of this HtmlOutput
. |
|
HtmlOutput
|
Adds a link tag for a favicon to the page. | |
HtmlOutput
|
Sets the initial height of the custom dialog in Google Docs, Sheets, or Forms. | |
HtmlOutput
|
This method now has no effect — previously it set the sandbox
mode
used for client-side scripts. |
|
HtmlOutput
|
Sets the title of the output page. | |
HtmlOutput
|
Sets the initial width of a custom dialog in Google Docs, Sheets, or Forms. | |
HtmlOutput
|
Sets the state of the page's X-Frame-Options
header, which controls clickjacking
prevention. |
HtmlOutputMetaTag
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Gets the content of this meta tag. | |
String
|
Gets the name of this HtmlOutputMetaTag
. |
HtmlService
Properties
Property | Type | Description |
---|---|---|
SandboxMode
|
SandboxMode
|
An enum representing the sandbox modes that can be used for client-side HtmlService
scripts. |
XFrameOptionsMode
|
XFrameOptionsMode
|
An enum representing the X-Frame-Options
modes that can be used for client-side HtmlService
scripts. |
Methods
Method | Return type | Brief description |
---|---|---|
HtmlOutput
|
Creates a new HtmlOutput
object that can be returned from the script. |
|
HtmlOutput
|
Creates a new HtmlOutput
object from a BlobSource
resource. |
|
HtmlOutput
|
Creates a new HtmlOutput
object that can be returned from the script. |
|
HtmlOutput
|
Creates a new HtmlOutput
object from a file in the code editor. |
|
HtmlTemplate
|
Creates a new HtmlTemplate
object from a BlobSource
resource. |
|
HtmlTemplate
|
Creates a new HtmlTemplate
object that can be returned from the script. |
|
HtmlTemplate
|
Creates a new HtmlTemplate
object from a file in the code editor. |
|
String
|
Gets the user-agent string for the current browser. |
HtmlTemplate
Methods
Method | Return type | Brief description |
---|---|---|
HtmlOutput
|
Evaluates this template and returns an HtmlOutput
object. |
|
String
|
Generates a string of JavaScript code, based on the template file, that can be evaluated. | |
String
|
Generates a string of JavaScript code that can be evaluated, with each line of the code containing the original line from the template as a comment. | |
String
|
Returns the unprocessed content of this template. |
SandboxMode
Properties
Property | Type | Description |
---|---|---|
EMULATED
|
Enum
|
A legacy sandbox mode that emulates ECMAScript 5 strict mode using only the features available in ECMAScript 3. |
IFRAME
|
Enum
|
A sandbox mode that uses iframe sandboxing instead of the Caja sandbox technology used by the EMULATED
and NATIVE
modes. |
NATIVE
|
Enum
|
A sandbox mode that is built on top of ECMAScript 5 strict mode. |
XFrameOptionsMode
Properties
Property | Type | Description |
---|---|---|
ALLOWALL
|
Enum
|
No X-Frame-Options
header will be set. |
DEFAULT
|
Enum
|
Sets the default value for the X-Frame-Options
header, which preserves normal security
assumptions. |