Skip to main content

Form API overview

Common Form API

Methods

NameDescription
blur()removes focus from a control of Form
clear()clears a form
destructor()removes a form instance and releases occupied resources
disable()disables a form on a page
enable()enables a disabled form
forEach()iterates over all controls of a form
getItem()gives access to the object of Form control
getProperties()returns objects with available configuration attributes of Form controls
getValue()gets current values/states of controls
hide()hides a form
isDisabled()checks whether a form is disabled
isVisible()checks whether a form is visible
paint()repaints Form on a page
send()sends a form to the server
setFocus()sets focus to a Form control by its id
setProperties()allows changing available configuration attributes of Form controls dynamically
setValue()sets values/states for controls
show()shows a form on the page
validate()validates form fields

Events

NameDescription
afterChangePropertiesfires after configuration attributes of a Form control have been changed dynamically
afterHidefires after a Form control or its element is hidden
afterSendfires after a form is sent to the server
afterShowfires after a Form control or its element is shown
afterValidatefires after validation of form fields is finished
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of a Form control are changed dynamically
beforeHidefires before a Form control or its element is hidden
beforeSendfires before a form is sent to the server
beforeShowfires before a Form control or its element is shown
beforeValidatefires before validation of form fields has started
blurfires when a control of Form has lost focus
changefires on changing the value of a control
clickfires after a click on a button in a form
focusfires when a control of Form has received focus
keydown fires when any key is pressed

Properties

NameDescription
alignOptional. Sets the alignment of controls inside the control group
colsOptional. Arranges controls inside the control group horizontally
cssOptional. The name of a CSS class(es) applied to the control group
disabledOptional. Makes a form disabled
heightOptional. Sets the height of the control group
hiddenOptional. Defines whether a form is hidden
paddingOptional. Sets padding for content inside the control group
rowsOptional. Arranges controls inside the control group vertically
titleOptional. Specifies the title of the control group
widthOptional. Sets the width of the control group

Avatar API

Avatar methods

NameDescription
blur()removes focus from a control
clear()clears the value of an Avatar control
clearValidate()clears validation of an Avatar control
destructor()removes an avatar instance and releases the occupied resources
disable()disables an Avatar control on a page
enable()enables a disabled Avatar control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of an Avatar control
hide()hides an Avatar control
isDisabled()checks whether an Avatar control is disabled
isVisible()checks whether an Avatar control is visible on the page
selectFile()opens the dialog for selecting an image
send()sends a POST request for a file upload to a server-side URL
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for an Avatar control
show()shows an Avatar control on the page
validate()validates an Avatar control

Avatar events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeUploadFilefires before file upload begins
beforeValidatefires before the control value is validated
blurfires when the control has lost focus
changefires on changing the value of a control
focusfires when an Avatar control has received focus
keydownfires when any key is pressed and the Avatar control is in focus
uploadBeginfires when file upload begins
uploadCompletefires when upload is completed
uploadFailfires if the file upload failed
uploadFilefires when a file has been uploaded
uploadProgressfires on each percent of a file uploading

Avatar properties

List of the Avatar properties

Button API

Button methods

NameDescription
blur()removes focus from a Button control
destructor()removes a button instance and releases the occupied resources
disable()disables a Button control on a page
enable()enables a disabled Button control
focus()sets focus to a Button control
getProperties()returns an object with the available configuration attributes of the control
hide()hides a Button control
isDisabled()checks whether a Button control is disabled
isVisible()checks whether a Button control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
show()shows a Button control on the page

Button events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a Button control is hidden
afterShowfires after a Button control is shown
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a Button control is hidden
beforeShowfires before a Button control is shown
blurfires when a Button control has lost focus
clickfires after a click on a Button control
focusfires when a Button control has received focus
keydown fires when any key is pressed and the Button control is in focus

Button properties

List of the Button properties

DatePicker API

DatePicker methods

NameDescription
blur()removes focus from a Datepicker control
clear()clears a value of a DatePicker control
clearValidate()clears validation of a DatePicker control
destructor()removes a date picker instance and releases the occupied resources
disable()disables a DatePicker control on a page
enable()enables a disabled DatePicker control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of a DatePicker control
getWidget()returns the DHTMLX Calendar widget attached to a DatePicker control
hide()hides a DatePicker control
isDisabled()checks whether a DatePicker control is disabled
isVisible()checks whether a DatePicker control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets a date in a DatePicker control
show()shows a DatePicker control on the page
validate()validates a DatePicker control

DatePicker events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeValidatefires before the control value is validated
blurfires when a Datepicker control has lost focus
changefires on changing the value of a control
focusfires when a Datepicker control has received focus
inputfires when a user enters the value of a control in the input manually
keydown fires when any key is pressed and the Datepicker control is in focus

DatePicker properties

List of the DatePicker properties

Checkbox API

Checkbox methods

NameDescription
blur()removes focus from a Checkbox control
clear()clears a value of a Checkbox control
clearValidate()clears validation of a Checkbox control
destructor()removes a Checkbox instance and releases the occupied resources
disable()disables a Checkbox control on a page
enable()enables a disabled Checkbox control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value/state of a Checkbox control
hide()hides a Checkbox control
isChecked()checks whether a Checkbox control is checked
isDisabled()checks whether a Checkbox control is disabled
isVisible()checks whether a Checkbox control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the state for a Checkbox control
show()shows a Checkbox control on the page
validate()validates a Checkbox control

Checkbox events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeValidatefires before the control value is validated
blurfires when a Checkbox control has lost focus
changefires on changing the value of a control
focusfires when a Checkbox control has received focus
keydown fires when any key is pressed and the Checkbox control is in focus

Checkbox properties

List of the Checkbox properties

CheckboxGroup API

CheckboxGroup methods

NameDescription
blur()removes focus from a CheckboxGroup control
clear()clears a value of a CheckboxGroup control
clearValidate()clears validation of a CheckboxGroup control
destructor()removes a CheckboxGroup instance and releases the occupied resources
disable()disables a CheckboxGroup control or a specific element inside the control
enable()enables a CheckboxGroup control or a specific element inside the control
focus()sets focus to a checkbox of the CheckboxGroup control by its id
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value/state of a checkbox(s)
hide()hides either a checkbox of CheckboxGroup or the whole CheckboxGroup
isChecked()checks whether a checkbox of the CheckboxGroup control is checked
isDisabled()checks whether a CheckboxGroup control or a specific element inside the control is disabled
isVisible()checks whether a CheckboxGroup control or a specific element inside the control is visible
setProperties()allows changing the available configuration attributes of the control dynamically
setValue()sets the value for a CheckboxGroup control
show()shows either a checkbox of CheckboxGroup or the whole CheckboxGroup
validate()validates a CheckboxGroup control

CheckboxGroup events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control or its checkbox is hidden
afterShowfires after a control or its checkbox is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control or its checkbox is hidden
beforeShowfires before a control or its checkbox is shown
beforeValidatefires before the control value is validated
blurfires when a CheckboxGroup control has lost focus
changefires on changing the value of a control
focusfires when a CheckboxGroup control has received focus
keydown fires when any key is pressed and a checkbox of the CheckboxGroup control is in focus

CheckboxGroup properties

List of the CheckboxGroup properties

Properties of a Checkbox of CheckboxGroup

List of properties of a Checkbox of the CheckboxGroup control

Color Picker API

Color Picker methods

NameDescription
blur()removes focus from a ColorPicker control
clear()clears a value of a ColorPicker control
clearValidate()clears validation of a ColorPicker control
destructor()removes a СolorPicker instance and releases the occupied resources
disable()disables a ColorPicker control on a page
enable()enables a disabled ColorPicker control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of a ColorPicker control (in the Hex format)
getWidget()returns the DHTMLX ColorPicker widget attached to a ColorPicker control
hide()hides a ColorPicker control
isDisabled()checks whether a ColorPicker control is disabled
isVisible()checks whether a ColorPicker control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value as a string (in the Hex format) for a ColorPicker control
show()shows a ColorPicker control on the page
validate()validates a ColorPicker control

Color Picker events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeValidatefires before the control value is validated
blurfires when a Colorpicker control has lost focus
changefires on changing the value of a control
focusfires when a Colorpicker control has received focus
inputfires when a user enters the value of a control in the input manually
keydown fires when any key is pressed and the Colorpicker control is in focus

Color Picker properties

List of the Colorpicker properties

Combo API

Combo methods

NameDescription
blur()removes focus from a Combo control
clear()clears a value of a Combo control
clearValidate()clears validation of a Combo control
destructor()removes a combo instance and releases the occupied resources
disable()disables a Combo control on a page
enable()enables a disabled Combo control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns IDs of options which are currently selected in the Combo control
getWidget()returns the ComboBox widget attached to a Combo control
hide()hides a Combo control
isDisabled()checks whether a Combo control is disabled
isVisible()checks whether a Combo control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a Combo control
show()shows a Combo control on the page
validate()validates a Combo control

Combo events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeValidatefires before the control value is validated
blurfires when a Combo control has lost focus
changefires on changing the value of a control
focusfires when a Combo control has received focus
keydown fires when any key is pressed and an option of the Combo control is in focus

Combo properties

List of the Combo properties

Container API

Container methods

NameDescription
attach()attaches a DHTMLX widget into a Container control
attachHTML()attaches an HTML content into a Container control
disable()disables a Container control on a page
enable()enables a Container control on a page
getProperties()returns an object with the available configuration properties of the control and their values
hide()hides a Container control
isDisabled()checks whether a Container control is disabled
isVisible()checks whether a Container control is visible on the page
setProperties()allows changing available configuration properties of the Container control dynamically
show()shows a Container control on the page

Container events

NameDescription
afterChangePropertiesfires after properties of a Container control have been changed dynamically
afterHidefires after a Container control is hidden
afterShowfires after a Container control is shown
beforeChangePropertiesfires before properties of a Container control are changed dynamically
beforeHidefires before a Container control is hidden
beforeShowfires before a Container control is shown

Container properties

List of the Container control properties

Fieldset API

Fieldset methods

NameDescription
destructor()removes a fieldset instance and releases the occupied resources
disable()disables a Fieldset control on a page
enable()enables a disabled Fieldset control
forEach()allows iterating through all the nested items
getProperties()returns an object with the available configuration attributes of the control
hide()hides a Fieldset control
isDisabled()checks whether a Fieldset control is disabled
isVisible()checks whether a Fieldset control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
show()shows a Fieldset control on the page

Fieldset events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically

Fieldset properties

List of the Fieldset control properties

Input API

Input methods

NameDescription
blur()removes focus from an Input control
clear()clears a value of an Input control
clearValidate()clears validation of an Input control
destructor()removes an input instance and releases the occupied resources
disable()disables an Input control on a page
enable()enables a disabled Input control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of an Input control
hide()hides an Input control
isDisabled()checks whether an Input control is disabled
isVisible()checks whether an Input control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for an Input control
show()shows an Input control on the page
validate()validates an Input control

Input events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeValidatefires before the control value is validated
blurfires when an Input control has lost focus
changefires on changing the value of a control
focusfires when an Input control has received focus
inputfires when a user types some text in the input
keydown fires when any key is pressed and the Input control is in focus

Input properties

List of the Input properties

RadioGroup API

RadioGroup methods

NameDescription
blur()removes focus from a RadioGroup control
clear()clears a value of a RadioGroup control
clearValidate()clears validation of a RadioGroup control
destructor()removes a RadioGroup instance and releases the occupied resources
disable()disables a RadioGroup control or a specific element inside the control
enable()enables a disabled RadioGroup control or a specific element inside the control
focus()sets focus to the radio button of the RadioGroup control by its id
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of a RadioGroup control
hide()hides either a radio button of RadioGroup or the whole RadioGroup
isDisabled()checks whether a RadioGroup control or a specific element inside the control is disabled
isVisible()checks whether a RadioGroup control or a specific element inside the control is visible
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a RadioGroup control
show()shows either a radio button of RadioGroup or the whole RadioGroup
validate()validates a RadioGroup control

RadioGroup events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control or its radio button is hidden
afterShowfires after a control or its radio button is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control or its radio button is hidden
beforeShowfires before a control or its radio button is shown
beforeValidatefires before the control value is validated
blurfires when a Radiogroup control has lost focus
changefires on changing the value of a control
focusfires when a Radiogroup control has received focus
keydown fires when any key is pressed and a radio button of the Radiogroup control is in focus

RadioGroup properties

List of the Radiogroup properties

RadioButton properties

List of the RadioButton properties

Select API

Select methods

NameDescription
blur()removes focus from a Select control
clear()clears a value of a Select control
clearValidate()clears validation of a Select control
destructor()removes a select instance and releases the occupied resources
disable()disables a Select control or a specific option inside the control
enable()enables a Select control or a specific option inside the control
focus()sets focus to a control
getOptions()returns an array of Select options
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of a Select control
hide()hides a Select control
isDisabled()checks whether a Select control or a specific option inside the control is disabled
isVisible()checks whether a Select control is visible on the page
setOptions()allows changing a list of Select options dynamically
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a Select control
show()shows a Select control on the page
validate()validates a Select control

Select events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangeOptionsfires before changing a list of Select options
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeValidatefires before the control value is validated
blurfires when a Select control has lost focus
changefires on changing the value of a control
changeOptionsfires on changing a list of Select options
focusfires when a Select control has received focus
keydown fires when any key is pressed and the Select control is in focus

Select properties

List of the Select properties

Simple Vault API

Simple Vault methods

NameDescription
blur()removes focus from a control
clear()clears the value of a SimpleVault control
clearValidate()clears validation of a SimpleVault control
destructor()removes a SimpleVault instance and releases the occupied resources
disable()disables a SimpleVault control on a page
enable()enables a disabled SimpleVault control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of a SimpleVault control
hide()hides a SimpleVault control
isDisabled()checks whether a SimpleVault control is disabled
isVisible()checks whether a SimpleVault control is visible on the page
selectFile()opens the dialog for selecting a new file (files) for adding to a SimpleVault
send()sends a POST request for file upload to a server-side URL
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a SimpleVault control
show()shows a SimpleVault control on the page
validate()validates a SimpleVault control

Simple Vault events

NameDescription
afterAddfires after a file is added to the data collection
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterRemovefires after a file is removed from the data collection
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeAddfires before a file is added to the data collection
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeRemovefires before a file is removed from the data collection
beforeShowfires before a control is shown
beforeUploadFilefires before file upload begins
beforeValidatefires before the control value is validated
changefires on changing the value of a control
uploadBeginfires when file upload begins
uploadCompletefires when upload is completed
uploadFailfires if the file upload failed
uploadFilefires when a file has been uploaded
uploadProgressfires on each percent of files uploading

Simple Vault properties

List of the Simple Vault properties

Slider API

Slider methods

NameDescription
blur()removes focus from a thumb of a Slider control
clear()clears a value of a Slider control
destructor()removes a slider instance and releases the occupied resources
disable()disables a Slider control on a page
enable()enables a disabled Slider control
focus()sets focus to a thumb of a Slider control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of a Slider control
getWidget()returns the DHTMLX Slider widget attached to a Slider control
hide()hides a Slider control
isDisabled()checks whether a Slider control is disabled
isVisible()checks whether a Slider control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a Slider control
show()shows a Slider control on the page

Slider events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
blurfires when a Slider control has lost focus
changefires on changing the value of a control
focusfires when a Slider control has received focus
keydown fires when any key is pressed and the Slider control is in focus

Slider properties

List of the Slider properties

Spacer API

Spacer methods

NameDescription
destructor()removes a spacer instance and releases the occupied resources
getProperties()returns an object with the available configuration attributes of the control
hide()hides a Spacer control
isVisible()checks whether a Spacer control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
show()shows a Spacer control on the page

Spacer events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown

Spacer properties

List of the Spacer properties

Text API

Text methods

NameDescription
clear()clears a value of a Text control
destructor()removes a text instance and releases the occupied resources
disable()disables a Text control on a page
enable()enables a disabled Text control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of a Text control
hide()hides a Text control
isDisabled()checks whether a Text control is disabled
isVisible()checks whether a Text control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a Text control
show()shows a Text control on the page

Text events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeValidatefires before the control value is validated
changefires on changing the value of a control

Text properties

List of the Text properties

Textarea API

Textarea methods

NameDescription
blur()removes focus from a Textarea control
clear()clears a value of a Textarea control
clearValidate()clears validation of a Textarea control
destructor()removes a textarea instance and releases the occupied resources
disable()disables a Textarea control on a page
enable()enables a disabled Textarea control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of a Textarea control
hide()hides a Textarea control
isDisabled()checks whether a Textarea control is disabled
isVisible()checks whether a Textarea control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a Textarea control
show()shows a Textarea control on the page
validate()validates a Textarea control

Textarea events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeValidatefires before the control value is validated
blurfires when a Textarea control has lost focus
changefires on changing the value of a control
focusfires when a Textarea control has received focus
inputfires when a user types some text in the textarea
keydown fires when any key is pressed and the Textarea control is in focus

Textarea properties

List of the Textarea properties

Timepicker API

Timepicker methods

NameDescription
blur()removes focus from a Timepicker control
clear()clears the value of a TimePicker control
clearValidate()clears validation of a TimePicker control
destructor()removes a TimePicker instance and releases the occupied resources
disable()disables a TimePicker control on a page
enable()enables a disabled TimePicker control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value of a TimePicker control
getWidget()returns the DHTMLX TimePicker widget attached to a TimePicker control
hide()hides a TimePicker control
isDisabled()checks whether a TimePicker control is disabled
isVisible()checks whether a TimePicker control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a TimePicker control
show()shows a TimePicker control on the page
validate()validates a TimePicker control

Timepicker events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
afterValidatefires after the control value is validated
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
beforeValidatefires before the control value is validated
blurfires when a Timepicker control has lost focus
changefires on changing the value of a control
focusfires when a Timepicker control has received focus
inputfires when a user enters the value of a control in the input manually
keydown fires when any key is pressed and the Timepicker control is in focus

Timepicker properties

List of the Timepicker properties

Toggle API

Toggle methods

NameDescription
blur()removes focus from a Toggle control
destructor()removes a toggle instance and releases the occupied resources
disable()disables a Toggle control on a page
enable()enables a disabled Toggle control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value/state of a Toggle control
hide()hides a Toggle control
isDisabled()checks whether a Toggle control is disabled
isSelected()checks whether the selected state is enabled
isVisible()checks whether a Toggle control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the state for a Toggle control
show()shows a Toggle control on the page

Toggle events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control is hidden
afterShowfires after a control is shown
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
blurfires when a Toggle control has lost focus
changefires on changing the value of a control
focusfires when a Toggle control has received focus
keydown fires when any key is pressed and the Toggle control is in focus

Toggle properties

List of the Toggle properties

ToggleGroup API

ToggleGroup methods

NameDescription
blur()removes focus from a ToggleGroup control
destructor()removes a toggle group instance and releases the occupied resources
disable()disables a ToggleGroup control or a specific element inside the control
enable()enables a ToggleGroup control or a specific element inside the control
focus()sets focus to an option of the ToggleGroup control by its id
getProperties()returns an object with the available configuration attributes of the control
getValue()returns the current value/state of a toggle(s)
hide()hides either an option of ToggleGroup or the whole ToggleGroup
isDisabled()checks whether a ToggleGroup control or a specific element inside the control is disabled
isSelected()checks whether a toggle of the ToggleGroup control is selected
isVisible()checks whether a ToggleGroup control or a specific element inside the control is visible
setProperties()allows changing the available configuration attributes of the ToggleGroup or its separate options dynamically
setValue()defines the state of the option's elements
show()shows either an option of ToggleGroup or the whole ToggleGroup

ToggleGroup events

NameDescription
afterChangePropertiesfires after configuration attributes of the control have been changed dynamically
afterHidefires after a control or its toggle is hidden
afterShowfires after a control or its toggle is shown
beforeChangefires before changing the value of a control
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control or its toggle is hidden
beforeShowfires before a control or its toggle is shown
blurfires when a ToggleGroup control has lost focus
changefires on changing the value of a control
focusfires when a ToggleGroup control has received focus
keydown fires when any key is pressed and a toggle of the ToggleGroup control is in focus

ToggleGroup properties

List of the ToggleGroup properties