XmlSiteMapProvider Class

Definition

Namespace:

System.Web

Assembly:

System.Web.dll

The XmlSiteMapProvider class is derived from the SiteMapProvider class and is the default site map provider for ASP.NET. The XmlSiteMapProvider class generates site map trees from XML files with the file name extension .sitemap.

public ref class XmlSiteMapProvider : System::Web::StaticSiteMapProvider, IDisposable

public class XmlSiteMapProvider : System.Web.StaticSiteMapProvider, IDisposable

type XmlSiteMapProvider = class
    inherit StaticSiteMapProvider
    interface IDisposable

Public Class XmlSiteMapProvider
Inherits StaticSiteMapProvider
Implements IDisposable

Inheritance

Object

ProviderBase

SiteMapProvider

StaticSiteMapProvider

XmlSiteMapProvider

Implements

IDisposable

Remarks

The XmlSiteMapProvider class loads site map data from an XML file that follows a known schema. The site map data is bounded by <siteMap> tags and consists of nested <siteMapNode> tags. Two constraints are imposed by the SiteMapProvider and XmlSiteMapProvider classes on the structure of the site map data:

• Only one root node can exist.

• For SiteMapNode objects that specify URLs, the URLs must be unique within the scope of the provider. (For nodes that do not specify URLs, all keys must be unique.)

The following code example shows an example of an XML file that can be used with the XmlSiteMapProvider.

<siteMap>  
  <siteMapNode title="RootNode" description="This is the root node of the site map. There can be only one root node." url="Page1.aspx" >  
    <siteMapNode title="ChildofRootNode" description="Descriptions do not have to be unique." url="Page2.aspx">  
      <siteMapNode title="ChildOfChildNode" description="SiteMapNode objects can be nested to any level." url="Page3.aspx"/>  
    </siteMapNode>  
    <siteMapNode title="ChildofRootNode" description="Descriptions do not have to be unique." url="Page4.aspx"/>  
  </siteMapNode>  
</siteMap>  

The XmlSiteMapProvider is the default provider for ASP.NET and it reads XML data from a file named Web.sitemap that is located within the directory structure of the ASP.NET application. By default, the Web.sitemap file is located at the application root; however, if you want to change the name or location of the file from which the XmlSiteMapProvider loads data, you can override the default configuration in your Web.config file. By overriding the default configuration settings in your Web.config file, you can tailor the behavior of the XmlSiteMapProvider for each ASP.NET application, as necessary.

The following code example demonstrates an example Web.config file, where the XmlSiteMapProvider is still used, but a different site map file is used. Because all providers in a SiteMapProviderCollection object must be named uniquely, the one that is specified in the Web.config file uses a name other than the default but is also set as the default provider so that it will be used instead of the XmlSiteMapProvider that is specified in the default ASP.NET configuration.

Note

You can change the name of the site navigation data file, but you cannot change its extension. The XmlSiteMapProvider only reads data from files that are named with the file name extension .sitemap.

<siteMap defaultProvider="MyXmlSiteMapProvider" enabled="true">  
  <providers>  
    <add name="MyXmlSiteMapProvider"  
      description="SiteMap provider that reads in .sitemap files."  
      type="System.Web.XmlSiteMapProvider, System.Web, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"  
      siteMapFile="CustomWeb.sitemap" />  
  </providers>  
</siteMap>  

Constructors

XmlSiteMapProvider()

Creates a new, unnamed, instance of the XmlSiteMapProvider class.

Properties

CurrentNode	Gets the SiteMapNode object that represents the currently requested page.
Description	Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs). (Inherited from ProviderBase)
EnableLocalization	Gets or sets a Boolean value indicating whether localized values of SiteMapNode attributes are returned. (Inherited from SiteMapProvider)
Name	Gets the friendly name used to refer to the provider during configuration. (Inherited from ProviderBase)
ParentProvider	Gets or sets the parent SiteMapProvider object of the current provider. (Inherited from SiteMapProvider)
ResourceKey	Get or sets the resource key that is used for localizing SiteMapNode attributes. (Inherited from SiteMapProvider)
RootNode	Gets the root node of the site map.
RootProvider	Gets the root SiteMapProvider object in the current provider hierarchy. (Inherited from SiteMapProvider)
SecurityTrimmingEnabled	Gets a Boolean value indicating whether a site map provider filters site map nodes based on a user's role. (Inherited from SiteMapProvider)

Methods

AddNode(SiteMapNode, SiteMapNode)	Adds a SiteMapNode object to the collections that are maintained by the current provider.
AddNode(SiteMapNode)	Adds a SiteMapNode object to the node collection that is maintained by the site map provider. (Inherited from SiteMapProvider)
AddProvider(String, SiteMapNode)	Links a child site map provider to the current provider.
BuildSiteMap()	Loads the site map information from an XML file and builds it in memory.
Clear()	Removes all elements in the collections of child and parent site map nodes and site map providers that the XmlSiteMapProvider object internally tracks as part of its state.
Dispose()	Notifies the file monitor of the Web.sitemap file that the XmlSiteMapProvider object no longer requires the file to be monitored.
Dispose(Boolean)	Notifies the file monitor of the Web.sitemap file that the XmlSiteMapProvider object no longer requires the file to be monitored. The Dispose(Boolean) method takes a Boolean parameter indicating whether the method is called by user code.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindSiteMapNode(HttpContext)	Retrieves a SiteMapNode object that represents the currently requested page using the specified HttpContext object. (Inherited from SiteMapProvider)
FindSiteMapNode(String)	Retrieves a SiteMapNode object that represents the page at the specified URL.
FindSiteMapNodeFromKey(String)	Retrieves a SiteMapNode object based on a specified key.
GetChildNodes(SiteMapNode)	Returns the child nodes of the site map.
GetCurrentNodeAndHintAncestorNodes(Int32)	Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the parent and ancestor site map nodes for the current page. (Inherited from SiteMapProvider)
GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)	Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the site map nodes in the proximity of the current node. (Inherited from SiteMapProvider)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetParentNode(SiteMapNode)	Returns the parent node of the site map.
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)	Provides an optimized lookup method for site map providers when retrieving an ancestor node for the currently requested page and fetching the descendant nodes for the ancestor. (Inherited from SiteMapProvider)
GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)	Provides an optimized lookup method for site map providers when retrieving an ancestor node for the specified SiteMapNode object and fetching its child nodes. (Inherited from SiteMapProvider)
GetRootNodeCore()	Retrieves the top-level node of the current site map data structure.
GetType()	Gets the Type of the current instance. (Inherited from Object)
HintAncestorNodes(SiteMapNode, Int32)	Provides a method that site map providers can override to perform an optimized retrieval of one or more levels of parent and ancestor nodes, relative to the specified SiteMapNode object. (Inherited from SiteMapProvider)
HintNeighborhoodNodes(SiteMapNode, Int32, Int32)	Provides a method that site map providers can override to perform an optimized retrieval of nodes found in the proximity of the specified node. (Inherited from SiteMapProvider)
Initialize(String, NameValueCollection)	Initializes the XmlSiteMapProvider object. The Initialize(String, NameValueCollection) method does not actually build a site map, it only prepares the state of the XmlSiteMapProvider to do so.
IsAccessibleToUser(HttpContext, SiteMapNode)	Retrieves a Boolean value indicating whether the specified SiteMapNode object can be viewed by the user in the specified context. (Inherited from SiteMapProvider)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
RemoveNode(SiteMapNode)	Removes the specified SiteMapNode object from all node collections that are tracked by the provider.
RemoveProvider(String)	Removes a linked child site map provider from the hierarchy for the current provider.
ResolveSiteMapNode(HttpContext)	Raises the SiteMapResolve event. (Inherited from SiteMapProvider)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

SiteMapResolve

Occurs when the CurrentNode property is called. (Inherited from SiteMapProvider)

See also

• SiteMapProvider
• StaticSiteMapProvider
• ASP.NET Site Navigation Overview
• ASP.NET Site Maps
• ASP.NET Site Navigation Providers
• How to: Add Simple Site Navigation
• Securing ASP.NET Site Navigation