Element interfejsu, który można włączać i wyłączać. Można go użyć tylko w widżecie 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")));
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
setControlType(controlType) | Switch | Ustawia typ elementu sterującego przełącznika. |
setFieldName(fieldName) | Switch | Ustawia klucz identyfikujący ten przełącznik w obiekcie zdarzenia generowanym po interakcji. |
setOnChangeAction(action) | Switch | Określa czynność wykonywaną po przełączeniu przełącznika. |
setSelected(selected) | Switch | Określa, czy ten przełącznik ma się rozpoczynać czy odznaczyć. |
setValue(value) | Switch | Określa wartość, która jest wysyłana jako formularz po włączeniu tego przełącznika. |
Szczegółowa dokumentacja
setControlType(controlType)
Ustawia typ elementu sterującego przełącznika. Domyślna wartość to SWITCH
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
controlType | SwitchControlType | Typ przełącznika. |
Zwróć
Switch
– ten obiekt do łańcucha.
setFieldName(fieldName)
Ustawia klucz identyfikujący ten przełącznik w obiekcie zdarzenia generowanym po interakcji. Niewidoczne dla użytkownika. Wymagany.
W przeciwieństwie do innych pól formularza ta nazwa nie musi być unikalna. Wprowadzane wartości formularza dotyczące przełączników korzystających z tej samej nazwy pola są zwracane jako tablica. Tablica składa się z wartości wszystkich aktywnych przełączników o tej nazwie pola.
Parametry
Nazwa | Typ | Opis |
---|---|---|
fieldName | String | Klucz służący do identyfikowania tego przełącznika. |
Zwróć
Switch
– ten obiekt do łańcucha.
setOnChangeAction(action)
setSelected(selected)
Określa, czy ten przełącznik ma się rozpoczynać czy odznaczyć.
Parametry
Nazwa | Typ | Opis |
---|---|---|
selected | Boolean | Początkowe ustawienie stanu przełączania. |
Zwróć
Switch
– ten obiekt do łańcucha.
setValue(value)
Określa wartość, która jest wysyłana jako formularz po włączeniu tego przełącznika.
Parametry
Nazwa | Typ | Opis |
---|---|---|
value | String | Wartość powiązana z nazwą, gdy przełącznik jest włączony. Wysyłana do wywołania zwrotnego formularza jest zawsze reprezentowana jako ciąg znaków. |
Zwróć
Switch
– ten obiekt do łańcucha.