Skip to main content

Ribbon API overview

Ribbon methods#

NameDescription
destructor()removes a Ribbon instance and releases occupied resources
disable()disables and dims an item(s) of Ribbon
enable()enables a disabled item(s) of Ribbon
getSelected()returns an array of IDs of selected items
getState()gets current values/states of controls
hide()hides an item of Ribbon
isDisabled()checks whether an item of Ribbon is disabled
isSelected()checks whether a specified Ribbon item is selected
paint()repaints Ribbon on a page
select()selects a specified item of Ribbon
setState()sets values/states of controls
show()shows an item of Ribbon
unselect()unselects a selected Ribbon item
important

Use TreeCollection methods to work with data.

Ribbon events#

NameDescription
clickfires after a click on a control
inputBlurfires when a control is blurred
inputCreatedfires when a new input is added
inputFocusfires when a control is focused
openMenufires on expanding a menu control
important

Use TreeCollection events to work with data.

Ribbon properties#

NameDescription
cssadds style classes to Ribbon
dataspecifies an array of data objects to set into Ribbon
menuCssadds style classes to all containers of Ribbon controls with nested items

Ribbon Block properties#

A Block control can possess the following properties.

Ribbon Button properties#

A Button control can have the following properties.

Ribbon Custom HTML properties#

A Custom HTML control may have the following properties.

Ribbon ImageButton properties#

An ImageButton control can possess the following properties.

Ribbon Input properties#

An Input control can have the following properties.

Ribbon NavItem properties#

A NavItem control can have the following properties.

Ribbon SelectButton properties#

A SelectButton control can have the following properties.

Ribbon Separator properties#

A Separator control may possess the following properties.

Ribbon Spacer properties#

A Spacer control can have the following properties.

Ribbon Title properties#

A Title control may possess the following properties.