SiteMapProvider Property

SiteMapPath.SiteMapProvider Property


Gets or sets the name of the SiteMapProvider used to render the site navigation control.

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

public virtual string SiteMapProvider { get; set; }

Property Value

Type: System.String

The name of a SiteMapProvider that defines the navigation structure for the SiteMapPath to display. All available providers are contained in the SiteMap.Providers collection, and can be enumerated and retrieved by name using the Item property.

The SiteMapPath control uses a SiteMapProvider as a source for the site map data it renders. If the SiteMapProvider property is not set, the SiteMapPath control uses the provider identified by the SiteMap.Provider property, which is the default SiteMapProvider defined for the site in the configuration hierarchy, typically the XmlSiteMapProvider. Setting the SiteMapProvider property directs the SiteMapPath control to render the site map data that the provider defines.

The SiteMapPath control works directly with a SiteMapProvider and its SiteMapNode objects to display site map information. Other controls, such as Menu and TreeView, require a data abstraction, provided by the SiteMapDataSource class, to display the same site navigation information.

The value of this property is stored in view state.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft