Switch

(part of package 'Bootstrap Extra Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

This is a reference page; many components have detailed usage guides here.

Properties

animate

Type: boolean Default Value: true


componentSize

Type: tagstring Default Value: "Normal"


dataProviderID

Type: dataprovider


enabled

Type: enabled Default Value: true


handleWidth

Type: tagstring Default Value: "150"


label

Type: tagstring Default Value: "Switch"


labelWidth

Type: tagstring Default Value: "150"


offColor

Type: tagstring Default Value: "primary"


offText

Type: tagstring Default Value: "Off"


onColor

Type: tagstring Default Value: "primary"


onText

Type: tagstring Default Value: "On"


styleClass

Type: styleclass Default Value: "switch"


tabSeq

Type: tabseq


visible

Type: visible


Events

onActionMethodID

Parameters:

event JSEvent


onDataChangeMethodID

Handle changed data, return false if the value should not be accepted. JSEvent.data will contain extra information about dataproviderid, its scope and the scope id (record datasource or form/global variable scope) - present since 2021.06 release

Parameters:

oldValue ${dataproviderType} newValue ${dataproviderType} event JSEvent

Returns: boolean


API

requestFocus

Request the focus to this switch.

@example

 myElement.requestFocus();

Last updated