Skip to main content

Form API overview

Common Form API#

Methods#

NameDescription
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 hiding a control of Form
afterSendfires after a form is sent to the server
afterShowfires after a control of Form is shown
afterValidatefires after validation of form fields is finished
beforeChangePropertiesfires before configuration attributes of a Form control are changed dynamically
beforeHidefires before a Form control is hidden
beforeSendfires before a form is sent to the server
beforeShowfires before a Form control is shown
beforeValidatefires before validation of form fields has started
changefires on changing the value of a control
clickfires after a click on a button in a form

Properties#

NameDescription
alignsets the alignment of controls inside the control group
colsarranges controls inside the control group horizontally
cssthe name of a CSS class(es) applied to the control group
disabledmakes a form disabled
heightsets the height of the control group
hiddendefines whether a form is hidden
paddingsets padding for content inside the control group
rowsarranges controls inside the control group vertically
titlespecifies the title of the control group
widthsets the width of the control group

Button API#

Button methods#

NameDescription
disable()disables a Button control on a page
enable()enables a disabled 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
clickfires after a click on a Button control

Button properties#

List of the Button properties

DatePicker API#

DatePicker methods#

NameDescription
clear()clears a value of a DatePicker control
clearValidate()clears validation of a DatePicker control
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 dhtmlxCalendar 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
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
inputfires when a user enters the value of a control in the input manually

DatePicker properties#

List of the DatePicker properties

Checkbox API#

Checkbox methods#

NameDescription
clear()clears a value of a Checkbox control
clearValidate()clears validation of a Checkbox control
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
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

Checkbox properties#

List of the Checkbox properties

CheckboxGroup API#

CheckboxGroup methods#

NameDescription
clear()clears a value of a CheckboxGroup control
clearValidate()clears validation of a CheckboxGroup control
disable()disables a CheckboxGroup control on a page
enable()enables a disabled CheckboxGroup control
focus()sets focus to the 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 a CheckboxGroup control
isChecked()checks whether a checkbox of the CheckboxGroup control is checked
isDisabled()checks whether a CheckboxGroup control is disabled
isVisible()checks whether a CheckboxGroup control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a CheckboxGroup control
show()shows a CheckboxGroup control on the page
validate()validates a CheckboxGroup control

CheckboxGroup 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

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
clear()clears a value of a ColorPicker control
clearValidate()clears validation of a ColorPicker control
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 dhtmlxColorPicker 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
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
inputfires when a user enters the value of a control in the input manually

Color Picker properties#

List of the Colorpicker properties

Combo API#

Combo methods#

NameDescription
clear()clears a value of a Combo control
clearValidate()clears validation of a Combo control
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 the current value of a Combo control
getWidget()returns the dhtmlxComboBox 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
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

Combo properties#

List of the Combo properties

Input API#

Input methods#

NameDescription
clear()clears a value of an Input control
clearValidate()clears validation of an Input control
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
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
inputfires when a user types some text in the input

Input properties#

List of the Input properties

RadioGroup API#

RadioGroup methods#

NameDescription
clear()clears a value of a RadioGroup control
clearValidate()clears validation of a RadioGroup control
disable()disables a RadioGroup control on a page
enable()enables a disabled RadioGroup 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 a RadioGroup control
isDisabled()checks whether a RadioGroup control is disabled
isVisible()checks whether a RadioGroup control is visible on the page
setProperties()allows changing available configuration attributes of the control dynamically
setValue()sets the value for a RadioGroup control
show()shows a RadioGroup control on the page
validate()validates a RadioGroup control

RadioGroup 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

RadioGroup properties#

List of the Radiogroup properties

RadioButton properties#

List of the RadioButton properties

Select API#

Select methods#

NameDescription
clear()clears a value of a Select control
clearValidate()clears validation of a Select control
disable()disables a Select control on a page
enable()enables a disabled Select control
focus()sets focus to a control
getProperties()returns an object with the available configuration attributes of the control
getOptions()returns an array of Select options
getValue()returns the current value of a Select control
hide()hides a Select control
isDisabled()checks whether a Select 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
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
changeOptionsfires on changing a list of Select options

Select properties#

List of the Select properties

Simple Vault API#

Simple Vault methods#

NameDescription
clear()clears a value of a SimpleVault control
clearValidate()clears validation of a SimpleVault control
disable()disables a SimpleVault control on a page
enable()enables a disabled SimpleVault 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
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
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
clear()clears a value of a Slider control
disable()disables a Slider control on a page
enable()enables a disabled 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 dhtmlxSlider 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
beforeChangePropertiesfires before configuration attributes of the control are changed dynamically
beforeHidefires before a control is hidden
beforeShowfires before a control is shown
changefires on changing the value of a control

Slider properties#

List of the Slider properties

Spacer API#

Spacer methods#

NameDescription
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
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
clear()clears a value of a Textarea control
clearValidate()clears validation of a Textarea control
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
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
inputfires when a user types some text in the textarea

Textarea properties#

List of the Textarea properties

Timepicker API#

Timepicker methods#

NameDescription
clear()clears the value of a TimePicker control
clearValidate()clears validation of a TimePicker control
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 dhtmlxTimePicker 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
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
inputfires when a user enters the value of a control in the input manually

Timepicker properties#

List of the Timepicker properties