TreeNodeStyle Class
.NET Framework 4
Represents the style of a node in the TreeView control.
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Web.UI.WebControls.Style
System.Web.UI.WebControls.TreeNodeStyle
System.MarshalByRefObject
System.ComponentModel.Component
System.Web.UI.WebControls.Style
System.Web.UI.WebControls.TreeNodeStyle
Assembly: System.Web (in System.Web.dll)
The TreeNodeStyle type exposes the following members.
| Name | Description | |
|---|---|---|
|
TreeNodeStyle() | Initializes a new instance of the TreeNodeStyle class. |
|
|
TreeNodeStyle(StateBag) | Initializes a new instance of the TreeNodeStyle class with the specified StateBag object information. |
| Name | Description | |
|---|---|---|
|
BackColor | Gets or sets the background color of the Web server control. (Inherited from Style.) |
|
|
BorderColor | Gets or sets the border color of the Web server control. (Inherited from Style.) |
|
|
BorderStyle | Gets or sets the border style of the Web server control. (Inherited from Style.) |
|
|
BorderWidth | Gets or sets the border width of the Web server control. (Inherited from Style.) |
|
CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
|
|
ChildNodesPadding | Gets or sets the amount of space between a parent node and a child node to which the TreeNodeStyle class is applied. |
|
|
Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
|
|
CssClass | Gets or sets the cascading style sheet (CSS) class rendered by the Web server control on the client. (Inherited from Style.) |
|
|
DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
|
|
Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
|
|
Font | Gets the font properties associated with the Web server control. (Inherited from Style.) |
|
|
ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from Style.) |
|
|
Height | Gets or sets the height of the Web server control. (Inherited from Style.) |
|
|
HorizontalPadding | Gets or sets the amount of space to the left and right of the text in the node. |
|
|
ImageUrl | Gets or sets the URL to an image that is displayed next to the node. |
|
|
IsEmpty | Infrastructure. A protected property. Gets a value indicating whether any style elements have been defined in the state bag. (Inherited from Style.) |
|
|
IsTrackingViewState | Returns a value indicating whether any style elements have been defined in the state bag. (Inherited from Style.) |
|
|
NodeSpacing | Gets or sets the amount of vertical spacing between the node to which the TreeNodeStyle object is applied and its adjacent nodes. |
|
|
RegisteredCssClass | Gets the cascading style sheet (CSS) class that is registered with the control. (Inherited from Style.) |
|
|
Site | Gets or sets the ISite of the Component. (Inherited from Component.) |
|
|
VerticalPadding | Gets or sets the amount of space above and below the text for a node. |
|
|
ViewState | Infrastructure. Gets the state bag that holds the style elements. (Inherited from Style.) |
|
|
Width | Gets or sets the width of the Web server control. (Inherited from Style.) |
| Name | Description | |
|---|---|---|
|
|
AddAttributesToRender(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.) |
|
|
AddAttributesToRender(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.) |
|
|
CopyFrom | Copies the style properties of the specified Style object into the current TreeNodeStyle object. (Overrides Style.CopyFrom(Style).) |
|
|
CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
|
|
Dispose() | Releases all resources used by the Component. (Inherited from Component.) |
|
Dispose(Boolean) | Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.) |
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
|
FillStyleAttributes | Adds the specified object's style properties to a System.Web.UI.CssStyleCollection object. (Inherited from Style.) |
|
|
Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
|
|
GetService | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.) |
|
|
GetStyleAttributes | Retrieves the System.Web.UI.CssStyleCollection object for the specified System.Web.UI.IUrlResolutionService-implemented object. (Inherited from Style.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
|
|
LoadViewState | Loads the previously saved state. (Inherited from Style.) |
|
|
MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
|
|
MergeWith | Combines the style properties of the specified Style object with the style properties of the current TreeNodeStyle object. (Overrides Style.MergeWith(Style).) |
|
|
Reset | Returns the TreeNodeStyle object to its original state. (Overrides Style.Reset().) |
|
|
SaveViewState | A protected method. Saves any state that has been modified after the TrackViewState method was invoked. (Inherited from Style.) |
|
|
SetBit | Infrastructure. A protected internal method. Sets an internal bitmask field that indicates the style properties that are stored in the state bag. (Inherited from Style.) |
|
|
SetDirty | Marks the Style so that its state will be recorded in view state. (Inherited from Style.) |
|
|
ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
|
|
TrackViewState | 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.) |
| Name | Description | |
|---|---|---|
|
IStateManager.IsTrackingViewState | Gets a value that indicates whether a server control is tracking its view state changes. (Inherited from Style.) |
|
IStateManager.LoadViewState | Infrastructure. Loads the previously saved state. (Inherited from Style.) |
|
|
IStateManager.SaveViewState | Infrastructure. Returns the object containing state changes. (Inherited from Style.) |
|
|
IStateManager.TrackViewState | Infrastructure. Starts tracking 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 |
|---|---|
|
The style settings for a node when the mouse pointer is positioned over it. |
|
|
The style settings for the leaf nodes. |
|
|
The default style settings for a node. |
|
|
The style settings for the parent nodes. |
|
|
The style settings for the root node. |
|
|
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:
-
RootNodeStyle , ParentNodeStyle, or LeafNodeStyle, depending on the node type.
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>
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.
