Tab
A newer version of this page is available. Switch to the current version.

NavBarItemDataFields.TextField Property

Gets or sets the name of a data field (or an xml element's attribute) which provides item texts.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

[DefaultValue("")]
public override string TextField { get; set; }
<DefaultValue("")>
Public Overrides Property TextField As String

Property Value

Type Default Description
String

String.Empty

A string value that specifies the name of the required data source field.

Remarks

The TextField property is in effect if the NavBarItemDataFields control is bound to a data source (via the ASPxDataWebControlBase.DataSourceID or ASPxDataWebControlBase.DataSource property).

Use the TextField property to specify the bound data source's data field (or an xml element's attribute) which stores navbar item texts. The TextField property maps the NavBarItem.Text properties of NavBarItem objects to the specified data field's values.

You can format the obtained texts by using the NavBarItemDataFields.TextFormatString property.

If the TextField property of a data bound NavBarItemDataFields control is not defined, the control can automatically obtain item texts from a data field whose name is "Text" (which is equal to the NavBarItem.Text property's name). You can also handle the ASPxNavBar.ItemDataBound event to manipulate an item's settings as required.

Examples

In the code sample below, the ASPxNavBar control is bound to an XML file using a standard XmlDataSource component. The item/group NavigateUrlField and TextField properties are used to specify the names of data item attributes from which the corresponding item/group settings should be obtained. The ItemDataBound and GroupDataBound events are handled to add corresponding images to items and groups respectively.

The image below shows the result.

ASPxNavBar_DataBoundEvents

protected void ASPxNavBar1_ItemDataBound(object source, DevExpress.Web.NavBarItemEventArgs e) {
     System.Xml.XmlNode dataItem = ((e.Item.DataItem as IHierarchyData).Item as System.Xml.XmlNode);
     switch (dataItem.Name) {
          case "ctor":
               e.Item.Image.Url = "Images/ctor.gif";
               break;
          case "property":
               e.Item.Image.Url = "Images/property.gif";
               break;
          case "method":
               e.Item.Image.Url = "Images/method.gif";
               break;
          case "event":
               e.Item.Image.Url = "Images/event.gif";
               break;
     }
}

protected void ASPxNavBar1_GroupDataBound(object source, DevExpress.Web.NavBarGroupEventArgs e) {
     e.Group.HeaderImage.Url = "Images/class.gif";
}
See Also