SiteMap.Providers Property

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

Gets a read-only collection of named SiteMapProvider objects that are available to the SiteMap class.

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

public static SiteMapProviderCollection Providers { get; }
/** @property */
public static SiteMapProviderCollection get_Providers ()

public static function get Providers () : SiteMapProviderCollection

Property Value

A SiteMapProviderCollection of named SiteMapProvider objects.

Exception typeCondition


The site map feature is not enabled.


The default provider specified in the configuration does not exist.


The feature is supported only when running in Low trust or higher.

The site map providers that are listed in the Providers collection are those that are specified in the configuration hierarchy to initialize the SiteMap class. Only the default provider (identified by the Provider property) is guaranteed to be used by the SiteMap during initialization; the presence of a provider in the Providers collection means that it was specified in the configuration and was available during initialization.

The following code example demonstrates how to retrieve the Providers collection from the SiteMap class, and then iterate through it.

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "">

<SCRIPT runat="server">
private void Page_Load(object sender, System.EventArgs e)
    // Navigate the SiteMap built by the default SiteMapProvider.
    Response.Write(SiteMap.RootNode.ToString() + "<BR>");

    Response.Write(SiteMap.RootNode.Url + "<BR>");
    Response.Write(SiteMap.RootNode.Title + "<BR>");

    foreach (SiteMapNode sitemapnode in SiteMap.RootNode.ChildNodes)
        // Iterate through the ChildNodes SiteMapNodesCollection
        // maintained by the RootNode.
        Response.Write(sitemapnode.Url + "<BR>" );

    IEnumerator providers = SiteMap.Providers.GetEnumerator();
    while (providers.MoveNext())

If you have more than just the default provider configured for your site, you will see each provider displayed. For example, if you are using the sample Microsoft Access provider (see StaticSiteMapProvider), you see the following output:

XmlSiteMapProvider   System.Web.XmlSiteMapProvider
AccessSiteMapProvider   Samples.AspNet.AccessSiteMapProvider

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