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.
Assembly: System.Web (in System.Web.dll)
The SiteMapProviderCollection type exposes the following members.
| Name | Description | |
|---|---|---|
|
SiteMapProviderCollection | Initializes a new instance of the SiteMapProviderCollection class. |
| Name | Description | |
|---|---|---|
|
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 | Gets a SiteMapProvider object with a specific name from the provider collection. |
|
|
SyncRoot | Gets the current object. (Inherited from ProviderCollection.) |
| Name | Description | |
|---|---|---|
|
|
Add(ProviderBase) | Adds a SiteMapProvider to the provider collection using the Name property as the key. (Overrides ProviderCollection.Add(ProviderBase).) |
|
|
Add(SiteMapProvider) | Adds a SiteMapProvider object to the provider collection using the Name property as the key. |
|
|
AddArray | 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 | 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.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetEnumerator | Returns an object that implements the IEnumerator interface to iterate through the collection. (Inherited from ProviderCollection.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (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 | 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.) |
| Name | Description | |
|---|---|---|
|
ICollection.CopyTo | Copies 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" "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(" "); Response.Write("<BR>"); } } </SCRIPT>
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.
