Automatic Data Binding

  • 2 minutes to read

ASPxNavBar has a built-in ability to automatically retrieve data from a data source that supports the IHierarchicalEnumerable or IHierarchicalDataSource interface. This topic describes the conditions that allow ASPxNavBar to bind automatically.

ASPxNavBar can recognize data items, and retrieve some group and item characteristics from the data fields named in a specific way. If however, any of the data-related properties of ASPxNavBar (such as TextField, ImageUrlField, etc.) have been set, then the mapping of the associated object properties will proceed according to Data Binding Using Mapping Properties.

Data fields and group/item properties name match

During binding, ASPxNavBar implements its automatic binding ability by retrieving group/item characteristics from those data fields whose names coincide with certain property names of a NavBarGroup or NavBarItem object. The tables below list the names of the object properties that can be mapped during automatic binding, and the matching data field names you should use in the data source for mapping to work.

Data field names Group properties that can be set automatically
Enabled NavBarGroup.Enabled
Expanded NavBarGroup.Expanded
HeaderImageUrl NavBarGroup.HeaderImage.Url
Name NavBarGroup.Name
NavigateUrl NavBarGroup.NavigateUrl
Target NavBarGroup.Target
Text NavBarGroup.Text
ToolTip NavBarGroup.ToolTip
Visible NavBarGroup.Visible
Data field names Item properties that can be set automatically
Enabled NavBarItem.Enabled
ImageUrl NavBarItem.Image.Url
Name NavBarItem.Name
NavigateUrl NavBarItem.NavigateUrl
Selected NavBarItem.Selected
Target NavBarItem.Target
Text NavBarItem.Text
ToolTip NavBarItem.ToolTip
Visible NavBarItem.Visible

The following image illustrates the process of data retrieval during automatic binding to a particular type of data source - XmlDataSource.

ASPxNavBar_BindAuto

Binding to a Site Map

Since the properties of a SiteMapNode object have specific names, the ASPxNavBar control is designed to automatically bind to a Site Map source with node attributes of similar names. In the binding process, corresponding properties of individual NavBarGroup and NavBarItem objects are automatically associated with these item attributes, and mapped accordingly. See the table below for name correspondence.

Site Map node attributes Corresponding Group object properties Corresponding Item object properties
Description NavBarGroup.ToolTip NavBarItem.ToolTip
Title NavBarGroup.Text NavBarItem.Text
Url NavBarGroup.NavigateUrl NavBarItem.NavigateUrl

Note

The structure of a Site Map allows some flexibility in the naming of item attributes. After ASPxNavBar detects the item attributes named title, url and description in the bound Site Map source, the conditions described in the above section apply.