Class DecoratedText

    • 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.
    Decorated Text

    A widget that displays text with optional decorations. Possible keys include an icon, a label above and a label below. Setting the text content and one of the keys is required using set Text(text) and one of Decorated Text , Decorated Text , set Top Label(text) , or set Bottom Label(text) . This class is intended to replace Key Value .

    Available for Google Workspace add-ons and Google Chat apps.

     const 
  
 decoratedText 
  
 = 
  
 CardService 
 . 
 newDecoratedText 
 (). 
 setText 
 ( 
 'Text' 
 ). 
 setTopLabel 
 ( 
 'TopLabel' 
 ); 
 const 
  
 multilineDecoratedText 
  
 = 
  
 CardService 
 . 
 newDecoratedText 
 () 
  
 . 
 setText 
 ( 
 'Text' 
 ) 
  
 . 
 setTopLabel 
 ( 
 'TopLabel' 
 ) 
  
 . 
 setWrapText 
 ( 
 true 
 ) 
  
 . 
 setBottomLabel 
 ( 
 'BottomLabel' 
 );

    Methods

    Method Return type Brief description
    set Authorization Action(action)
    		Decorated Text Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Bottom Label(text)
    		Decorated Text Sets the label text to be used as the key and is displayed below the text content.
    set Button(button)
    		Decorated Text Sets the Button that is displayed to the right of the text.
    set Compose Action(action, composedEmailType)
    		Decorated Text Sets an action that composes a draft email when the object is clicked.
    set End Icon(endIcon)
    		Decorated Text Sets the optional Icon Image that is displayed to the right of the content.
    set On Click Action(action)
    		Decorated Text Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Decorated Text Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Decorated Text Sets a URL to be opened when the object is clicked.
    set Start Icon(startIcon)
    		Decorated Text Sets the optional Icon Image to display before the text content.
    set Switch Control(switchToSet)
    		Decorated Text Sets the Switch that is displayed to the right of the content.
    set Text(text)
    		Decorated Text Sets the text to be used as the value.
    set Top Label(text)
    		Decorated Text Sets the label text to be used as the key and is displayed above the text content.
    set Wrap Text(wrapText)
    		Decorated Text Sets whether the value text should be displayed on a single line or multiple lines.

    Detailed documentation

    set Authorization Action(action)

    Sets an authorization action that opens a URL to the authorization flow when the object is clicked. This opens the URL in a new window. When the user finishes the authorization flow and returns to the application, the add-on reloads.

    A UI object can only have one of set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) , or set Compose Action(action, composedEmailType) set.

     // ... 
 const 
  
 action 
  
 = 
  
 CardService 
 . 
 newAuthorizationAction 
 (). 
 setAuthorizationUrl 
 ( 
 'url' 
 ); 
 CardService 
 . 
 newTextButton 
 (). 
 setText 
 ( 
 'Authorize' 
 ). 
 setAuthorizationAction 
 ( 
 action 
 );

    Parameters

    Name Type Description
    action
    		Authorization Action The object that specifies the authorization action to take when this element is clicked.

    Return

    Decorated Text — This object, for chaining.

    set Bottom Label(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 Text — This object, for chaining.

    set Button(button)

    Sets the Button that is displayed to the right of the text. A Decorated Text can only support one button or one switch.

    Parameters

    Name Type Description
    button
    		Button The button to add.

    Return

    Decorated Text — This object, for chaining.

    set Compose Action(action, composedEmailType)

    Sets an action that composes a draft email when the object is clicked. A UI object can only have one of set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) , or set Compose Action(action, composedEmailType) set.

    The Action parameter must specify a callback function that returns a Compose Action Response object configured using Compose Action Response Builder.setGmailDraft(draft) .

     // ... 
 const 
  
 action 
  
 = 
  
 CardService 
 . 
 newAction 
 (). 
 setFunctionName 
 ( 
 'composeEmailCallback' 
 ); 
 CardService 
 . 
 newTextButton 
 () 
  
 . 
 setText 
 ( 
 'Compose Email' 
 ) 
  
 . 
 setComposeAction 
 ( 
 action 
 , 
  
 CardService 
 . 
 ComposedEmailType 
 . 
 REPLY_AS_DRAFT 
 ); 
 // ... 
 function 
  
 composeEmailCallback 
 ( 
 e 
 ) 
  
 { 
  
 const 
  
 thread 
  
 = 
  
 GmailApp 
 . 
 getThreadById 
 ( 
 e 
 . 
 threadId 
 ); 
  
 const 
  
 draft 
  
 = 
  
 thread 
 . 
 createDraftReply 
 ( 
 'This is a reply' 
 ); 
  
 return 
  
 CardService 
 . 
 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 Email Type
    		Composed Email Type An enum value that specifies whether the composed draft is a standalone or reply draft.

    Return

    Decorated Text — This object, for chaining.

    set End Icon(endIcon)

    Sets the optional Icon Image that is displayed to the right of the content. A Decorated Text can only support one button, one switch or one icon.

    Parameters

    Name Type Description
    end Icon
    		Icon Image The icon to add.

    Return

    Decorated Text — This object, for chaining.

    set On Click Action(action)

    Sets an action that executes when the object is clicked. A UI object can only have one of set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) , or set Compose Action(action, composedEmailType) set.

    The Action parameter must specify a callback function that returns a Action Response object.

     // ... 
 const 
  
 action 
  
 = 
  
 CardService 
 . 
 newAction 
 (). 
 setFunctionName 
 ( 
 'notificationCallback' 
 ); 
 CardService 
 . 
 newTextButton 
 () 
  
 . 
 setText 
 ( 
 'Create notification' 
 ) 
  
 . 
 setOnClickAction 
 ( 
 action 
 ); 
 // ... 
 function 
  
 notificationCallback 
 () 
  
 { 
  
 return 
  
 CardService 
 . 
 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 Text — This object, for chaining.

    set On Click Open Link Action(action)

    Sets an action that opens a URL in a tab when the object is clicked. Use this function when the URL needs to be built or when you need to take other actions in addition to creating the Open Link object. A UI object can only have one of set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) , or set Compose Action(action, composedEmailType) set.

    The Action parameter must specify a callback function that returns a Action Response object configured using Action Response Builder.setOpenLink(openLink) .

     // ... 
 const 
  
 action 
  
 = 
  
 CardService 
 . 
 newAction 
 (). 
 setFunctionName 
 ( 
 'openLinkCallback' 
 ); 
 CardService 
 . 
 newTextButton 
 () 
  
 . 
 setText 
 ( 
 'Open Link' 
 ) 
  
 . 
 setOnClickOpenLinkAction 
 ( 
 action 
 ); 
 // ... 
 function 
  
 openLinkCallback 
 () 
  
 { 
  
 return 
  
 CardService 
 . 
 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 Text — This object, for chaining.

    Sets a URL to be opened when the object is clicked. Use this function when the URL is already known and only needs to be opened. A UI object can only have one of set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) , or set Compose Action(action, composedEmailType) set.

    Parameters

    Name Type Description
    open Link
    		Open Link An Open Link object describing the URL to open.

    Return

    Decorated Text — This object, for chaining.

    set Start Icon(startIcon)

    Sets the optional Icon Image to display before the text content.

    Parameters

    Name Type Description
    start Icon
    		Icon Image The icon to display.

    Return

    Decorated Text — This object, for chaining.

    set Switch Control(switchToSet)

    Sets the Switch that is displayed to the right of the content. A Decorated Text can only support one button or one switch.

    Parameters

    Name Type Description
    switch To Set
    		Switch The switch to add.

    Return

    Decorated Text — This object, for chaining.

    set Text(text)

    Sets the text to be used as the value. Supports basic HTML formatting . Required.

    Parameters

    Name Type Description
    text
    		String The text content for this widget.

    Return

    Decorated Text — This object, for chaining.

    set Top Label(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 Text — This object, for chaining.

    set Wrap Text(wrapText)

    Sets whether the value text should be displayed on a single line or multiple lines.

    Parameters

    Name Type Description
    wrap Text
    		Boolean If true , the text is wrapped and displayed on multiple lines. Otherwise the text is truncated.

    Return

    Decorated Text — This object, for chaining.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: