Diese Seite wurde von der Cloud Translation API übersetzt.

Class Switch

Ein UI-Element, das aktiviert oder deaktiviert werden kann. Kann nur in einem DecoratedText-Widget verwendet werden.

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")));

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
`setControlType(controlType)`	`Switch`	Legt den Steuerelementtyp des Schalters fest.
`setFieldName(fieldName)`	`Switch`	Legt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird.
`setOnChangeAction(action)`	`Switch`	Legt die Aktion fest, die ausgeführt werden soll, wenn der Schalter umgelegt wird.
`setSelected(selected)`	`Switch`	Legt fest, ob dieser Schalter ausgewählt oder nicht ausgewählt sein soll.
`setValue(value)`	`Switch`	Legt den Wert fest, der als Formulareingabe gesendet wird, wenn dieser Schalter aktiviert ist.

Detaillierte Dokumentation

`setControlType(controlType)`

Legt den Steuerelementtyp des Schalters fest. Die Standardeinstellung ist SWITCH.

Parameter

Name	Typ	Beschreibung
`controlType`	`SwitchControlType`	Die Art der Schaltersteuerung.

Return

Switch: Dieses Objekt für Verkettungen.

`setFieldName(fieldName)`

Legt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird. Für den Nutzer nicht sichtbar. Erforderlich.

Im Gegensatz zu anderen Formularfeldern muss dieser Feldname nicht eindeutig sein. Die Formulareingabewerte für Schalter, die denselben Feldnamen verwenden, werden als Array zurückgegeben. Das Array besteht aus den Werten für alle aktivierten Schalter mit diesem Feldnamen.

Parameter

Name	Typ	Beschreibung
`fieldName`	`String`	Der Schlüssel, mit dem dieser Schalter identifiziert wird.

Return

Switch: Dieses Objekt für Verkettungen.

`setOnChangeAction(action)`

Legt die Aktion fest, die ausgeführt werden soll, wenn der Schalter umgelegt wird.

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Die Aktion, die ausgeführt werden soll, wenn der Schalter umgelegt wird.

Return

Switch: Dieses Objekt für Verkettungen.

`setSelected(selected)`

Legt fest, ob dieser Schalter ausgewählt oder nicht ausgewählt sein soll.

Parameter

Name	Typ	Beschreibung
`selected`	`Boolean`	Die Ausgangseinstellung für den Schalterstatus.

Return

Switch: Dieses Objekt für Verkettungen.

`setValue(value)`

Legt den Wert fest, der als Formulareingabe gesendet wird, wenn dieser Schalter aktiviert ist.

Parameter

Name	Typ	Beschreibung
`value`	`String`	Der Wert, der dem Namen zugeordnet ist, wenn der Schalter aktiviert ist. Wenn sie an den Formularrückruf gesendet wird, wird sie immer als String dargestellt.

Return

Switch: Dieses Objekt für Verkettungen.