Skip to content

KeyboardCommand.checkIsOn method

KeyboardCommand › checkIsOn

Whether the command reads as ON. Supply it for a toggle whose state lives outside the strip; omit it for an action, which does something and is done. A CheckboxCommand needs no equivalent — its checkbox element is the state.

Re-read by ModalCommands.refresh.

Signature:

checkIsOn(this: void): boolean

Parameters:

ParameterTypeDescription
thisvoid

Returns: booleanWhether the command reads as ON.