This documentation is archived and is not being maintained.

SiteMapProviderCollection Class

Used by the SiteMap class to track the set of SiteMapProvider objects that are available to the SiteMap during site map initialization. This class cannot be inherited.

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

public sealed class SiteMapProviderCollection : ProviderCollection

The SiteMapProviderCollection type exposes the following members.

Public methodSiteMapProviderCollectionInitializes a new instance of the SiteMapProviderCollection class.

Public propertyCountGets the number of providers in the collection. (Inherited from ProviderCollection.)
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized (thread safe). (Inherited from ProviderCollection.)
Public propertyItemGets a SiteMapProvider object with a specific name from the provider collection.
Public propertySyncRootGets the current object. (Inherited from ProviderCollection.)

Public methodAdd(ProviderBase)Adds a SiteMapProvider to the provider collection using the Name property as the key. (Overrides ProviderCollection.Add(ProviderBase).)
Public methodAdd(SiteMapProvider)Adds a SiteMapProvider object to the provider collection using the Name property as the key.
Public methodAddArrayAdds an array of SiteMapProvider objects into the provider collection using the Name properties as keys.
Public methodClearRemoves all items from the collection. (Inherited from ProviderCollection.)
Public methodCopyToCopies the contents of the collection to the given array starting at the specified index. (Inherited from ProviderCollection.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an object that implements the IEnumerator interface to iterate through the collection. (Inherited from ProviderCollection.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveRemoves a provider from the collection. (Inherited from ProviderCollection.)
Public methodSetReadOnlySets the collection to be read-only. (Inherited from ProviderCollection.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Explicit interface implemetationPrivate methodICollection.CopyToCopies the elements of the ProviderCollection to an array, starting at a particular array index. (Inherited from ProviderCollection.)

The SiteMapProviderCollection class is a strongly typed Hashtable collection of SiteMapProvider objects. In addition to the two add methods, Add(ProviderBase) and Add(SiteMapProvider), the SiteMapProviderCollection class supports the AddArray method to add an array of type SiteMapProvider.

The SiteMapProviderCollection is used by the SiteMap class to track the set of SiteMapProvider objects that are available to the SiteMap during site map initialization. However, the presence of a SiteMapProvider in the provider collection does not necessarily mean it is used by a SiteMap object, only that it is available for use.

When a SiteMapProvider is stored in the SiteMapProviderCollection, the Name property is used as the key.

The following code example demonstrates how to retrieve the SiteMapProviderCollection object from the SiteMap object and iterate through it.

If you have more than just the default provider configured for your site, you will see each provider that is displayed. For example, if you are using the sample AccessSiteMapProvider found in the SiteMapProvider class overview, you will see the following output.

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

<%@ 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())

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.