TreeNodeStyle Class

.NET Framework (current version)

Represents the style of a node in the TreeView control.

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

Inheritance Hierarchy

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

Syntax

C++

[<Sealed>]
type TreeNodeStyle = 
    class
        inherit Style
    end

Constructors

	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.

Properties

	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.)
	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.)
	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	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.)
	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	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.)
	Width	Gets or sets the width of the Web server control.(Inherited from Style.)

Methods

	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(Style)	Copies the style properties of the specified Style object into the current TreeNodeStyle object.(Overrides Style.CopyFrom(Style).)
	CreateObjRef(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.)
	Dispose()	Releases all resources used by the Component.(Inherited from Component.)
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)
	GetStyleAttributes(IUrlResolutionService)	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(Object)	Loads the previously saved state.(Inherited from Style.)
	MergeWith(Style)	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(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.)
	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.)

Events

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

Explicit Interface Implementations

	Name	Description
	IStateManager.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.)
	IStateManager.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.)
	IStateManager.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.)
	IStateManager.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:

NodeStyle.
RootNodeStyle, ParentNodeStyle, or LeafNodeStyle, depending on the node type.
LevelStyles.
SelectedNodeStyle.
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.

TreeNodeStyle Class

Inheritance Hierarchy

Syntax

Constructors

Properties

Methods

Events

Explicit Interface Implementations

Remarks

Examples

Version Information

Thread Safety

See Also