expandcollaps

dhtmlXToolbarObject object API

addItem(item,position)
add item to toolbar
Topic(s): Add/delete;
  • item - dhtmlXButton object
  • position - item position [not supported in current version]
  • disableItem(itemId)
    disable toolbar button
    Topic(s): Item control;
  • itemId - item id

  • Nested from:dhtmlXProtobarObject
    enableItem(itemId)
    enable toolbar button
    Topic(s): Item control;
  • itemId - item id

  • Nested from:dhtmlXProtobarObject
    getItem(itemId)
    return item object by id
    Topic(s): Item control;
  • itemId - item id

  • Nested from:dhtmlXProtobarObject
    getItemByPosition(position)
    return item object by position
    Topic(s): Item control;
  • position - item position
  • hideBar()
    hide toolbar
    Topic(s): Initialization;
    Nested from:dhtmlXProtobarObject
    hideButtons(idList)
    hide toolbar buttons
    Topic(s): Item control;
  • idList - list of items's ids, separated by comma

  • Nested from:dhtmlXProtobarObject
    hideItem(itemId)
    hide toolbar button
    Topic(s): Item control;
  • itemId - item id

  • Nested from:dhtmlXProtobarObject
    hideItemByPosition(position)
    hide toolbar button
    Topic(s): Item control;
  • position - item position
  • loadXML(file)
    load XML from file
    Topic(s): Initialization;
  • file - file name

  • Nested from:dhtmlXProtobarObject
    loadXMLString(xmlString)
    load XML from string
    Topic(s): Initialization;
  • xmlString - string contining XML

  • Nested from:dhtmlXProtobarObject
    removeItemById(itemId)
    remove item
    Topic(s): Add/delete;
  • itemId - item id
  • removeItemByPosition(position)
    remove item
    Topic(s): Add/delete;
  • position - item position
  • resetBar(idList)
    hide all items, show only items which ids in list
    Topic(s): Item control;
  • idList - list of id's, separated by comma

  • Nested from:dhtmlXProtobarObject
    setBarAlign(align)
    set toolbar buttons alignment (allowed - 'left','center','right','top','middle','bottom')
    Topic(s): Initialization;
  • align - buttons alignment

  • Nested from:dhtmlXProtobarObject
    setBarSize(width,height)
    set toolbar size
    Topic(s): Initialization;
  • width - toolbar width
  • height - toolbar height

  • Nested from:dhtmlXProtobarObject
    setItemAction(id,action)
    set item individual action
    Topic(s): Action handling;
  • id - item identificator
  • action - js function called on item selection

  • Nested from:dhtmlXProtobarObject
    setOnClickHandler(func)
    set default action
    Topic(s): Action handling;
  • action - set default action

  • Nested from:dhtmlXProtobarObject
    setOnHideHandler(func)
    set action hadler on toolbar hiding
    Topic(s): Action handling;
  • func - user defined function

  • Nested from:dhtmlXProtobarObject
    setOnShowHandler(func)
    set action hadler on toolbar showing
    Topic(s): Action handling;
  • func - user defined function

  • Nested from:dhtmlXProtobarObject
    setTitleText(newText)
    set toolbar tittle
    Topic(s): Initialization;
  • name - new tittle, shown on toolbar

  • Nested from:dhtmlXProtobarObject
    showBar()
    show toolbar
    Topic(s): Initialization;
    Nested from:dhtmlXProtobarObject
    showButtons(idList)
    show toolbar buttons
    Topic(s): Item control;
  • idList - list of items's ids, separated by comma

  • Nested from:dhtmlXProtobarObject
    showItem(id)
    show toolbar button
    Topic(s): Item control;
  • id - item id

  • Nested from:dhtmlXProtobarObject

    dhtmlXImageButtonObject object API

    disable()
    disable object
    Topic(s): Item control;
    Nested from:dhtmlXButtonPrototypeObject
    enable()
    enable object
    Topic(s): Item control;
    Nested from:dhtmlXButtonPrototypeObject
    setAction(func)
    set default action, action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject
    setAltText(imageText)
    set alt text of button image
    Topic(s): Item control;
  • imageText - new alt image text

  • Nested from:dhtmlXButtonPrototypeObject
    setHTML(htmlText)
    set innerHTML of button
    Topic(s): Item control;
  • htmlText - new text

  • Nested from:dhtmlXButtonPrototypeObject
    setImage(imageSrc)
    set image href
    Topic(s): Item control;
  • imageSrc - new image href

  • Nested from:dhtmlXButtonPrototypeObject
    setSecondAction(func)
    set personal onClick action (action must return false for preventing calling default action after personal), action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject

    dhtmlXToolbarDividerYObject object API

    disable()
    disable object
    Topic(s): Item control;
    Nested from:dhtmlXButtonPrototypeObject
    enable()
    enable object
    Topic(s): Item control;
    Nested from:dhtmlXButtonPrototypeObject
    setAction(func)
    set default action, action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject
    setAltText(imageText)
    set alt text of button image
    Topic(s): Item control;
  • imageText - new alt image text

  • Nested from:dhtmlXButtonPrototypeObject
    setHTML(htmlText)
    set innerHTML of button
    Topic(s): Item control;
  • htmlText - new text

  • Nested from:dhtmlXButtonPrototypeObject
    setImage(imageSrc)
    set image href
    Topic(s): Item control;
  • imageSrc - new image href

  • Nested from:dhtmlXButtonPrototypeObject
    setSecondAction(func)
    set personal onClick action (action must return false for preventing calling default action after personal), action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject

    dhtmlXToolbarDividerXObject object API

    disable()
    disable object
    Topic(s): Item control;
    Nested from:dhtmlXButtonPrototypeObject
    enable()
    enable object
    Topic(s): Item control;
    Nested from:dhtmlXButtonPrototypeObject
    setAction(func)
    set default action, action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject
    setAltText(imageText)
    set alt text of button image
    Topic(s): Item control;
  • imageText - new alt image text

  • Nested from:dhtmlXButtonPrototypeObject
    setHTML(htmlText)
    set innerHTML of button
    Topic(s): Item control;
  • htmlText - new text

  • Nested from:dhtmlXButtonPrototypeObject
    setImage(imageSrc)
    set image href
    Topic(s): Item control;
  • imageSrc - new image href

  • Nested from:dhtmlXButtonPrototypeObject
    setSecondAction(func)
    set personal onClick action (action must return false for preventing calling default action after personal), action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject

    dhtmlXImageTextButtonObject object API

    disable()
    disable object
    Topic(s): Item control;
    Nested from:dhtmlXButtonPrototypeObject
    enable()
    enable object
    Topic(s): Item control;
    Nested from:dhtmlXButtonPrototypeObject
    setAction(func)
    set default action, action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject
    setAltText(imageText)
    set alt text of button image
    Topic(s): Item control;
  • imageText - new alt image text

  • Nested from:dhtmlXButtonPrototypeObject
    setHTML(htmlText)
    set innerHTML of button
    Topic(s): Item control;
  • htmlText - new text

  • Nested from:dhtmlXButtonPrototypeObject
    setImage(imageSrc)
    set button image
    Topic(s): Item control;
  • newText - new text [ HTML allowed ]
  • setSecondAction(func)
    set personal onClick action (action must return false for preventing calling default action after personal), action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject
    setText(newText)
    set button text
    Topic(s): Item control;
  • newText - new text [ HTML allowed ]
  • dhtmlXSelectButtonObject object API

    addOption(value,display)
    add option to dropdown
    Topic(s):
  • value - string value (sended to action function)
  • display - displayed string
  • disable()
    disable object
    Topic(s): Item control;
    enable()
    enable object
    Topic(s): Item control;
    getIndexByValue(value)
    return string index in dropdown by value (return -1 if string with given value not found)
    Topic(s): Initialization;
  • value - string value
  • removeOption(value)
    remove string from dropdown
    Topic(s):
  • value - string value
  • setAction(func)
    set default action, action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject
    setAltText(imageText)
    set alt text of button image
    Topic(s): Item control;
  • imageText - new alt image text

  • Nested from:dhtmlXButtonPrototypeObject
    setHTML(htmlText)
    set innerHTML of button
    Topic(s): Item control;
  • htmlText - new text

  • Nested from:dhtmlXButtonPrototypeObject
    setImage(imageSrc)
    set image href
    Topic(s): Item control;
  • imageSrc - new image href

  • Nested from:dhtmlXButtonPrototypeObject
    setOptionText(value,newText)
    change option text
    Topic(s):
  • value - option value
  • newText - new option text
  • setOptionValue(oldValue,newValue)
    change string value
    Topic(s):
  • oldValue - old string value
  • newValue - new string value
  • setSecondAction(func)
    set personal onClick action (action must return false for preventing calling default action after personal), action function take one parametr - item id
    Topic(s): Action handling;
  • func - js function

  • Nested from:dhtmlXButtonPrototypeObject
    setSelected(value)
    select string by value
    Topic(s):
  • value - string value