Export (0) Print
Expand All

TreeNodeBinding.ImageUrlField Property

Gets or sets the name of the field from the data source to bind to the ImageUrl property of a TreeNode object to which the TreeNodeBinding object is applied.

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

[TypeConverterAttribute("System.Web.UI.Design.DataSourceViewSchemaConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public string ImageUrlField { get; set; }

Property Value

Type: System.String
The name of the field to bind to the ImageUrl property of a TreeNode object to which the TreeNodeBinding object is applied. The default is an empty string (""), which indicates that the ImageUrlField property is not set.

When the TreeView control is bound to a data source, use the ImageUrlField property to specify the name of the field to bind to the ImageUrl property of a TreeNode object. This binding relationship affects all TreeNode objects to which the TreeNodeBinding object is applied. The image is displayed next to a node and can be in any file format (.jpg, .gif, .bmp, and so on), as long as the client browser supports the format.

NoteNote

You can override the image for an individual node by setting its ImageUrl property directly.

Instead of using this property to bind the ImageUrl property of a TreeNode object to a field, you can set the ImageUrl property to a fixed value by setting the ImageUrl property.

NoteNote

If the data source contains multiple fields, you must first set the Depth or DataMember property, or both properties in order to bind to the appropriate field.

When displaying an image next to a node with the ImageUrlField property, you should also consider setting the ImageToolTipField property. The ToolTip text that you specify provides Assistive Technology devices with a description of the image that can be used to make the control more accessible.

The value of this property is stored in view state.

This section contains two code examples. The first code example demonstrates how to use the ImageUrlField property to specify which attribute of an XML element to bind to the ImageUrl property of a TreeNode object to which the TreeNodeBinding object is applied. The second code example provides sample XML data for the first code example.

The following code example demonstrates how to use the ImageUrlField property to specify which attribute of an XML element to bind to the ImageUrl property of a TreeNode object to which the TreeNodeBinding object is applied. For this example to work correctly, you must copy the sample XML data, provided after this code example, to a file named Booklist.xml.



<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>TreeViewBinding Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>TreeViewBinding Example</h3>

      <!-- Set the TextField, ImageUrlField, NavigateUrlField, -->
      <!-- ValueField, and ToolTipField properties of a    -->
      <!-- TreeNodeBinding object declaratively.         -->
      <asp:TreeView id="BookTreeView" 
        DataSourceID="BookXmlDataSource"
        Target="_blank" 
        runat="server">

        <DataBindings>
          <asp:TreeNodeBinding DataMember="Books" 
            Depth="0" 
            TextField="Text"/>
          <asp:TreeNodeBinding DataMember="Book" 
            Depth="1" 
            TextField="Text" 
            ImageUrlField="Image"
            ImageToolTipField="ImageToolTip" 
            NavigateUrlField="Nav" 
            ValueField="Value" 
            ToolTipField="Tip"/>
          <asp:TreeNodeBinding DataMember="Description" 
            Depth="2" 
            TextField="Text"/>
          <asp:TreeNodeBinding DataMember="Price" 
            Depth="2" 
            TextField="Value"/>
        </DataBindings>

      </asp:TreeView>

      <asp:XmlDataSource id="BookXmlDataSource"  
        DataFile="Booklist.xml"
        runat="server">
      </asp:XmlDataSource>

    </form>
  </body>
</html>



The following code example provides sample XML data for the preceding example.

<Books Text="Books List">
    <Book Text="Book Title One"
        Value="1" 
        Image="Bookimage1.jpg"
        ImageToolTip="Book 1 Photo" 
        Nav="http://www.microsoft.com"
        Tip="Book Title 1">
        <Description Text="Book Description">
        </Description>
        <Price Value="$1.99">
        </Price>
        <Author Text="Author Name"
            Value="LastName" 
            Image="Authorimage1.jpg" 
            Nav="http://www.microsoft.com"
            Tip="Author Name">
        </Author>
    </Book>
    <Book Text="Book Title Two"
        Value="2" 
        Image="Bookimage2.jpg"
        ImageToolTip="Book 2 Photo" 
        Nav="http://www.microsoft.com"
        Tip="Click Me">
        <Description Text="Book Description">
        </Description>
        <Price Value="$2.99">
        </Price>
        <Author Text="Author Name"
            Value="LastName" 
            Image="Authorimage2.jpg" 
            Nav="http://www.microsoft.com"
            Tip="Author Name">
        </Author>
    </Book>
</Books>

.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.

Community Additions

ADD
Show:
© 2015 Microsoft