SiteMapProviderCollection::Add Method (ProviderBase^)

 

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

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

public:
virtual void Add(
	ProviderBase^ provider
) override

Parameters

provider
Type: System.Configuration.Provider::ProviderBase^

The SiteMapProvider to add.

Exception Condition
ArgumentNullException

The Name of the SiteMapProvider is null.

ArgumentException

provider is not an instance of the SiteMapProvider class.

- or -

A SiteMapProvider with the same name already exists in the SiteMapProviderCollection.

NotSupportedException

The SiteMapProviderCollection is read-only.

The SiteMapProviderCollection object that is returned by the Providers property is read-only. For this reason, you cannot use the Add and AddArray methods to add additional providers programmatically at run time. Therefore, the Add and AddArray methods are used only in scenarios where you manually create site map provider objects and manage them with an instance of the SiteMapProviderCollection class. The Add(ProviderBase^) method checks the type of the specified provider, and then calls the Add(SiteMapProvider^) method to add it to the collection.

Because the SiteMap class is static, any SiteMapProvider contained in its Providers collection remains for the lifetime of the Web application.

.NET Framework
Available since 2.0
Return to top
Show: