This documentation is archived and is not being maintained.

SiteMapNode Constructor (SiteMapProvider, String, String, String, String)

Initializes a new instance of the SiteMapNode class using the specified URL, a key to identify the page that the node represents, a title and description, and the site map provider that manages the node.

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

public:
SiteMapNode(
	SiteMapProvider^ provider, 
	String^ key, 
	String^ url, 
	String^ title, 
	String^ description
)

Parameters

provider
Type: System.Web::SiteMapProvider

The SiteMapProvider with which the node is associated.

key
Type: System::String

A provider-specific lookup key.

url
Type: System::String

The URL of the page that the node represents within the site.

title
Type: System::String

A label for the node, often displayed by navigation controls.

description
Type: System::String

A description of the page that the node represents.

ExceptionCondition
ArgumentNullException

SiteMapProvider is nullptr.

- or -

key is nullptr.

The XmlSiteMapProvider class, which is the default SiteMapProvider provider implementation for ASP.NET, uses the SiteMapNode::Url property as a lookup key, if one is provided for the node (if a URL is not provided, a tracking identifier is generated for the node). Therefore, any SiteMapNode object that provides a URL and is used by the XmlSiteMapProvider must have a unique URL within the scope of the provider.

If no title or description is provided, calls to the Title or Description properties return an String::Empty field.

The following code example demonstrates how to use the SiteMapNode constructor to create a SiteMapNode object by parsing data from a simple text file to build a site map in memory.

This code example is part of a larger example provided for the abstract SiteMapProvider class.

No code example is currently available or this language may not be supported.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: