此页面由 Cloud Translation API 翻译。

Class Switch

支持开启或关闭的界面元素。只能在 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")));

方法

方法	返回类型	简介
`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)`

设置切换开关时要执行的操作。

参数

名称	类型	说明
`action`	`Action`	开关切换后要执行的操作。

Switch - 此对象，用于实现链式连接。

`setSelected(selected)`

设置此开关在开始时应为选中状态，还是取消选择状态。

参数

名称	类型	说明
`selected`	`Boolean`	启动开关状态设置。

Switch - 此对象，用于实现链式连接。

`setValue(value)`

设置当此开关开启时，作为表单输入发送的值。

参数

名称	类型	说明
`value`	`String`	开关开启时与名称关联的值。当此字符串发送到表单回调时，它始终表示为字符串。

Switch - 此对象，用于实现链式连接。