É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éthode | Type renvoyé | Brève description |
|---|---|---|
setControlType(controlType) | Switch | Définit le type de commande du contacteur. |
setFieldName(fieldName) | Switch | 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. |
setOnChangeAction(action) | Switch | Définit l'action à effectuer lorsque le bouton bascule est activé. |
setSelected(selected) | Switch | Détermine si ce contacteur doit démarrer ou non. |
setValue(value) | Switch | Dé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
| Nom | Type | Description |
|---|---|---|
controlType | SwitchControlType | Type 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
| Nom | Type | Description |
|---|---|---|
fieldName | String | Clé permettant d'identifier ce contacteur. |
Aller-retour
Switch : cet objet, pour le chaînage
setOnChangeAction(action)
setSelected(selected)
Détermine si ce contacteur doit démarrer ou non.
Paramètres
| Nom | Type | Description |
|---|---|---|
selected | Boolean | Paramè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
| Nom | Type | Description |
|---|---|---|
value | String | Valeur 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