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

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
)
public SiteMapNode (
	SiteMapProvider provider, 
	String key, 
	String url, 
	String title, 
	String description
)
public function SiteMapNode (
	provider : SiteMapProvider, 
	key : String, 
	url : String, 
	title : String, 
	description : String
)
Not applicable.

Parameters

provider

The SiteMapProvider with which the node is associated.

key

A provider-specific lookup key.

url

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

title

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

description

A description of the page that the node represents.

Exception typeCondition

ArgumentNullException

SiteMapProvider is a null reference (Nothing in Visual Basic).

- or -

key is a null reference (Nothing in Visual Basic).

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