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

NameDescription
System_CAPS_pubmethodSiteMapProviderCollection()

Initializes a new instance of the SiteMapProviderCollection class.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of providers in the collection.(Inherited from ProviderCollection.)

System_CAPS_pubpropertyIsSynchronized

Gets a value indicating whether access to the collection is synchronized (thread safe).(Inherited from ProviderCollection.)

System_CAPS_pubpropertyItem[String]

Gets a SiteMapProvider object with a specific name from the provider collection.

System_CAPS_pubpropertySyncRoot

Gets the current object.(Inherited from ProviderCollection.)

NameDescription
System_CAPS_pubmethodAdd(ProviderBase)

Adds a SiteMapProvider to the provider collection using the Name property as the key.(Overrides ProviderCollection.Add(ProviderBase).)

System_CAPS_pubmethodAdd(SiteMapProvider)

Adds a SiteMapProvider object to the provider collection using the Name property as the key.

System_CAPS_pubmethodAddArray(SiteMapProvider[])

Adds an array of SiteMapProvider objects into the provider collection using the Name properties as keys.

System_CAPS_pubmethodClear()

Removes all items from the collection.(Inherited from ProviderCollection.)

System_CAPS_pubmethodCopyTo(ProviderBase[], Int32)

Copies the contents of the collection to the given array starting at the specified index.(Inherited from ProviderCollection.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns an object that implements the IEnumerator interface to iterate through the collection.(Inherited from ProviderCollection.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodRemove(String)

Removes a provider from the collection.(Inherited from ProviderCollection.)

System_CAPS_pubmethodSetReadOnly()

Sets the collection to be read-only.(Inherited from ProviderCollection.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies the elements of the ProviderCollection to an array, starting at a particular array index.(Inherited from ProviderCollection.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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

.NET Framework
Available since 2.0

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

Return to top
Show: