This documentation is archived and is not being maintained.

TreeNodeBinding.ImageToolTip Property

Gets or sets the ToolTip text for the image that is displayed next to a node to which the TreeNodeBinding object is applied.

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

public string ImageToolTip { get; set; }

Property Value

Type: System.String
The ToolTip text for the image that is displayed next to a node to which the TreeNodeBinding object is applied. The default is an empty string (""), which indicates that the P:System.Web.UI.WebControls.TreeNodeBinding.ImageToolTip property is not set.

When the TreeView control is bound to a data source, use the ImageToolTip property to specify the value to bind to the ImageToolTip property of a TreeNode object. The text that you specify provides Assistive Technology devices with a description of the image that can be used to make the control more accessible.

This binding relationship affects all TreeNode objects to which the TreeNodeBinding object is applied. When an image is displayed next to a node, the ToolTip text is displayed when the mouse pointer is positioned over the image.

NoteNote:

You can selectively override the ImageToolTip property by setting the ImageToolTip property of each node directly.

Instead of using the ImageToolTip property to bind the same ToolTip text to each node image, you can bind the ImageToolTip property of a TreeNode object to a field of a data source by setting the ImageToolTipField property.

The value of this property is stored in view state.

The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and ASP.NET Globalization and Localization.

This section contains two code examples. The first code example demonstrates how to use the ImageToolTip property to specify the ToolTip text for the image that is displayed next to a node to which the TreeNodeBinding object is applied. The second code example provides sample XML data for the first code example.

The following example demonstrates how to use the ImageToolTip property to specify the ToolTip text for the image that is displayed next to a node 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 Text, ImageUrl, ImageToolTip, -->
      <!-- NavigateUrl, Value, and ToolTip       -->
      <!-- 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" 
            Text="Book Title" 
            ImageUrl="Image.jpg"
            ImageToolTip="Book Image" 
            NavigateUrl="http://www.microsoft.com" 
            Value="BookID" 
            ToolTip="Book Information"/>
          <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 code 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>

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: