DHTMLX Docs & Samples Explorer
Index
dhtmlxForm
API Methods (alphabetical list)
dhtmlXForm
- constructor
attachEvent
- attaches event to dhtmlxForm instance
checkItem
- checks item (checkbox and radio only)
clear
- clears items' values
detachEvent
- detaches event from dhtmlxForm instance
disableItem
- disables item
enableItem
- enables item
forEachItem
- iterator
getCalendar
- returns dhtmlxCalendar instance
getCheckedValue
- returns value of checked radio button in specified group (radio only)
getColorPicker
- returns dhtmlxColorPicker instance
getCombo
- returns dhtmlxCombo instance
getEditor
- returns dhtmlxEditor instance
getForm
- returns dhtmlxForm instance
getFormData
- gets hash of form data values
getInput
- returns item's object (text, textarea, password, calendar, colorpicker only)
getItemLabel
- returns item's label
getItemsList
- returns an array with the names of items
getItemType
- returns item's type
getItemValue
- returns item's value (input only)
getItemWidth
- returns item's width
getOptions
- returns options (select only)
getSelect
- returns item's object (select, multiselect only)
getUserData
- returns user data.
hideItem
- hides item
isItem
- returns true if item exists
isItemChecked
- returns true if item checked (checkbox and radio button only)
isItemEnabled
- returns true if item is enabled
isItemHidden
- returns true if item is hidden
isLocked
- returns true if form is locked
isReadonly
- returns true if item is readonly
load
- loads data from connector feed into the form
loadStruct
- loads configuration from
XML
file into dhtmlxForm instance
loadStructString
- loads configuration from
XML
string into dhtmlxForm instance
lock
- locks form (disables all items)
removeItem
- removes item
reset
- resets data to their original values
resetValidateCss
- resets
CSS
treatment for form validation
save
- saves data of the form in DB
send
- sends data to the server side script
setFontSize
- sets 'font-size' property for the whole form
setFormData
- sets values for all items in form
setItemFocus
- sets the keyboard focus to the specified item
setItemHeight
- sets item's height
setItemLabel
- sets item's label
setItemValue
- sets item's value (input only)
setItemWidth
- sets item's width
setReadonly
- makes item readonly
setSkin
- sets skin for form
setUserData
- allows to attach user data to form without needing to modify the
DOM
showItem
- shows item
validate
- validates form against defined validation rules
uncheckItem
- unchecks item (checkbox and radio only)
unload
- destructor. Removes dhtmlxForm instance and cleans used memory
unlock
- unlocks form (makes all items enabled).