This documentation is archived and is not being maintained.

MenuItemBinding::ValueField Property

Gets or sets the name of the field from the data source to bind to the Value property of a MenuItem object to which the MenuItemBinding object is applied.

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

[TypeConverterAttribute(L"System.Web.UI.Design.DataSourceViewSchemaConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public:
property String^ ValueField {
	String^ get ();
	void set (String^ value);
}

Property Value

Type: System::String
The name of the field to bind to the Value of a MenuItem to which the MenuItemBinding is applied. The default is an empty string (""), which indicates that this property is not set.

When the Menu control is bound to a data source, use the ValueField property to specify the name of the field to bind to the Value property of a MenuItem object. When rendered, the Value property of each menu item to which the MenuItemBinding object is applied contains the corresponding value from the field. The specified value is not displayed in a menu item and is used to store any additional data about a menu item to which the MenuItemBinding object is applied, such as data used for handling postback events.

NoteNote

You can override the value for an individual menu item by setting its Value property directly.

If the data source contains multiple tables or attributes, you must first establish the binding criteria by setting the Depth property, the DataMember property, or both.

Instead of using this property to bind the Value property of a MenuItem object to a field, you can also bind it to a static value by setting the MenuItemBinding::Value property. This allows you to specify the same value for each menu item to which the MenuItemBinding object is applied.

NoteNote

If the Value and ValueField properties are both set, the ValueField property takes precedence.

The following code example demonstrates how to use the ValueField property to specify the name of the field to bind to the Value property of a menu item. For this example to work correctly, you must copy the sample XML data below to a file named Menu.xml.

No code example is currently available or this language may not be supported.

The following code is sample site map data for the previous example.

<MapHomeNode ImageUrl="~\Images\Home.gif"

Title="Home"

Description="Root Page"

ToolTip="Home Page">

<MapNode ImageUrl="~\Images\Music.gif"

Title="Music"

Description="Music Category"

ToolTip="Music Page">

<MapNode ImageUrl="~\Images\Classical.gif"

Title="Classical"

Description="Classical Section"

ToolTip="Classical Page"/>

<MapNode ImageUrl="~\Images\Rock.gif"

Title="Rock"

Description="Rock Section"

ToolTip="Rock Page"/>

<MapNode ImageUrl="~\Images\Jazz.gif"

Title="Jazz"

Description="Jazz Section"

ToolTip="Jazz Page"/>

</MapNode>

<MapNode ImageUrl="~\Images\Movies.gif"

Title="Movies"

Description="Movies Category"

ToolTip="Movies Page">

<MapNode ImageUrl="~\Images\Action.gif"

Title="Action"

Description="Action Section"

ToolTip="Action Page"/>

<MapNode ImageUrl="~\Images\Drama.gif"

Title="Drama"

Description="Drama Section"

ToolTip="Drama Page"/>

<MapNode ImageUrl="~\Images\Musical.gif"

Title="Musical"

Description="Musical Section"

ToolTip="Musical Page"/>

</MapNode>

</MapHomeNode>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: