SiteMapNode Constructor (SiteMapProvider, String, String, String, String, IList, NameValueCollection, NameValueCollection, String)

Note: This constructor is new in the .NET Framework version 2.0.

Initializes a new instance of the SiteMapNode class using the specified site map provider that manages the node, URL, title, description, roles, additional attributes, and explicit and implicit resource keys for localization.

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

public:
SiteMapNode (
	SiteMapProvider^ provider, 
	String^ key, 
	String^ url, 
	String^ title, 
	String^ description, 
	IList^ roles, 
	NameValueCollection^ attributes, 
	NameValueCollection^ explicitResourceKeys, 
	String^ implicitResourceKey
)
public SiteMapNode (
	SiteMapProvider provider, 
	String key, 
	String url, 
	String title, 
	String description, 
	IList roles, 
	NameValueCollection attributes, 
	NameValueCollection explicitResourceKeys, 
	String implicitResourceKey
)
public function SiteMapNode (
	provider : SiteMapProvider, 
	key : String, 
	url : String, 
	title : String, 
	description : String, 
	roles : IList, 
	attributes : NameValueCollection, 
	explicitResourceKeys : NameValueCollection, 
	implicitResourceKey : String
)

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.

roles

An IList of roles that are allowed to view the page represented by the SiteMapNode.

attributes

A NameValueCollection of additional attributes used to initialize the SiteMapNode.

explicitResourceKeys

A NameValueCollection of explicit resource keys used for localization.

implicitResourceKey

An implicit resource key used for localization.

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.

The NameValueCollection collection of attributes that the SiteMapNode is created with is available through the Attributes property, and makes it easy to apply additional attributes to a site map node and extend its capabilities without deriving a custom class to do so.

Supply an IList collection of roles to provide a set of roles that can view the node when the SecurityTrimmingEnabled property returns true. For more information, see SecurityTrimmingEnabled.

The XmlSiteMapProvider provider uses the SiteMapNode.Url property as a lookup key. Therefore, any SiteMapNode that 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.

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

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: