This documentation is archived and is not being maintained.

SiteMapDataSource.SiteMapProvider Property

Updated: October 2009

Gets or sets the name of the site map provider that the data source binds to.

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

public virtual string SiteMapProvider { get; set; }
<asp:SiteMapDataSource SiteMapProvider="String" />

Property Value

Type: System.String
The name of the site map provider that the SiteMapDataSource binds to. By default, the value is Empty, and the default site map provider for the site is used.

The value of the SiteMapProvider property is stored in view state.

TopicLocation
How to: Localize Site-Map DataBuilding ASP .NET Web Applications
How to: Localize Site-Map DataBuilding ASP .NET Web Applications

The following code example demonstrates how to declaratively bind a TreeView control to site map data that is provided by an SiteMapProvider object other than the default provider. The site is configured to access a custom SiteMapProvider object though the following Web.config file:

<system.web>
  <siteMap>
    <providers>
      <add name="AsciiTextProvider"
        description="SiteMap provider which reads in .sitemap text files."
        type="Samples.AspNet.SimpleTextSiteMapProvider,Samples.AspNet"
      siteMapFile="test.txt"/>
    </providers>
  </siteMap>
</system.web>
NoteNote:

The AsciiTextProvider provider is not the default provider for the site, which (in this case) remains the XmlSiteMapProvider object. The SiteMapProvider property of the SiteMapDataSource control is set to the name of a custom site map provider, and the TreeView binds to the corresponding site map data.

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" runat="server">
            <asp:SiteMapDataSource
                id="SiteMapDataSource1"
                runat="server"
                SiteMapProvider="AsciiTextProvider" />

            <asp:TreeView
                id="TreeView1"
                runat="server"
                DataSourceID="SiteMapDataSource1">
            </asp:TreeView>

        </form>
    </body>
</html>

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

Date

History

Reason

October 2009

Corrected Web.config syntax.

Customer feedback.

Show: