expandcollaps

dhtmlXCombo object API

addOption(options)
add new option
Topic(s):
File required:dhtmlxcombo.js
  • value - (variable) - different input for different kinds of options - please refer to examples
    • clearAll(all)
    clear all options from combobox
    Topic(s):
    File required:dhtmlxcombo.js
  • value - (bool) clear current value as well
    • closeAll()
    close opened combobox list
    Topic(s):
    File required:dhtmlxcombo.js
    deleteOption(value)
    delete option by value
    Topic(s):
    File required:dhtmlxcombo.js
  • value - (string) value of option in question
    • destructor()
    destroy object and any related HTML elements
    Topic(s):
    File required:dhtmlxcombo.js
    disable(mode)
    disable combobox
    Topic(s):
    File required:dhtmlxcombo.js
  • mode - (boolean) disable combobox
    • enableFilteringMode(mode,url,cache,autosubload)
    switch between combobox and auto-filter modes
    Topic(s):
    File required:dhtmlxcombo.js
  • mode - (boolean) enable filtering mode
  • url - (string) url for filtering from XML, optional
  • cache - (boolean) XML caching, optional
  • autosubload - (boolean) enable auto load additional suggestions on selecting last loaded option
    • enableOptionAutoHeight(fl,maxHeight)
    enables or disables list auto height

    File required:dhtmlxcombo_whp.js
  • flag - (boolean) true/false
  • maxHeight - (int) height limitation (if a list height is bigger than maxHeight, a vertical scroll appears)
    • enableOptionAutoPositioning(fl)
    enables or disables options auto positioning

    File required:dhtmlxcombo_whp.js
  • flag - (boolean) true/false
    • enableOptionAutoWidth(fl)
    enables or disables options auto width

    File required:dhtmlxcombo_whp.js
  • flag - (boolean) true/false
    • getActualValue()
    get value which will be sent with form
    Topic(s):
    File required:dhtmlxcombo.js
    getChecked()
    gets list of checked options values

    File required:dhtmlxcombo_extra.js
    getComboText()
    get current text in combobox
    Topic(s):
    File required:dhtmlxcombo.js
    getIndexByValue(val)
    return index of item by value
    Topic(s):
    File required:dhtmlxcombo.js
  • value - (string) value of option in question
    • getOption(value)
    get Option by value
    Topic(s):
    File required:dhtmlxcombo.js
  • value - (string) value of option in question
    • getOptionByIndex(ind)
    get Option by index
    Topic(s):
    File required:dhtmlxcombo.js
  • ind - (int) index of option in question
    • getOptionByLabel(value)
    get Option by label
    Topic(s):
    File required:dhtmlxcombo.js
  • label - (string) label of option in question
    • getSelectedIndex()
    get index of selected option
    Topic(s):
    File required:dhtmlxcombo.js
    getSelectedText()
    get text of selected option
    Topic(s):
    File required:dhtmlxcombo.js
    getSelectedValue()
    get value of selected item
    Topic(s):
    File required:dhtmlxcombo.js
    loadXML(url,afterCall)
    load list of options from XML
    Topic(s):
    File required:dhtmlxcombo.js
  • url - (string) xml url
    • loadXMLString(astring)
    load list of options from XML string
    Topic(s):
    File required:dhtmlxcombo.js
  • astring - (string) xml string
    • openSelect()
    open list of options
    Topic(s):
    File required:dhtmlxcombo.js
    readonly(mode,autosearch)
    switch to readonly mode
    Topic(s):
    File required:dhtmlxcombo.js
  • mode - (boolean) readonly mode
  • autosearch - (boolean) true by default
    • render(mode)
    enable/disable immideatly rendering after changes in combobox
    Topic(s):
    File required:dhtmlxcombo.js
  • mode - (boolean) enable/disable
    • selectOption(ind,filter,conf)
    select option
    Topic(s):
    File required:dhtmlxcombo.js
  • ind - (int) index of option in question
  • filter - (boolean) enable autocomplit range, optional
  • conf - (boolean) true for real selection, false for pre-selection
    • setChecked(index)
    sets option checked

    File required:dhtmlxcombo_extra.js
  • index - option index
    • setComboText(text)
    set text in covmbobox
    Topic(s):
    File required:dhtmlxcombo.js
  • text - (string) new text label
    • setComboValue(text)
    set text in covmbobox
    Topic(s):
    File required:dhtmlxcombo.js
  • text - (string) new text label
    • setDefaultImage(url)


    File required:dhtmlxcombo_extra.js
  • url - url of default image
    • setName(name)
    set name used while form submit
    Topic(s):
    File required:dhtmlxcombo.js
  • name - (string) new combobox name
    • setOptionHeight(height)
    set height of combo list

    File required:dhtmlxcombo_whp.js
  • height - (number) height
    • setOptionWidth(width)
    set width of combo list

    File required:dhtmlxcombo_whp.js
  • width - (number) width
    • setSize(new_size)
    change control size
    Topic(s):
    File required:dhtmlxcombo.js
  • new_size - (int) new size value
    • show(mode)
    show combox ( reversion to hide command )
    Topic(s):
    File required:dhtmlxcombo.js
  • mode - (boolean) enable/disable
    • unSelectOption()
    deselect option
    Topic(s):
    File required:dhtmlxcombo.js
    updateOption(oldvalue, avalue, atext, acss)
    update option in combobox
    Topic(s):
    File required:dhtmlxcombo.js
  • oldvalue - (string) index of option in question
  • avalue - (variable)

    • dhtmlXRange object API