SiteMapProviderCollection Class

Reference

Definition

Namespace:: System.Web

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

public ref class SiteMapProviderCollection sealed : System::Configuration::Provider::ProviderCollection

public sealed class SiteMapProviderCollection : System.Configuration.Provider.ProviderCollection

type SiteMapProviderCollection = class
    inherit ProviderCollection

Public NotInheritable Class SiteMapProviderCollection
Inherits ProviderCollection

Inheritance: Object

ProviderCollection
SiteMapProviderCollection

Examples

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" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<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())
    {
        Response.Write(providers.Current);
        Response.Write("&nbsp;&nbsp;&nbsp;");
        Response.Write("<BR>");
    }
}
</SCRIPT>

<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<SCRIPT runat="server">
Private Sub Page_Load(Sender As Object, E As EventArgs)

    ' 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>")

    Dim sitemapnode As SiteMapNode
    For Each sitemapnode In SiteMap.RootNode.ChildNodes
        ' Iterate through the ChildNodes SiteMapNodesCollection
        ' maintained by the RootNode.
        Response.Write(sitemapnode.Url & "<BR>" )
    Next

    Dim providers As IDictionaryEnumerator = SiteMap.Providers.GetEnumerator()
    While (providers.MoveNext())
        Response.Write(providers.Current)
        Response.Write("&nbsp;&nbsp;&nbsp;")
        Response.Write("<BR>")
    End While
End Sub ' Page_Load

</SCRIPT>

Remarks

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.

Constructors

SiteMapProviderCollection()

Initializes a new instance of the SiteMapProviderCollection class.

Properties

Count	Gets the number of providers in the collection. (Inherited from ProviderCollection)
IsSynchronized	Gets a value indicating whether access to the collection is synchronized (thread safe). (Inherited from ProviderCollection)
Item[String]	Gets a SiteMapProvider object with a specific name from the provider collection.
SyncRoot	Gets the current object. (Inherited from ProviderCollection)

Methods

Add(ProviderBase)	Adds a SiteMapProvider to the provider collection using the Name property as the key.
Add(SiteMapProvider)	Adds a SiteMapProvider object to the provider collection using the Name property as the key.
AddArray(SiteMapProvider[])	Adds an array of SiteMapProvider objects into the provider collection using the Name properties as keys.
Clear()	Removes all items from the collection. (Inherited from ProviderCollection)
CopyTo(ProviderBase[], Int32)	Copies the contents of the collection to the given array starting at the specified index. (Inherited from ProviderCollection)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an object that implements the IEnumerator interface to iterate through the collection. (Inherited from ProviderCollection)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Remove(String)	Removes a provider from the collection. (Inherited from ProviderCollection)
SetReadOnly()	Sets the collection to be read-only. (Inherited from ProviderCollection)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the elements of the ProviderCollection to an array, starting at a particular array index.

(Inherited from ProviderCollection)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to

Deila með