Class TextButton

    Text Button

    A Text Button with a text label. You can set the background color and deactivate the button when needed.

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

     const 
  
 textButton 
  
 = 
  
 CardService 
 . 
 newTextButton 
 () 
  
 . 
 setText 
 ( 
 'Open Link' 
 ) 
  
 . 
 setOpenLink 
 ( 
 CardService 
 . 
 newOpenLink 
 (). 
 setUrl 
 ( 
  
 'https://www.google.com' 
 ));

    Methods

    Method Return type Brief description
    set Alt Text(altText)
    		Text Button Sets the alternative text of the button for accessibility.
    set Authorization Action(action)
    		Text Button Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Background Color(backgroundColor)
    		Text Button Sets the background color for Text Button Style.FILLED button.
    set Compose Action(action, composedEmailType)
    		Text Button Sets an action that composes a draft email when the object is clicked.
    set Disabled(disabled)
    		Text Button Sets whether the button is disabled.
    set Icon(icon)
    		Text Button Sets a predefined Icon to display on the button.
    set Icon Url(url)
    		Text Button Sets the URL of an image to use as this button's icon.
    set Material Icon(icon)
    		Text Button Sets the material design icon.
    set On Click Action(action)
    		Text Button Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Text Button Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Text Button Sets a URL to be opened when the object is clicked.
    set Overflow Menu(menu)
    		Text Button Sets a pop-up menu to be opened when the object is clicked.
    set Text(text)
    		Text Button Sets the text that displays on the button.
    set Text Button Style(textButtonStyle)
    		Text Button Sets the button style.

    Detailed documentation

    set Alt Text(altText)

    Sets the alternative text of the button for accessibility. If unset, defaults to the text that displays on the button.

    Parameters

    Name Type Description
    alt Text
    		String The alternative text to assign to this button.

    Return

    Text Button — This object, for chaining.

    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

    Text Button — This object, for chaining.

    set Background Color(backgroundColor)

    Sets the background color for Text Button Style.FILLED button. If unset for a Text Button Style.FILLED button, the button uses the secondary color defined in the add-on manifest . This method is a no-op for Text Button Style.OUTLINED buttons.

    Parameters

    Name Type Description
    background Color
    		String The color in #rgb format.

    Return

    Text Button — 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

    Text Button — This object, for chaining.

    set Disabled(disabled)

    Sets whether the button is disabled. A disabled button is greyed out and cannot be clicked.

    Parameters

    Name Type Description
    disabled
    		Boolean The disabled state.

    Return

    Text Button — This object, for chaining.

    set Icon(icon)

    Sets a predefined Icon to display on the button. Either this or set Icon Url(url) must be used to define the button image.

    Parameters

    Name Type Description
    icon
    		Icon One of the predefined Icon values.

    Return

    Text Button — This object, for chaining.

    set Icon Url(url)

    Sets the URL of an image to use as this button's icon. Either this or set Icon(icon) must be used to define the button image.

    Parameters

    Name Type Description
    url
    		String The URL address of a hosted image to use as this button's icon.

    Return

    Text Button — This object, for chaining.

    set Material Icon(icon)

    Sets the material design icon.

     const 
  
 textButton 
  
 = 
  
 CardService 
 . 
 newTextButton 
 (). 
 setMaterialIcon 
 ( 
  
 CardService 
 . 
 newMaterialIcon 
 (). 
 setName 
 ( 
 'search' 
 ), 
 );

    Parameters

    Name Type Description
    icon
    		Material Icon The material design icon.

    Return

    Text Button — 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

    Text Button — 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

    Text Button — 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

    Text Button — This object, for chaining.

    set Overflow Menu(menu)

    Sets a pop-up menu to be opened when the object is clicked. Each item in the menu can specify an action to be triggered when clicked. Nested menus are not supported, actions for menu items should not specify an overflow menu.

    Available for Google Chat apps. In developer preview for Google Workspace add-ons.

     const 
  
 overflowMenuItem 
  
 = 
  
 CardService 
 . 
 newOverflowMenuItem 
 () 
  
 . 
 setStartIcon 
 ( 
  
 CardService 
 . 
 newIconImage 
 (). 
 setIconUrl 
 ( 
  
 'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png' 
 , 
  
 ), 
  
 ) 
  
 . 
 setText 
 ( 
 'Open Link' 
 ) 
  
 . 
 setOpenLink 
 ( 
  
 CardService 
 . 
 newOpenLink 
 (). 
 setUrl 
 ( 
 'https://www.google.com' 
 )); 
 const 
  
 overflowMenu 
  
 = 
  
 CardService 
 . 
 newOverflowMenu 
 (). 
 addMenuItem 
 ( 
 overflowMenuItem 
 ). 
 build 
 ();

    Parameters

    Name Type Description
    menu
    		Overflow Menu The object that specifies the overflow menu to display when this element is clicked.

    Return

    Text Button — This object, for chaining.

    set Text(text)

    Sets the text that displays on the button.

    Parameters

    Name Type Description
    text
    		String The text that appears on the button.

    Return

    Text Button — This object, for chaining.

    set Text Button Style(textButtonStyle)

    Sets the button style. If unset, it defaults to Text Button Style.OUTLINED button.

     const 
  
 button 
  
 = 
  
 CardService 
 . 
 newTextButton 
 () 
  
 . 
 setText 
 ( 
 'Filled' 
 ) 
  
 . 
 setTextButtonStyle 
 ( 
 CardService 
 . 
 TextButtonStyle 
 . 
 FILLED 
 ) 
  
 . 
 setOpenLink 
 ( 
 CardService 
 . 
 newOpenLink 
 (). 
 setUrl 
 ( 
 'www.google.com' 
 ));

    Parameters

    Name Type Description
    text Button Style
    		Text Button Style The button style.

    Return

    Text Button — This object, for chaining.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: