Form API overview
Common Form API
Methods
Name | Description |
---|---|
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
Name | Description |
---|---|
afterChangeProperties | fires after configuration attributes of a Form control have been changed dynamically |
afterHide | fires after a Form control or its element is hidden |
afterSend | fires after a form is sent to the server |
afterShow | fires after a Form control or its element is shown |
afterValidate | fires after validation of form fields is finished |
beforeChange | fires before changing the value of a control |
beforeChangeProperties | fires before configuration attributes of a Form control are changed dynamically |
beforeHide | fires before a Form control or its element is hidden |
beforeSend | fires before a form is sent to the server |
beforeShow | fires before a Form control or its element is shown |
beforeValidate | fires before validation of form fields has started |
blur | fires when a control of Form has lost focus |
change | fires on changing the value of a control |
click | fires after a click on a button in a form |
focus | fires when a control of Form has received focus |
keydown | fires when any key is pressed |
Properties
Name | Description |
---|---|
align | Optional. Sets the alignment of controls inside the control group |
cols | Optional. Arranges controls inside the control group horizontally |
css | Optional. The name of a CSS class(es) applied to the control group |
disabled | Optional. Makes a form disabled |
height | Optional. Sets the height of the control group |
hidden | Optional. Defines whether a form is hidden |
padding | Optional. Sets padding for content inside the control group |
rows | Optional. Arranges controls inside the control group vertically |
title | Optional. Specifies the title of the control group |
width | Optional. Sets the width of the control group |
Avatar API
Avatar methods
Name | Description |
---|---|
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
Name | Description |
---|---|
afterChangeProperties | fires after configuration attributes of the control have been changed dynamically |
afterHide | fires after a control is hidden |
afterShow | fires after a control is shown |
afterValidate | fires after the control value is validated |
beforeChange | fires before changing the value of a control |
beforeChangeProperties | fires before configuration attributes of the control are changed dynamically |
beforeHide | fires before a control is hidden |
beforeShow | fires before a control is shown |
beforeUploadFile | fires before file upload begins |
beforeValidate | fires before the control value is validated |
blur | fires when the control has lost focus |
change | fires on changing the value of a control |
focus | fires when an Avatar control has received focus |
keydown | fires when any key is pressed and the Avatar control is in focus |
uploadBegin | fires when file upload begins |
uploadComplete | fires when upload is completed |
uploadFail | fires if the file upload failed |
uploadFile | fires when a file has been uploaded |
uploadProgress | fires on each percent of a file uploading |
Avatar properties
Button API
Button methods
Name | Description |
---|---|
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
Name | Description |
---|---|
afterChangeProperties | fires after configuration attributes of the control have been changed dynamically |
afterHide | fires after a Button control is hidden |
afterShow | fires after a Button control is shown |
beforeChangeProperties | fires before configuration attributes of the control are changed dynamically |
beforeHide | fires before a Button control is hidden |
beforeShow | fires before a Button control is shown |
blur | fires when a Button control has lost focus |
click | fires after a click on a Button control |
focus | fires when a Button control has received focus |
keydown | fires when any key is pressed and the Button control is in focus |
Button properties
DatePicker API
DatePicker methods
Name | Description |
---|---|
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 |