dhtmlXRibbon API

Methods
attachEvent adds any user-defined handler to available events
check checks the specified checkbox
detachEvent detaches a handler from an event
disable disables the specified item in the ribbon
enable enables the specified item in the ribbon
getCombo returns dhtmlxCombo instance
getInput gets an input's object by id
getItemOptionText returns the text of buttonSelect item's option
getItemState returns the current state of a buttonTwoState or a buttonSegmented
getItemText returns the text of an item's label
getItemType returns item type by item id
getValue returns the current value of a slider or an input item
hide hides the specified item (or a block of items) in the ribbon
isChecked checks whether the specified checkbox is checked
isEnabled checks if the specified item is enabled
isVisible checks if the specified item is visible
loadStruct loads data to the component via XML or JSON, usually component config
removeItem completely removes an item from Ribbon
setIconPath sets the path to the used images
setIconset sets the iconset for Ribbon
setItemImage sets an image for an item in the enabled state
setItemImageDis sets an image for an item in the disabled state
setItemOptionText sets text for an item's option of buttonSelect
setItemState sets pressed/released state for a two-state button
setItemText sets an item's label text
setSizes adjusts the size of the ribbon when the parent's size is changed
setSkin sets a skin for dhtmlXRibbon on the fly
setValue sets a value for a slider or an input item
show shows the specified item (or a block of items) in the ribbon
tabs returns dhtmlXTabBarCell instance (ribbon's tab)
uncheck removes the checkmark from a checkbox
unload destructor, removes the ribbon
Events
onCheck fires after a checkbox has been checked/unchecked
onClick fires when the user clicks the left mouse button on a button or a buttonSelect items
onEnter fires when the user presses the "Enter" button inside of an input item
onSelect fires when a tab is selected
onSelectOption fires when the user clicks on an option in the combo list
onStateChange fires when the user changes the state of a two-state button item
onTabClick fires when the user clicks on a tab
onTabClose fires when the user presses the "Close" button on a tab
onValueChange fires when the user changes the value of a slider item
onXLE fires when the data loading is finished and a component or data is rendered
onXLS fires when XML loading started
Back to top