רכיב בממשק המשתמש שתומך במתג להפעלה או להשבתה. ניתן להשתמש באפשרות הזו רק בתוך ווידג'ט של DecoratedText.
אפשר להשתמש בתוספים ל-Google Workspace ובאפליקציות של Google Chat.
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")));
שיטות
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
setControlType(controlType) | Switch | הגדרת סוג הבקרה של המתג. |
setFieldName(fieldName) | Switch | המפתח שמזהה את המתג הזה באובייקט האירוע שנוצר כשיש אינטראקציה בממשק המשתמש. |
setOnChangeAction(action) | Switch | הגדרת הפעולה לביצוע כשהמתג במצב מופעל. |
setSelected(selected) | Switch | הגדרה זו קובעת אם המתג יתחיל כמצב שנבחר או לא. |
setValue(value) | Switch | מגדיר את הערך שנשלח כקלט הטופס כאשר המתג הזה במצב מופעל. |
תיעוד מפורט
setControlType(controlType)
הגדרת סוג הבקרה של המתג. ברירת המחדל היא SWITCH.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
controlType | SwitchControlType | סוג של פקד המתג. |
החזרות
Switch – האובייקט הזה, לשרשור.
setFieldName(fieldName)
המפתח שמזהה את המתג הזה באובייקט האירוע שנוצר כשיש אינטראקציה בממשק המשתמש. לא גלוי למשתמש. חובה.
בשונה משדות טופס אחרים, שם השדה הזה לא חייב להיות ייחודי. ערכי הקלט בטופס, למתגים שמשתמשים באותו שם שדה, מוחזרים כמערך. המערך מכיל את הערכים של כל המתגים המופעלים עם שם השדה הזה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
fieldName | String | המפתח שמשמש לזיהוי המתג הזה. |
החזרות
Switch – האובייקט הזה, לשרשור.
setOnChangeAction(action)
setSelected(selected)
הגדרה זו קובעת אם המתג יתחיל כמצב שנבחר או לא.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
selected | Boolean | ההגדרה של מצב המתג ההתחלתי. |
החזרות
Switch – האובייקט הזה, לשרשור.
setValue(value)
מגדיר את הערך שנשלח כקלט הטופס כאשר המתג הזה במצב מופעל.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
value | String | הערך שמשויך לשם כשהמתג מופעל. כשהערך הזה נשלח אל הטופס לקריאה חוזרת, הוא תמיד מיוצג כמחרוזת. |
החזרות
Switch – האובייקט הזה, לשרשור.