Class DecoratedText
Page Summary
DecoratedText is a widget for displaying text with optional icons, and labels above or below.
Setting the text content and either a top label, bottom label, or icon is required for this widget.
DecoratedText is designed to replace the KeyValue widget and is available for Google Workspace add-ons and Google Chat apps.
A widget that displays text with optional decorations. Possible keys include an icon, a labelabove and a label below. Setting the text content and one of the keys is required usingset and one ofDecorated,Decorated,set, orset. This class is intended to replaceKey
Available for Google Workspace add-ons and Google Chat apps.
constdecoratedText=CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');constmultilineDecoratedText=CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel').setWrapText(true).setBottomLabel('BottomLabel');
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Widget | Adds the event action that can be performed on the widget. |
set | Decorated | Sets an authorization action that opens a URL to the authorization flow when the object isclicked. |
set | Decorated | Sets the label text to be used as the key and is displayed below the text content. |
set | Decorated | Sets theButton that is displayed to the right of the text. |
set | Decorated | Sets an action that composes a draft email when the object is clicked. |
set | Decorated | Sets the optionalIcon that is displayed to the right of the content. |
set | Widget | Sets the unique ID assigned that's used to identify the widget to be mutated. |
set | Decorated | Sets an action that executes when the object is clicked. |
set | Decorated | Sets an action that opens a URL in a tab when the object is clicked. |
set | Decorated | Sets a URL to be opened when the object is clicked. |
set | Decorated | Sets the optionalIcon to display before the text content. |
set | Decorated | Sets theSwitch that is displayed to the right of the content. |
set | Decorated | Sets the text to be used as the value. |
set | Decorated | Sets the label text to be used as the key and is displayed above the text content. |
set | Widget | Sets the visibility of the widget. |
set | Decorated | Sets whether the value text should be displayed on a single line or multiple lines. |
Detailed documentation
addEventAction(eventAction)
Adds the event action that can be performed on the widget.
Parameters
| Name | Type | Description |
|---|---|---|
event | Event | TheEvent to be added. |
Return
Widget — The Object, for chaining.
setAuthorizationAction(action)
Sets an authorization action that opens a URL to the authorization flow when the object isclicked. This opens the URL in a new window. When the user finishes the authorization flow andreturns to the application, the add-on reloads.
A UI object can only have one ofset,set,set,set, orset set.
// ...constaction=CardService.newAuthorizationAction().setAuthorizationUrl('url');CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parameters
| Name | Type | Description |
|---|---|---|
action | Authorization | The object that specifies the authorization action to take when this element is clicked. |
Return
Decorated — This object, for chaining.
setBottomLabel(text)
Sets the label text to be used as the key and is displayed below the text content.
Parameters
| Name | Type | Description |
|---|---|---|
text | String | The label text. |
Return
Decorated — This object, for chaining.
setButton(button)
Sets theButton that is displayed to the right of the text. ADecorated canonly support one button or one switch.
Parameters
| Name | Type | Description |
|---|---|---|
button | Button | The button to add. |
Return
Decorated — This object, for chaining.
setComposeAction(action, composedEmailType)
Sets an action that composes a draft email when the object is clicked. A UI object can onlyhave one ofset,set,set,set, orset set.
TheAction parameter must specify a callback function that returns aCompose object configured usingCompose.
Note: This method doesn't set acompose action that isused toextend the compose UI.Rather, this method connects this UI element to anAction thatcomposes draft messages in Apps Script that areopened in Gmail when the action completes.
// ...constaction=CardService.newAction().setFunctionName('composeEmailCallback');CardService.newTextButton().setText('Compose Email').setComposeAction(action,CardService.ComposedEmailType.REPLY_AS_DRAFT);// ...functioncomposeEmailCallback(e){constthread=GmailApp.getThreadById(e.threadId);constdraft=thread.createDraftReply('This is a reply');returnCardService.newComposeActionResponseBuilder().setGmailDraft(draft).build();}
Parameters
| Name | Type | Description |
|---|---|---|
action | Action | The object that specifies the compose action to take when this element is clicked. |
composed | Composed | An enum value that specifies whether the composed draft is a standalone or reply draft. |
Return
Decorated — This object, for chaining.
setEndIcon(endIcon)
Sets the optionalIcon that is displayed to the right of the content. ADecorated can only support one button, one switch or one icon.
Parameters
| Name | Type | Description |
|---|---|---|
end | Icon | The icon to add. |
Return
Decorated — This object, for chaining.
setId(id)
Sets the unique ID assigned that's used to identify the widget to be mutated. Widget mutationis only supported in Add-Ons.
Parameters
| Name | Type | Description |
|---|---|---|
id | String | The id of the widget, with a limit of 64 characters and in format of `[a-zA-Z0-9-]+`. |
Return
Widget — This object, for chaining.
setOnClickAction(action)
Sets an action that executes when the object is clicked. A UI object can only have one ofset,set,set,set, orset set.
TheAction parameter must specify a callback function that returns aAction object.
// ...constaction=CardService.newAction().setFunctionName('notificationCallback');CardService.newTextButton().setText('Create notification').setOnClickAction(action);// ...functionnotificationCallback(){returnCardService.newActionResponseBuilder().setNotification(CardService.newNotification().setText('Some info to display to user'),).build();}
Parameters
| Name | Type | Description |
|---|---|---|
action | Action | The action to take when this element is clicked. |
Return
Decorated — This object, for chaining.
setOnClickOpenLinkAction(action)
Sets an action that opens a URL in a tab when the object is clicked. Use this function when theURL needs to be built or when you need to take other actions in addition to creating theOpen object. A UI object can only have one ofset,set,set,set, orset set.
TheAction parameter must specify a callback function that returns aAction object configured usingAction.
// ...constaction=CardService.newAction().setFunctionName('openLinkCallback');CardService.newTextButton().setText('Open Link').setOnClickOpenLinkAction(action);// ...functionopenLinkCallback(){returnCardService.newActionResponseBuilder().setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com')).build();}
Parameters
| Name | Type | Description |
|---|---|---|
action | Action | The object that specifies the open link action to take when this element is clicked. |
Return
Decorated — This object, for chaining.
setOpenLink(openLink)
Sets a URL to be opened when the object is clicked. Use this function when the URL is alreadyknown and only needs to be opened. A UI object can only have one ofset,set,set,set,orset set.
Parameters
| Name | Type | Description |
|---|---|---|
open | Open | AnOpen object describing the URL to open. |
Return
Decorated — This object, for chaining.
setStartIcon(startIcon)
Sets the optionalIcon to display before the text content.
Parameters
| Name | Type | Description |
|---|---|---|
start | Icon | The icon to display. |
Return
Decorated — This object, for chaining.
setSwitchControl(switchToSet)
Sets theSwitch that is displayed to the right of the content. ADecoratedcan only support one button or one switch.
Parameters
| Name | Type | Description |
|---|---|---|
switch | Switch | The switch to add. |
Return
Decorated — This object, for chaining.
setText(text)
Sets the text to be used as the value. Supportsbasic HTML formatting. Required.
Parameters
| Name | Type | Description |
|---|---|---|
text | String | The text content for this widget. |
Return
Decorated — This object, for chaining.
setTopLabel(text)
Sets the label text to be used as the key and is displayed above the text content.
Parameters
| Name | Type | Description |
|---|---|---|
text | String | The label text. |
Return
Decorated — This object, for chaining.
setVisibility(visibility)
Sets the visibility of the widget. The default value is `VISIBLE`.
Parameters
| Name | Type | Description |
|---|---|---|
visibility | Visibility | TheVisibility of the widget. |
Return
Widget — The Object, for chaining.
setWrapText(wrapText)
Sets whether the value text should be displayed on a single line or multiple lines.
Parameters
| Name | Type | Description |
|---|---|---|
wrap | Boolean | Iftrue, the text is wrapped and displayed on multiple lines. Otherwise the text is truncated. |
Return
Decorated — This object, for chaining.
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 2025-12-03 UTC.