عنصر في واجهة المستخدم يتيح التبديل بين التفعيل والإيقاف. لا يمكن استخدام هذا الخيار إلا داخل تطبيق 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
— هذا العنصر، للتسلسل.