CheckBoxModel API in JavaScript (ES5) CheckBox API control

Interface for a class CheckBox

Properties

change

EmitType<ChangeEventArgs>

Triggers when the CheckBox state has been changed by user interaction.

created

EmitType<Event>

Triggers once the component rendering is completed.

checked

boolean

Specifies a value that indicates whether the CheckBox is checked or not. When set to true, the CheckBox will be in checked state.

cssClass

string

Defines class/multiple classes separated by a space in the CheckBox element. You can add custom styles to the CheckBox by using this property.

disabled

boolean

Specifies a value that indicates whether the CheckBox is disabled or not. When set to true, the CheckBox will be in disabled state.

enableHtmlSanitizer

boolean

Defines whether to allow the cross-scripting site or not.

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

enableRtl

boolean

Enable or disable rendering component in right to left direction.

htmlAttributes

{ [key: string]: string }

You can add the additional html attributes such as disabled, value etc., to the element. If you configured both property and equivalent html attribute then the component considers the property value.

indeterminate

boolean

Specifies a value that indicates whether the CheckBox is in indeterminate state or not. When set to true, the CheckBox will be in indeterminate state.

label

string

Defines the caption for the CheckBox, that describes the purpose of the CheckBox.

labelPosition

LabelPosition

Positions label before/after the CheckBox. The possible values are:

• Before - The label is positioned to left of the CheckBox.
• After - The label is positioned to right of the CheckBox.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

name

string

Defines name attribute for the CheckBox. It is used to reference form data (CheckBox value) after a form is submitted.

value

string

Defines value attribute for the CheckBox. It is a form data passed to the server when submitting the form.