Ribbon Data-Related Properties

  • 2 minutes to read

When the ASPxRibbon control binds to an arbitrary data source (specified by the ASPxHierarchicalDataWebControl.DataSourceID or ASPxDataWebControlBase.DataSource property), RibbonTab, RibbonGroup, and RibbonItemBase objects are created automatically for each recognized data item.

Individual object characteristics (such as text, name and image path) are obtained from the data fields (item attributes) of the corresponding data items. The ASPxRibbon exposes specific data-related properties, allowing you to specify which data source fields the tab, group, and item information should be retrieved from. The table below lists these properties and the corresponding properties of bound objects.

The ASPxRibbon.TabDataFields property provides access to the following tab data-related properties.

Property Default Value Ribbon Tab Object Property
RibbonDataFields.AccessKeyField AccessKey RibbonTab.AccessKey
RibbonTabDataFields.ContextTabCategoryNameField CategoryName RibbonTab.ContextTabCategory
RibbonTabDataFields.ColorField Color RibbonContextTabCategory.Color
RibbonDataFields.NameField Name RibbonTab.Name
RibbonDataFields.TextField Text RibbonTab.Text

The ASPxRibbon.GroupDataFields property provides access to the following group data-related properties.

Property Default Value Ribbon Group Object Property
RibbonDataFields.AccessKeyField AccessKey RibbonGroup.AccessKey
RibbonGroupDataFields.DialogBoxLauncherAccessKeyField DialogBoxLauncherAccessKey RibbonGroup.DialogBoxLauncherAccessKey
RibbonGroupDataFields.ImageUrlField ImageUrl RibbonGroup.Image.Url
RibbonDataFields.NameField Name RibbonGroup.Name
RibbonDataFields.TextField Text RibbonGroup.Text

The ASPxRibbon.ItemDataFields property provides access to the following item data-related properties.

Property Default Value Ribbon Item Object Property
RibbonDataFields.AccessKeyField AccessKey RibbonItemBase.AccessKey
RibbonItemDataFields.BeginGroupField BeginGroup RibbonItemBase.BeginGroup
RibbonItemDataFields.ItemTypeField ItemType See the description below the table.
RibbonItemDataFields.LargeImageUrlField LargeImageUrl RibbonButtonItem.LargeImage.Url
RibbonDataFields.NameField Name RibbonItemBase.Name
RibbonItemDataFields.NavigateUrlField NavigateUrl RibbonButtonItem.NavigateUrl
RibbonItemDataFields.OptionGroupNameField OptionGroupName RibbonOptionButtonItem.OptionGroupName
RibbonItemDataFields.SizeField Size RibbonItemBase.Size
RibbonItemDataFields.SmallImageUrlField SmallImageUrl RibbonButtonItem.SmallImage.Url
RibbonDataFields.TextField Text RibbonItemBase.Text
RibbonItemDataFields.ToolTipField Tooltip RibbonItemBase.ToolTip

The ItemType attribute specifies which item type will be used to render the current item in the ribbon. The available attribute values and the corresponding ribbon item types are listed below.

Attribute Value Ribbon Item Type
Button RibbonButtonItem
CheckBox RibbonCheckBoxItem
ColorButton RibbonColorButtonItem
ComboBox RibbonComboBoxItem
DateEdit RibbonDateEditItem
DropDownButton RibbonDropDownButtonItem
DropDownToggleButton RibbonDropDownToggleButtonItem
GalleryBar RibbonGalleryBarItem
GalleryDropDown RibbonGalleryDropDownItem
OptionButton RibbonOptionButtonItem
SpinEdit RibbonSpinEditItem
TextBox RibbonTextBoxItem
ToggleButton RibbonToggleButtonItem
See Also