Class SelectionInput

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
SelectionInput

Champ de saisie permettant de choisir un ensemble d'options prédéfinies.

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", true)
    .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", false)
    .addItem("radio button three title", "radio_three_value", false);

Méthodes

MéthodeType renvoyéBrève description
addItem(text, value, selected)SelectionInputAjoute un élément pouvant être sélectionné.
setFieldName(fieldName)SelectionInputDéfinit la clé qui identifie cette entrée de sélection dans l'objet d'événement généré lors d'une interaction avec l'interface utilisateur.
setOnChangeAction(action)SelectionInputDéfinit le champ Action à exécuter chaque fois que la saisie sélectionnée change.
setTitle(title)SelectionInputDéfinit le titre à afficher avant le champ de saisie.
setType(type)SelectionInputDéfinit le type de cette entrée.

Documentation détaillée

addItem(text, value, selected)

Ajoute un élément pouvant être sélectionné.

Paramètres

NomTypeDescription
textObjectTexte à afficher pour cet élément. Les arguments primitifs sans chaîne sont automatiquement convertis en chaînes.
valueObjectValeur d'entrée du formulaire envoyée via le rappel. Les arguments primitifs sans chaîne sont automatiquement convertis en chaînes.
selectedBooleanIndique si l'élément doit être sélectionné ou non.

Aller-retour

SelectionInput : cet objet, pour le chaînage


setFieldName(fieldName)

Définit la clé qui identifie cette entrée de sélection dans l'objet d'événement généré lors d'une interaction avec l'interface utilisateur. Non visible par l'utilisateur. Obligatoire, il doit être unique.

Paramètres

NomTypeDescription
fieldNameStringNom à attribuer à cette entrée.

Aller-retour

SelectionInput : cet objet, pour le chaînage


setOnChangeAction(action)

Définit le champ Action à exécuter chaque fois que la saisie sélectionnée change.

Paramètres

NomTypeDescription
actionActionAction à effectuer.

Aller-retour

SelectionInput : cet objet, pour le chaînage


setTitle(title)

Définit le titre à afficher avant le champ de saisie.

Paramètres

NomTypeDescription
titleStringTitre du champ de saisie.

Aller-retour

SelectionInput : cet objet, pour le chaînage


setType(type)

Définit le type de cette entrée. La valeur par défaut est CHECKBOX.

Paramètres

NomTypeDescription
typeSelectionInputTypeType de sélection.

Aller-retour

SelectionInput : cet objet, pour le chaînage