This documentation is archived and is not being maintained.

SiteMapSection Class

Defines configuration settings that are used to support the infrastructure for configuring, storing, and rendering site navigation. This class cannot be inherited.

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

'Declaration
Public NotInheritable Class SiteMapSection _
	Inherits ConfigurationSection
'Usage
Dim instance As SiteMapSection

The SiteMapSection class provides a way to programmatically access and modify the content of the configuration file siteMap section.

This example demonstrates how to specify values declaratively for several attributes of the siteMap section, which can also be accessed as members of the SiteMapSection class.

The following configuration file example shows how to specify values declaratively for the siteMap section.

<system.web>
  <siteMap defaultProvider="XmlSiteMapReader" enabled="true">
    <providers>
      <clear />
      <add 
        name="XmlSiteMapReader"
        type="XmlSiteMapProvider, System.Web, Version=1.1.3300.0,
              Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"
        siteMapFile="my.sitemap" 
        description="XmlSiteMapProvider that loads my.sitemap"/>
    </providers>
  </siteMap>
</system.web>

The following code example demonstrates how to use the SiteMapSection class.

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingSiteMapSection
    Public Shared Sub Main()
      Try 
        ' Set the path of the config file. 
        Dim configPath As String = "" 

        ' Get the Web application configuration object. 
        Dim config As System.Configuration.Configuration = _
         System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object. 
        Dim configSection As System.Web.Configuration.SiteMapSection = _
         CType(config.GetSection("system.web/siteMap"), _
         System.Web.Configuration.SiteMapSection)

        ' Display title and info.
        Console.WriteLine("ASP.NET Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", config.FilePath)
        Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)

        ' Display Default Provider.
        Console.WriteLine("Default Provider: {0}", _
         configSection.DefaultProvider)

        ' Set Default Provider.
        configSection.DefaultProvider = "SiteMapProviderName" 

        ' Display Enabled value.
        Console.WriteLine("Enabled: {0}", configSection.Enabled)

        ' Set Enabled value.
        configSection.Enabled = True 

        ' Display the number of Providers
        Console.WriteLine("Providers Collection Count: {0}", _
         configSection.Providers.Count)

        ' Display elements of the Providers collection property. 
        For Each providerItem As ProviderSettings In configSection.Providers()
          Console.WriteLine()
          Console.WriteLine("Provider Details -")
          Console.WriteLine("Name: {0}", providerItem.Name)
          Console.WriteLine("Type: {0}", providerItem.Type)
        Next 

        ' Update if not locked. 
        If Not configSection.SectionInformation.IsLocked Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
          Console.WriteLine("** Could not update, section is locked.")
        End If 

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try 

      ' Display and wait
      Console.ReadLine()
    End Sub 
  End Class 
End Namespace

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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: