Class SelectionInput

SelectionInput

An input field that allows choosing between a set of predefined options.


 var checkboxGroup = CardService.newSelectionInput()
     .setType(CardService.SelectionInputType.CHECK_BOX)
     .setTitle("A group of checkboxes. Multiple selections are allowed.")
     .setFieldName("checkbox_field")
     .addItem("checkbox one title", "checkbox_one_value", false)
     .addItem("checkbox two title", "checkbox_two_value", true)
     .addItem("checkbox three title", "checkbox_three_value", false)
     .setOnChangeAction(CardService.newAction()
         .setFunctionName("handleCheckboxChange"));

 var radioGroup = CardService.newSelectionInput()
     .setType(CardService.SelectionInputType.RADIO_BUTTON)
     .setTitle("A group of radio buttons. Only a single selection is allowed.")
     .setFieldName("checkbox_field")
     .addItem("radio button one title", "radio_one_value", true)
     .addItem("radio button two title", "radio_two_value", true)
     .addItem("radio button three title", "radio_three_value", false);
 

Methods

MethodReturn typeBrief description
addItem(text, value, selected)SelectionInputAdds a new item that can be selected.
setFieldName(fieldName)SelectionInputSets the key that identifies this selection input in the event object that is generated when there is a UI interaction.
setOnChangeAction(action)SelectionInputSets an Action to be performed whenever the selection input changes.
setTitle(title)SelectionInputSets the title to be shown ahead of the input field.
setType(type)SelectionInputSets the type of this input.

Detailed documentation

addItem(text, value, selected)

Adds a new item that can be selected.

Parameters

NameTypeDescription
textObjectthe text to be shown for this item. Non-string primitive arguments are converted to strings automatically.
valueObjectthe form input value that is sent via the callback. Non-string primitive arguments are converted to strings automatically.
selectedBooleanwhether the item should be start as selected or un-selected.

Return

SelectionInput — this object, for chaining.


setFieldName(fieldName)

Sets the key that identifies this selection input in the event object that is generated when there is a UI interaction. Not visible to the user. Required, must be unique.

Parameters

NameTypeDescription
fieldNameStringthe name to assign to this input.

Return

SelectionInput — this object, for chaining.


setOnChangeAction(action)

Sets an Action to be performed whenever the selection input changes.

Parameters

NameTypeDescription
actionActionthe action to take.

Return

SelectionInput — this object, for chaining.


setTitle(title)

Sets the title to be shown ahead of the input field.

Parameters

NameTypeDescription
titleStringthe input field title.

Return

SelectionInput — this object, for chaining.


setType(type)

Sets the type of this input. Defaults to CHECKBOX.

Parameters

NameTypeDescription
typeSelectionInputTypethe selection type.

Return

SelectionInput — this object, for chaining.

Send feedback about...

Apps Script
Apps Script