Class TextInput

A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When Action.all_widgets_are_required is set to true or this widget is specified in Action.required_widgets, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see Add a field in which a user can enter text.

Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see Receive form data.

When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the [SelectionInput][google.apps.card.v1.SelectionInput] widget.

Google Workspace add-ons and Chat apps:

Inheritance

object

TextInput

Implements

IMessage<TextInput>

IEquatable<TextInput>

IDeepCloneable<TextInput>

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 TextInput : IMessage<TextInput>, IEquatable<TextInput>, IDeepCloneable<TextInput>, IBufferMessage, IMessage

Constructors

TextInput()

Declaration

public TextInput()

TextInput(TextInput)

Declaration

public TextInput(TextInput other)

Parameters

Type	Name	Description
TextInput	other

Properties

AutoCompleteAction

Optional. Specify what action to take when the text input field provides suggestions to users who interact with it.

If unspecified, the suggestions are set by initialSuggestions and are processed by the client.

If specified, the app takes the action specified here, such as running a custom function.

Google Workspace add-ons:

Declaration

public Action AutoCompleteAction { get; set; }

Property Value

Type	Description
Action

HintText

Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible.

Required if label is unspecified. Otherwise, optional.

Declaration

public string HintText { get; set; }

Property Value

Type	Description
string

InitialSuggestions

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav, the list of suggestions filters to show just Java and JavaScript.

Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script. Suggesting JavaScript can standardize how users interact with your app.

When specified, TextInput.type is always SINGLE_LINE, even if it's set to MULTIPLE_LINE.

Google Workspace add-ons and Chat apps:

Declaration

public Suggestions InitialSuggestions { get; set; }

Property Value

Type	Description
Suggestions

Label

The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write surname instead of name.

Required if hintText is unspecified. Otherwise, optional.

Declaration

public string Label { get; set; }

Property Value

Type	Description
string

Name

The name by which the text input is identified in a form input event.

For details about working with form inputs, see Receive form data.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

OnChangeAction

What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening a dialog in Google Chat.

Declaration

public Action OnChangeAction { get; set; }

Property Value

Type	Description
Action

PlaceholderText

Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, Enter a number from 0 to 100.

Google Chat apps:

Declaration

public string PlaceholderText { get; set; }

Property Value

Type	Description
string

Type

How a text input field appears in the user interface. For example, whether the field is single or multi-line.

Declaration

public TextInput.Types.Type Type { get; set; }

Property Value

Type	Description
TextInput.Types.Type

Validation

Specify the input format validation necessary for this text field.

Google Workspace add-ons and Chat apps:

Declaration

public Validation Validation { get; set; }

Property Value

Type	Description
Validation

Value

The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see Receive form data.

Declaration

public string Value { get; set; }

Property Value

Type	Description
string