TreeView.HoverNodeStyle Property

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a reference to the TreeNodeStyle object that allows you to set the appearance of a node when the mouse pointer is positioned over it.

public:
 property System::Web::UI::WebControls::Style ^ HoverNodeStyle { System::Web::UI::WebControls::Style ^ get(); };

[System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerProperty)]
public System.Web.UI.WebControls.Style HoverNodeStyle { get; }

[<System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerProperty)>]
member this.HoverNodeStyle : System.Web.UI.WebControls.Style

Public ReadOnly Property HoverNodeStyle As Style

Property Value

Style

A reference to the TreeNodeStyle that represents the style of a node when the mouse pointer is positioned over it.

Attributes: PersistenceModeAttribute

Examples

The following code example demonstrates how to use the HoverNodeStyle property to control the appearance of a node when the mouse pointer is positioned over it. For this example to work, you must include a <head> element with a runat="server" attribute.


<%@ 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" >

  <!-- The HoverNodeStyle property needs this head element to work. -->
  <head runat="server">
    <title>TreeView HoverNodeStyle Example</title>
</head>

  <body>
    <form id="form1" runat="server">
    
      <h3>TreeView HoverNodeStyle Example</h3>
      
      <!-- Declaratively set the HoverNodeStyle settings. --> 
      <asp:TreeView id="LinksTreeView"
        HoverNodeStyle-ForeColor="Green"
        runat="server">
         
        <Nodes>
        
          <asp:TreeNode Value="Home" 
            NavigateUrl="Home.aspx" 
            Text="Home"
            Target="Content" 
            Expanded="True">
             
            <asp:TreeNode Value="Page 1" 
              NavigateUrl="Page1.aspx" 
              Text="Page1"
              Target="Content">
               
              <asp:TreeNode Value="Section 1" 
                NavigateUrl="Section1.aspx" 
                Text="Section 1"
                Target="Content"/>
                 
            </asp:TreeNode>              
            
            <asp:TreeNode Value="Page 2" 
              NavigateUrl="Page2.aspx"
              Text="Page 2"
              Target="Content">
               
            </asp:TreeNode> 
            
          </asp:TreeNode>
        
        </Nodes>
        
      </asp:TreeView>

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


<%@ Page Language="VB" %>

<!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" >

  <!-- The HoverNodeStyle property needs this head element to work. -->
  <head runat="server">
    <title>TreeView HoverNodeStyle Example</title>
</head>

  <body>
    <form id="form1" runat="server">
    
      <h3>TreeView HoverNodeStyle Example</h3>
      
      <!-- Declaratively set the HoverNodeStyle settings. --> 
      <asp:TreeView id="LinksTreeView"
        HoverNodeStyle-ForeColor="Green"
        runat="server">
         
        <Nodes>
        
          <asp:TreeNode Value="Home" 
            NavigateUrl="Home.aspx" 
            Text="Home"
            Target="Content" 
            Expanded="True">
             
            <asp:TreeNode Value="Page 1" 
              NavigateUrl="Page1.aspx" 
              Text="Page1"
              Target="Content">
               
              <asp:TreeNode Value="Section 1" 
                NavigateUrl="Section1.aspx" 
                Text="Section 1"
                Target="Content"/>
                 
            </asp:TreeNode>              
            
            <asp:TreeNode Value="Page 2" 
              NavigateUrl="Page2.aspx"
              Text="Page 2"
              Target="Content">
               
            </asp:TreeNode> 
            
          </asp:TreeNode>
        
        </Nodes>
        
      </asp:TreeView>

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

Remarks

Use the HoverNodeStyle property to control the appearance of a node when the mouse pointer is positioned over it. This property is read-only; however, you can set the properties of the TreeNodeStyle object that it returns. The properties can be set declaratively in the form Property-Subproperty, where Subproperty is a property of the TreeNodeStyle object (for example, HoverNodeStyle-ForeColor). The properties can also be set programmatically in the form Property.Subproperty (for example, HoverNodeStyle.ForeColor). This feature is supported only on script-capable clients.

Note

To use the HoverNodeStyle property, you must include a <head> element with a runat="server" attribute.

Common settings usually include a custom background color, foreground color, font properties, and node spacing. Style properties are applied in the following order:

NodeStyle.
RootNodeStyle, ParentNodeStyle, or LeafNodeStyle, depending on the node type. If the LevelStyles collection is defined, it is applied at this time, overriding the other node style properties.
SelectedNodeStyle.
HoverNodeStyle.

Note

The style settings for the HoverNodeStyle property override any corresponding node style settings that are in the NodeStyle, RootNodeStyle, ParentNodeStyle, LeafNodeStyle, or SelectedNodeStyle property.

The HoverNodeStyle property is not rendered for a node with its SelectAction property set to TreeNodeSelectAction.None.

Unlike the ParentNodeStyle and the LeafNodeStyle properties, which are TreeNodeStyle objects, the HoverNodeStyle property is a Style object.

Applies to

Jaa