TreeNodeStyle Class
TOC
Collapse the table of content
Expand the table of content

TreeNodeStyle Class

 

Represents the style of a node in the TreeView control.

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

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Web.UI.WebControls.Style
        System.Web.UI.WebControls.TreeNodeStyle

public sealed class TreeNodeStyle : Style

NameDescription
System_CAPS_pubmethodTreeNodeStyle()

Initializes a new instance of the TreeNodeStyle class.

System_CAPS_pubmethodTreeNodeStyle(StateBag)

Initializes a new instance of the TreeNodeStyle class with the specified StateBag object information.

NameDescription
System_CAPS_pubpropertyBackColor

Gets or sets the background color of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyBorderColor

Gets or sets the border color of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyBorderStyle

Gets or sets the border style of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyBorderWidth

Gets or sets the border width of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyChildNodesPadding

Gets or sets the amount of space between a parent node and a child node to which the TreeNodeStyle class is applied.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyCssClass

Gets or sets the cascading style sheet (CSS) class rendered by the Web server control on the client.(Inherited from Style.)

System_CAPS_pubpropertyFont

Gets the font properties associated with the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyForeColor

Gets or sets the foreground color (typically the color of the text) of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyHeight

Gets or sets the height of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyHorizontalPadding

Gets or sets the amount of space to the left and right of the text in the node.

System_CAPS_pubpropertyImageUrl

Gets or sets the URL to an image that is displayed next to the node.

System_CAPS_pubpropertyIsEmpty

This API supports the product infrastructure and is not intended to be used directly from your code. A protected property. Gets a value indicating whether any style elements have been defined in the state bag.(Inherited from Style.)

System_CAPS_pubpropertyNodeSpacing

Gets or sets the amount of vertical spacing between the node to which the TreeNodeStyle object is applied and its adjacent nodes.

System_CAPS_pubpropertyRegisteredCssClass

Gets the cascading style sheet (CSS) class that is registered with the control.(Inherited from Style.)

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertyVerticalPadding

Gets or sets the amount of space above and below the text for a node.

System_CAPS_protpropertyViewState

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the state bag that holds the style elements.(Inherited from Style.)

System_CAPS_pubpropertyWidth

Gets or sets the width of the Web server control.(Inherited from Style.)

NameDescription
System_CAPS_pubmethodAddAttributesToRender(HtmlTextWriter)

Adds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriter. This method is primarily used by control developers.(Inherited from Style.)

System_CAPS_pubmethodAddAttributesToRender(HtmlTextWriter, WebControl)

Adds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriter and Web server control. This method is primarily used by control developers.(Inherited from Style.)

System_CAPS_pubmethodCopyFrom(Style)

Copies the style properties of the specified Style object into the current TreeNodeStyle object.(Overrides Style.CopyFrom(Style).)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetStyleAttributes(IUrlResolutionService)

Retrieves the System.Web.UI.CssStyleCollection object for the specified System.Web.UI.IUrlResolutionService-implemented object.(Inherited from Style.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodLoadViewState(Object)

Loads the previously saved state.(Inherited from Style.)

System_CAPS_pubmethodMergeWith(Style)

Combines the style properties of the specified Style object with the style properties of the current TreeNodeStyle object.(Overrides Style.MergeWith(Style).)

System_CAPS_pubmethodReset()

Returns the TreeNodeStyle object to its original state.(Overrides Style.Reset().)

System_CAPS_protmethodSaveViewState()

A protected method. Saves any state that has been modified after the TrackViewState method was invoked.(Inherited from Style.)

System_CAPS_protmethodSetBit(Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. A protected internal method. Sets an internal bitmask field that indicates the style properties that are stored in the state bag.(Inherited from Style.)

System_CAPS_pubmethodSetDirty()

Marks the Style so that its state will be recorded in view state.(Inherited from Style.)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

System_CAPS_protmethodTrackViewState()

A protected method. Marks the beginning for tracking state changes on the control. Any changes made after tracking has begun will be tracked and saved as part of the control view state.(Inherited from Style.)

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.LoadViewState(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Loads the previously saved state.(Inherited from Style.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.SaveViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the object containing state changes.(Inherited from Style.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.TrackViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Starts tracking state changes.(Inherited from Style.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIStateManager.IsTrackingViewState

Gets a value that indicates whether a server control is tracking its view state changes.(Inherited from Style.)

Use the TreeNodeStyle class to represent the style of a node in the TreeView control. The TreeView control allows you to specify different style characteristics (such as font size and color) for each of the different node types.

The following table lists the node styles that are supported by the TreeNodeStyle class.

Node style property

Description

HoverNodeStyle

The style settings for a node when the mouse pointer is positioned over it.

LeafNodeStyle

The style settings for the leaf nodes.

NodeStyle

The default style settings for a node.

ParentNodeStyle

The style settings for the parent nodes.

RootNodeStyle

The style settings for the root node.

SelectedNodeStyle

The style settings for a selected node.

When you set the node style properties of the TreeView control, they are applied in the following order:

  1. NodeStyle.

  2. RootNodeStyle, ParentNodeStyle, or LeafNodeStyle, depending on the node type.

  3. LevelStyles.

  4. SelectedNodeStyle.

  5. HoverNodeStyle.

The TreeNodeStyle class inherits most of its members from the Style class. It extends the Style class by providing properties that control the amount of space around the text in a node, as well as the space between adjacent nodes. Use the HorizontalPadding property to control the amount of space to the left and right of the text in a node. Similarly, the VerticalPadding property controls the amount of space above and below the text in a node. You can control the amount of spacing between the node that the TreeNodeStyle is applied to and its adjacent nodes by setting the NodeSpacing property. To control the amount of spacing between a parent node and a child node, use the ChildNodesPadding property.

For more information about the inherited style settings, see Style.

The following code example demonstrates how to control the appearance of the parent nodes in the TreeView control by setting the style properties of the TreeNodeStyle object that is returned from the ParentNodeStyle property.


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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void HorizontalPadding_Changed(Object sender, EventArgs e)
  {

    // Programmatically set the HorizontalPadding property based on the 
    // user's selection.
    ItemsTreeView.ParentNodeStyle.HorizontalPadding = Convert.ToInt32(HorizontalPaddingList.SelectedItem.Text);

  }

  void VerticalPadding_Changed(Object sender, EventArgs e)
  {

    // Programmatically set the VerticalPadding property based on the 
    // user's selection.
    ItemsTreeView.ParentNodeStyle.VerticalPadding = Convert.ToInt32(VerticalPaddingList.SelectedItem.Text);

  }

  void NodeSpacing_Changed(Object sender, EventArgs e)
  {

    // Programmatically set the NodeSpacing property based on the 
    // user's selection.
    ItemsTreeView.ParentNodeStyle.NodeSpacing = Convert.ToInt32(NodeSpacingList.SelectedItem.Text);

  }

  void ChildNodePadding_Changed(Object sender, EventArgs e)
  {

    // Programmatically set the ChildNodesPadding property based on the 
    // user's selection.
    ItemsTreeView.ParentNodeStyle.ChildNodesPadding = Convert.ToInt32(ChildNodesPaddingList.SelectedItem.Text);

  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>TreeNodeStyle Example</title>
</head>
<body>  
    <form id="form1" runat="server">

      <h3>TreeNodeStyle Example</h3>

      <!-- Set the styles for the leaf nodes declaratively. -->
      <asp:TreeView id="ItemsTreeView"
        Font-Names= "Arial"
        ForeColor="Blue"
        ParentNodeStyle-ForeColor="Green"
        ParentNodeStyle-HorizontalPadding="5" 
        ParentNodeStyle-VerticalPadding="5"  
        ParentNodeStyle-NodeSpacing="5"
        ParentNodeStyle-ChildNodesPadding="5"
        ExpandDepth="4"  
        runat="server">

        <Nodes>

          <asp:TreeNode Text="Table of Contents"
            SelectAction="None">

            <asp:TreeNode Text="Chapter One">

              <asp:TreeNode Text="Section 1.0">

                <asp:TreeNode Text="Topic 1.0.1"/>
                <asp:TreeNode Text="Topic 1.0.2"/>
                <asp:TreeNode Text="Topic 1.0.3"/>

              </asp:TreeNode>

              <asp:TreeNode Text="Section 1.1">

                <asp:TreeNode Text="Topic 1.1.1"/>
                <asp:TreeNode Text="Topic 1.1.2"/>
                <asp:TreeNode Text="Topic 1.1.3"/>
                <asp:TreeNode Text="Topic 1.1.4"/>

              </asp:TreeNode>

            </asp:TreeNode>

          </asp:TreeNode>

        </Nodes>

      </asp:TreeView>

      <hr />

      <h5>Select the style settings for the parent nodes.</h5>

      <table cellpadding="5">

        <tr align="right">

          <td>

            Horizontal Padding:

            <asp:DropDownList id="HorizontalPaddingList"
              AutoPostBack="true"
              OnSelectedIndexChanged="HorizontalPadding_Changed" 
              runat="server">

              <asp:ListItem>0</asp:ListItem>
              <asp:ListItem Selected="true">5</asp:ListItem>
              <asp:ListItem>10</asp:ListItem>

            </asp:DropDownList> 

          </td>

          <td>

            Vertical Padding:

            <asp:DropDownList id="VerticalPaddingList"
              AutoPostBack="true"
              OnSelectedIndexChanged="VerticalPadding_Changed" 
              runat="server">

              <asp:ListItem>0</asp:ListItem>
              <asp:ListItem Selected="true">5</asp:ListItem>
              <asp:ListItem>10</asp:ListItem>

            </asp:DropDownList> 

          </td>

        </tr>

        <tr align="right">

          <td>

            Node Spacing:

            <asp:DropDownList id="NodeSpacingList"
              AutoPostBack="true"
              OnSelectedIndexChanged="NodeSpacing_Changed"   
              runat="server">

              <asp:ListItem>0</asp:ListItem>
              <asp:ListItem Selected="true">5</asp:ListItem>
              <asp:ListItem>10</asp:ListItem>

            </asp:DropDownList> 

          </td>

          <td>

            Child Nodes Padding:

            <asp:DropDownList id="ChildNodesPaddingList"
              AutoPostBack="true"
              OnSelectedIndexChanged="ChildNodePadding_Changed"  
              runat="server">

              <asp:ListItem>0</asp:ListItem>
              <asp:ListItem Selected="true">5</asp:ListItem>
              <asp:ListItem>10</asp:ListItem>

            </asp:DropDownList> 

          </td>

        </tr>

      </table>

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

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft