API Methods (alphabetical list)

• dhtmlXForm - constructor

• addItem - adds a new item
• adjustParentSize - adjusts the size of the parent container to the form content
• attachEvent - attaches event to dhtmlxForm instance
• bind - binds components
• checkItem - checks item (checkbox and radio only)
• clear - clears items' values
• clearNote - removes the note block from the input
• clearValidation - removes all validation rules from the input
• detachEvent - detaches event from dhtmlxForm instance
• disableItem - disables item
• enableItem - enables item
• enableLiveValidation - sets the mode when validation is invoked just after an input goes out of focus
• 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
• getContainer - returns the HTMLDivElement object of the container control
• 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
• getItemWidth - returns item's width
• getOptions - returns options (select, multiselect 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
• setCalendarDateFormat - sets the format of date presentation in the calendar input
• setFocusOnFirstActive - moves the focus on first form's element
• 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
• setItemWidth - sets item's width
• setNote - adds the note block under the specified input
• setNumberFormat - sets format of numeric data
• setReadonly - makes item readonly
• setRequired - makes/unmaks a certain field required
• setSkin - sets skin for form
• setValidateCss -sets CSS treatment for form validation
• setValidation - adds a validation rule to the input with the specified name
• setUserData - allows to attach user data to form without needing to modify the DOM
• showItem - shows item
• validate - validates form against defined validation rules
• validateItem - validates the specified form item
• uncheckItem - unchecks item (checkbox and radio only)
• unload - destructor. Removes dhtmlxForm instance and cleans used memory
• unlock - unlocks form (makes all items enabled)
• updateValues - updates values of inputs. Invokes validation inside.

applied to form

• getUploader - returns the upload item instance
• getUploaderStatus - returns the status of uploading

applied to uploader instance

• upload - starts uploading
• getData - returns the list of already uploaded files
• getStatus - same as getUploaderStatus, but applied to uploader instance
• clear - clears list with files to upload
• enableTitleScreen - enables displaying the initial screen (when no files are selected)
• setTitleText - sets the text of the initial screen
• setAutoStart - called with the true value, the method enables the mode in which files are immediately loaded after selecting
• setAutoRemove - called with the true value, the method enables the mode in which files are immediately removed from the item after complete downloading
• setURL - redefines the url parameter
• setSWFURL - redefines the setSWFURL parameter

• saveBackup - creates a backup of the form
• restoreBackup - restores the specified backup
• clearBackup - deletes the specified backup