This documentation is archived and is not being maintained.

SiteMapNode.Description Property

Gets or sets a description for the SiteMapNode.

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

public virtual string Description { get; set; }

Property Value

Type: System.String
A string that represents a description of the node; otherwise, String.Empty.

ExceptionCondition
InvalidOperationException

The node is read-only.

While the Title of a SiteMapNode is used by some navigation controls as a label or hyperlink, the Description is used as a ToolTip element for mouse over events.

A localized value of the Description property is returned if the EnableLocalization property is true.

TopicLocation
How to: Localize Site-Map DataBuilding ASP .NET Web Applications
How to: Localize Site-Map DataBuilding ASP .NET Web Applications

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

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.
Show: