Class Button

A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see Add a button.

To make an image a clickable button, specify an [Image][google.apps.card.v1.Image] (not an [ImageComponent][google.apps.card.v1.ImageComponent]) and set an onClick action.

Google Workspace Add-ons and Chat apps:

Inheritance

object

Button

Implements

IMessage<Button>

IEquatable<Button>

IDeepCloneable<Button>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Apps.Card.V1

Assembly: Google.Apps.Card.V1.dll

Syntax

public sealed class Button : IMessage<Button>, IEquatable<Button>, IDeepCloneable<Button>, IBufferMessage, IMessage

Constructors

Button()

Declaration

public Button()

Button(Button)

Declaration

public Button(Button other)

Parameters

Type	Name	Description
Button	other

Properties

AltText

The alternative text that's used for accessibility.

Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".

Declaration

public string AltText { get; set; }

Property Value

Type	Description
string

Color

If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely results in white text.

If unset, the image background is white and the font color is blue.

For red, green, and blue, the value of each field is a float number that you can express in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale.

Optionally set alpha, which sets a level of transparency using this equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

For alpha, a value of 1 corresponds with a solid color, and a value of 0 corresponds with a completely transparent color.

For example, the following color represents a half transparent red:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
   "alpha": 0.5
}

Declaration

public Color Color { get; set; }

Property Value

Type	Description
Color

Disabled

If true, the button is displayed in an inactive state and doesn't respond to user actions.

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
bool

Icon

The icon image. If both icon and text are set, then the icon appears before the text.

Declaration

public Icon Icon { get; set; }

Property Value

Type	Description
Icon

OnClick

Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.

Declaration

public OnClick OnClick { get; set; }

Property Value

Type	Description
OnClick

Text

The text displayed inside the button.

Declaration

public string Text { get; set; }

Property Value

Type	Description
string