This documentation is archived and is not being maintained.

SiteMapProviderCollection::Add Method (SiteMapProvider)

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

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

public:
void Add(
	SiteMapProvider^ provider
)

Parameters

provider
Type: System.Web::SiteMapProvider

The SiteMapProvider to add.

ExceptionCondition
ArgumentNullException

provider is nullptr.

NotSupportedException

The SiteMapProviderCollection is read-only.

ArgumentException

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

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 programmatically add additional providers to the SiteMap 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. Use the Add method when you want to add a single SiteMapProvider to the SiteMapProviderCollection.

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: