expandcollaps

dhtmlXTabBar object API

addTab(id, text, size, position, row)
add tab to TabBar
Topic(s):
File required:dhtmlxtabbar.js
  • id - tab id
  • text - tab content
  • size - width(height) of tab
  • position - tab index , optional
  • row - index of row, optional [only in PRO version]
    • clearAll()
    reinitialize tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
    disableTab(tab,mode)
    disable tab in tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
  • tab - id of tab
  • mode - if set to true, selection jump from current tab to nearest one
    • enableAutoReSize(mode)
    enable / disable auto adjusting height and width to outer conteiner
    Topic(s):
    File required:dhtmlxtabbar.js
  • mode - enable/disable
    • enableAutoRow(...) [professional]
    enable mode, in which new row created automatically to prevent tab scrollers
    Topic(s):
    File required:dhtmlxtabbar.js
    enableAutoSize(autoWidth,autoHeight)
    enable disable auto adjusting height and width to inner content
    Topic(s):
    File required:dhtmlxtabbar.js
  • autoWidth - enable/disable auto adjusting width
  • autoHeight - enable/disable auto adjusting height
    • enableContentZone(mode)
    enable/disable content zone (enabled by default)
    Topic(s):
    File required:dhtmlxtabbar.js
  • mode - true/false
    • enableForceHiding(mode)
    enable/disable force hiding mode, solves IE problems with iframes in HTML content, but can cause problems for other dhtmlx components inside tabs
    Topic(s):
    File required:dhtmlxtabbar.js
  • mode - true/false
    • enableScroll(...) [Professional]
    enable/disable scrollers ( enabled by default )
    Topic(s):
    File required:dhtmlxtabbar.js
    enableTab(tab)
    enable tab in tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
  • tab - id of tab
    • enableTabCloseButton(bool)
    enable mode, in which each tab has close button, mode will be applied to the tabs created AFTER command
    Topic(s):
    File required:dhtmlxtabbar.js
  • bool - false/true - enable/disable
    • forceLoad(tabId,href)
    forcing to load tab in question
    Topic(s):
    File required:dhtmlxtabbar.js
  • tabId - id of tab in question
  • href - new href, optional
    • getActiveTab()
    get id of current active tab
    Topic(s):
    File required:dhtmlxtabbar.js
    getLabel(tab)
    get label of tab
    Topic(s):
    File required:dhtmlxtabbar.js
  • tab - id of tab
    • goToNextTab(tab)
    select tab next to active
    Topic(s):
    File required:dhtmlxtabbar.js
    goToPrevTab(tab)
    select tab previous to active
    Topic(s):
    File required:dhtmlxtabbar.js
    hideTab(tab,mode)
    hide tab in tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
  • tab - id of tab
  • mode - if set to true, selection jump from current tab to nearest one
    • loadXML(file,afterCall)
    load tabbar from xml file
    Topic(s):
    File required:dhtmlxtabbar.js
  • file - link too XML file
  • afterCall - function which will be called after xml loading
    • loadXMLString(xmlString,afterCall)
    load tabbar from xml string
    Topic(s):
    File required:dhtmlxtabbar.js
  • xmlString - XML string
  • afterCall - function which will be called after xml loading
    • normalize(...) [professional]
    reformat tabbar to remove tab scrollers
    Topic(s):
    File required:dhtmlxtabbar.js
    preventIECashing(mode)
    prevent caching in IE by adding random seed to URL string
    Topic(s):
    File required:dhtmlxtabbar.js
  • mode - enable/disable random seed ( disabled by default )
    • removeTab(tab,mode)
    remove tab from tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
  • tab - id of tab
  • mode - if set to true, selection jump from current tab to nearest one
    • setAlign(align)
    set align of tabs on tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
  • align - left/right for gorizontal tabbar, top/bottom for vertical tabbar
    • setContent(id,nodeId)
    set content of tab
    Topic(s):
    File required:dhtmlxtabbar.js
  • id - id of tab
  • nodeId - id of container, or container object
    • setContentHTML(id,html)
    set content of tab, as HTML string
    Topic(s):
    File required:dhtmlxtabbar.js
  • id - id of tab
  • html - html string
    • setContentHref(id,href)
    set content as a href to an external file
    Topic(s):
    File required:dhtmlxtabbar.js
  • href - link too external file
    • setCustomStyle(id,color,scolor,css)
    set specific colors for specific tab
    Topic(s):
    File required:dhtmlxtabbar.js
  • id - id of tab for which setting will be applied
  • color - tab color
  • color - scolor - color in selected state ( optional)
  • css - css class will be attached to text of tab in question
    • setHrefMode(mode)
    set mode of loading external content
    Topic(s):
    File required:dhtmlxtabbar.js
  • mode - href mode - ifram/iframes/ajax
    • setImagePath(path)
    set path to image folder ( not affect already created element until their state changes )
    Topic(s):
    File required:dhtmlxtabbar.js
  • path - path to image folder
    • setLabel(tab,value)
    set label of tab
    Topic(s):
    File required:dhtmlxtabbar.js
  • tab - id of tab
  • value - new label
    • setMargin(margin)
    set distance between tabs
    Topic(s):
    File required:dhtmlxtabbar.js
  • margin - margin value
    • setOffset(offset)
    set offset before first tab on tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
  • offset - offset value
    • setOnLoadingEnd(...) [Professional]
    set function called after xml loading/parsing ended

    EventName:onXMLLoadingEnd
    event fired simultaneously with ending XML parsing, new items already available in tabbar
  • tabbar object
    • Topic(s):
    File required:dhtmlxtabbar.js
    setOnSelectHandler(func)
    set content of tab

    EventName:onSelect
    event called when any tab selected
  • id - id of tab

    • Event returns:if false returned the selection aborted
    Topic(s):
    File required:dhtmlxtabbar.js
  • id - id of tab
  • nodeId - id of container, or container object
    • setOnTabClose(func)
    set function called after tab closed, works only in "closeButton" mode

    EventName:onTabClose
    event fired imideatly before tab closed by pressing close button, returning false block closing
  • id of tab for which content loaded
    • Topic(s):
    File required:dhtmlxtabbar.js
  • func - event handling function
    • setOnTabContentLoaded(...) [Professional]
    set function called after tab content loaded ( works only for ajax based tabs )

    EventName:onTabLoaded
    event fired imideatly after tab content loaded and can be accessed through DOM
  • id of tab for which content loaded
    • Topic(s):
    File required:dhtmlxtabbar.js
    setSize(width,height,contentZone)
    set control size
    Topic(s):
    File required:dhtmlxtabbar.js
  • width - new width
  • height - new height
  • contentZone - if set to true, than width and height set only to content zone
    • setSkinColors(a_tab,p_tab,c_zone)
    allow to set skin specific color, must be used AFTER selecting skin
    Topic(s):
    File required:dhtmlxtabbar.js
  • a_tab - color of activ tab
  • p_tab - color of passive tab
  • c_zone - color of content zone (optional)
    • setStyle(name)
    set style used for tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
  • name - any valid style name
    • setTabActive(tabId,mode)
    switch tab to active state
    Topic(s):
    File required:dhtmlxtabbar.js
  • tabId - id of tab
  • mode - if to run onTabChanged handler (true by default)
    • showTab(tab)
    show hidden tab in tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
  • tab - id of tab
    • tabWindow(tab_id)
    return window of tab content for iframe based tabbar
    Topic(s):
    File required:dhtmlxtabbar.js
  • tab_id - tab id