Ribbon
- 2 minutes to read
The Ribbon is displayed at the top of the editor. It serves as the main menu for the editor and contains ribbon item elements. The Ribbon is displayed when the ASPxHtmlEditor.ToolbarMode property is set to Ribbon.
The style settings of ribbon elements are specified by the ToolbarsStyles.Ribbon property.
Tabs
The collection of ribbon tabs can be customized using the ASPxHtmlEditor.RibbonTabs property. The table below lists the main members that affect ribbon tab appearance and functionality.
| Characteristics | Members |
|---|---|
| Text | RibbonTab.Text |
| Visibility | RibbonTab.Visible |
Groups
Groups are contained in a tab’s RibbonTab.Groups collection, and are used to divide ribbon items within a tab into logical groups. The table below lists the main members that affect ribbon group appearance and functionality.
| Characteristics | Members |
|---|---|
| Text | RibbonGroup.Text |
| Group Expand Button Image | RibbonGroup.Image |
| Visibility | RibbonGroup.Visible |
| Items | RibbonGroup.Items |
Items
Items are contained in a group’s RibbonGroup.Items collection. An action on an item (e.g., a button click or an editor value change) performs the corresponding action. The table below lists the main members that affect ribbon item appearance and functionality.
| Characteristics | Members |
|---|---|
| Text | RibbonItemBase.Text |
| Image | RibbonButtonItem.SmallImage, RibbonButtonItem.LargeImage |
| Tooltip | RibbonItemBase.ToolTip |
| Style | RibbonItemBase.ItemStyle |
| Size | RibbonItemBase.Size |
| Item Separator Visibility | RibbonItemBase.BeginGroup |
| Visibility | RibbonItemBase.Visible |
Context Tab Category
The collection of ribbon context tab categories can be customized using the ASPxHtmlEditor.RibbonContextTabCategories property. A context tab category is a container for context tabs, which are hidden tabs that are displayed on demand, e.g., when a corresponding element, such as an image or a table, is selected. The table below lists the main members that affect ribbon group appearance and functionality.
| Characteristics | Members |
|---|---|
| Color | RibbonContextTabCategory.Color |
| Tabs | RibbonContextTabCategory.Tabs |
| Visibility | RibbonContextTabCategory.Visible, RibbonContextTabCategory.ClientVisible |