SiteMapNode.Description Property

Gets or sets a description for the SiteMapNode.

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

[LocalizableAttribute(true)] 
public virtual string Description { get; set; }
/** @property */
public String get_Description ()

/** @property */
public void set_Description (String value)

public function get Description () : String

public function set Description (value : String)

Not applicable.

Property Value

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

Exception typeCondition

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

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: