Class Switch

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

Élément d'interface utilisateur qui peut être activé ou désactivé. Cet élément ne peut être utilisé que dans un widget DecoratedText.

var switchDecoratedText  = CardService.newDecoratedText()
  .setTopLabel("Switch decorated text widget label")
  .setText("This is a decorated text widget with a switch on the right")
  .setWrapText(true)
  .setSwitchControl(CardService.newSwitch()
      .setFieldName("form_input_switch_key")
      .setValue("form_input_switch_value")
      .setOnChangeAction(CardService.newAction()
          .setFunctionName("handleSwitchChange")));

Méthodes

MéthodeType renvoyéBrève description
setControlType(controlType)SwitchDéfinit le type de commande du contacteur.
setFieldName(fieldName)SwitchDéfinit la clé qui identifie ce contacteur dans l'objet d'événement généré lors d'une interaction avec l'interface utilisateur.
setOnChangeAction(action)SwitchDéfinit l'action à effectuer lorsque le bouton bascule est activé.
setSelected(selected)SwitchDétermine si ce contacteur doit démarrer ou non.
setValue(value)SwitchDéfinit la valeur envoyée en tant qu'entrée de formulaire lorsque ce bouton est activé.

Documentation détaillée

setControlType(controlType)

Définit le type de commande du contacteur. La valeur par défaut est SWITCH.

Paramètres

NomTypeDescription
controlTypeSwitchControlTypeType de commande du contacteur.

Aller-retour

Switch : cet objet, pour le chaînage


setFieldName(fieldName)

Définit la clé qui identifie ce contacteur dans l'objet d'événement généré lors d'une interaction avec l'interface utilisateur. Non visible par l'utilisateur. Obligatoire.

Contrairement à d'autres champs de formulaire, ce nom de champ n'a pas besoin d'être unique. Les valeurs d'entrée du formulaire pour les commutateurs utilisant le même nom de champ sont renvoyées sous forme de tableau. Le tableau contient les valeurs de tous les contacteurs activés portant ce nom de champ.

Paramètres

NomTypeDescription
fieldNameStringClé permettant d'identifier ce contacteur.

Aller-retour

Switch : cet objet, pour le chaînage


setOnChangeAction(action)

Définit l'action à effectuer lorsque le bouton bascule est activé.

Paramètres

NomTypeDescription
actionActionAction à effectuer lorsque le bouton bascule est activé.

Aller-retour

Switch : cet objet, pour le chaînage


setSelected(selected)

Détermine si ce contacteur doit démarrer ou non.

Paramètres

NomTypeDescription
selectedBooleanParamètre de départ de l'état du contacteur.

Aller-retour

Switch : cet objet, pour le chaînage


setValue(value)

Définit la valeur envoyée en tant qu'entrée de formulaire lorsque ce bouton est activé.

Paramètres

NomTypeDescription
valueStringValeur associée au nom lorsque l'option est activée. Lorsqu'elle est envoyée au rappel du formulaire, elle est toujours représentée par une chaîne.

Aller-retour

Switch : cet objet, pour le chaînage