SiteMapSection Classe

Referência

Definição

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Define as definições de configuração usadas para dar suporte à infraestrutura para configurar, armazenar e renderizar a navegação no site. Essa classe não pode ser herdada.

public ref class SiteMapSection sealed : System::Configuration::ConfigurationSection

public sealed class SiteMapSection : System.Configuration.ConfigurationSection

type SiteMapSection = class
    inherit ConfigurationSection

Public NotInheritable Class SiteMapSection
Inherits ConfigurationSection

Herança: Object

ConfigurationElement

ConfigurationSection
SiteMapSection

Exemplos

Este exemplo demonstra como especificar valores declarativamente para vários atributos da siteMap seção, que também podem ser acessados como membros da SiteMapSection classe.

O exemplo de arquivo de configuração a seguir mostra como especificar valores declarativamente para a siteMap seção.

<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>

O exemplo de código a seguir demonstra como usar a SiteMapSection classe.

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Web;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingSiteMapSection
  {
    static void Main(string[] args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        SiteMapSection configSection = 
          (SiteMapSection)config.GetSection("system.web/siteMap");

        // 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.
        foreach (ProviderSettings providerItem in configSection.Providers)
        {
          Console.WriteLine();
          Console.WriteLine("Provider Details:");
          Console.WriteLine("Name: {0}", providerItem.Name);
          Console.WriteLine("Type: {0}", providerItem.Type);
        }

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update, section is locked.");
        }
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait
      Console.ReadLine();
    }
  }
}

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

Comentários

A SiteMapSection classe fornece uma maneira de acessar e modificar programaticamente o conteúdo da seção de arquivo siteMap de configuração.

Construtores

SiteMapSection()

Inicializa uma nova instância da classe SiteMapSection usando as configurações padrão.

Propriedades

CurrentConfiguration	Obtém uma referência para a instância Configuration de nível superior que representa a hierarquia de configuração à qual a instância atual ConfigurationElement pertence. (Herdado de ConfigurationElement)
DefaultProvider	Obtém ou define o nome do provedor de navegação padrão.
ElementInformation	Obtém um objeto ElementInformation que contém as informações não personalizáveis e a funcionalidade do objeto ConfigurationElement. (Herdado de ConfigurationElement)
ElementProperty	Obtém o objeto ConfigurationElementProperty que representa o próprio objeto ConfigurationElement. (Herdado de ConfigurationElement)
Enabled	Obtém ou define um valor que indica se o recurso de mapa do site do ASP.NET está habilitado.
EvaluationContext	Obtém o objeto ContextInformation para o objeto ConfigurationElement. (Herdado de ConfigurationElement)
HasContext	Obtém um valor que indica se a propriedade CurrentConfiguration é `null`. (Herdado de ConfigurationElement)
Item[ConfigurationProperty]	Obtém ou define uma propriedade ou um atributo desse elemento de configuração. (Herdado de ConfigurationElement)
Item[String]	Obtém ou define uma propriedade, atributo ou elemento filho desse elemento de configuração. (Herdado de ConfigurationElement)
LockAllAttributesExcept	Obtém a coleção de atributos bloqueados. (Herdado de ConfigurationElement)
LockAllElementsExcept	Obtém a coleção de elementos bloqueados. (Herdado de ConfigurationElement)
LockAttributes	Obtém a coleção de atributos bloqueados. (Herdado de ConfigurationElement)
LockElements	Obtém a coleção de elementos bloqueados. (Herdado de ConfigurationElement)
LockItem	Obtém ou define um valor que indica se o elemento está bloqueado. (Herdado de ConfigurationElement)
Properties	Obtém a coleção de propriedades. (Herdado de ConfigurationElement)
Providers	Obtém uma coleção ProviderSettingsCollection de objetos ProviderSettings.
SectionInformation	Obtém um objeto SectionInformation que contém as informações não personalizáveis e a funcionalidade do objeto ConfigurationSection. (Herdado de ConfigurationSection)

Métodos

DeserializeElement(XmlReader, Boolean)	Lê o XML do arquivo de configuração. (Herdado de ConfigurationElement)
DeserializeSection(XmlReader)	Lê o XML do arquivo de configuração. (Herdado de ConfigurationSection)
Equals(Object)	Compara a instância ConfigurationElement atual com o objeto especificado. (Herdado de ConfigurationElement)
GetHashCode()	Obtém um valor exclusivo que representa a instância ConfigurationElement atual. (Herdado de ConfigurationElement)
GetRuntimeObject()	Retorna um objeto personalizado quando substituído em uma classe derivada. (Herdado de ConfigurationSection)
GetTransformedAssemblyString(String)	Retorna a versão transformada do nome do assembly especificado. (Herdado de ConfigurationElement)
GetTransformedTypeString(String)	Retorna a versão transformada do nome do tipo especificado. (Herdado de ConfigurationElement)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
Init()	Define o objeto ConfigurationElement para seu estado inicial. (Herdado de ConfigurationElement)
InitializeDefault()	Usado para inicializar um conjunto padrão de valores para o objeto ConfigurationElement. (Herdado de ConfigurationElement)
IsModified()	Indica se este elemento de configuração foi modificado desde a última vez em que foi salvo ou carregado quando implementado em uma classe derivada. (Herdado de ConfigurationSection)
IsReadOnly()	Obtém um valor que indica se o objeto ConfigurationElement é somente leitura. (Herdado de ConfigurationElement)
ListErrors(IList)	Adiciona os erros de propriedade inválida deste objeto ConfigurationElement e de todos os subelementos à lista passada. (Herdado de ConfigurationElement)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
OnDeserializeUnrecognizedAttribute(String, String)	Obtém um valor que indica se um atributo desconhecido é encontrado durante a desserialização. (Herdado de ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Obtém um valor que indica se um elemento desconhecido é encontrado durante a desserialização. (Herdado de ConfigurationElement)
OnRequiredPropertyNotFound(String)	Gera uma exceção quando uma propriedade necessária não é encontrada. (Herdado de ConfigurationElement)
PostDeserialize()	Chamado depois da desserialização. (Herdado de ConfigurationElement)
PreSerialize(XmlWriter)	Chamado antes da serialização. (Herdado de ConfigurationElement)
Reset(ConfigurationElement)	Redefine o estado interno do objeto ConfigurationElement, incluindo os bloqueios e as coleções de propriedades. (Herdado de ConfigurationElement)
ResetModified()	Redefine o valor do método IsModified() para `false` quando implementado em uma classe derivada. (Herdado de ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	Grava o conteúdo desse elemento de configuração no arquivo de configuração quando implementado em uma classe derivada. (Herdado de ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	Cria uma cadeia de caracteres XML que contém uma exibição não mesclada do objeto ConfigurationSection como uma única seção a ser gravada em um arquivo. (Herdado de ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	Grava as marcas externas desse elemento de configuração no arquivo de configuração quando implementado em uma classe derivada. (Herdado de ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Define uma propriedade para o valor especificado. (Herdado de ConfigurationElement)
SetReadOnly()	Define a propriedade IsReadOnly() para o objeto ConfigurationElement e para todos os subelementos. (Herdado de ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	Indica se o elemento especificado deve ser serializado quando a hierarquia de objeto de configuração é serializada para a versão de destino especificada do .NET Framework. (Herdado de ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	Indica se a propriedade especificada deve ser serializada quando a hierarquia de objetos de configuração é serializada para a versão de destino especificada do .NET Framework. (Herdado de ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	Indica se a instância atual ConfigurationSection deve ser serializada quando a hierarquia de objetos de configuração é serializada para a versão de destino especificada do .NET Framework. (Herdado de ConfigurationSection)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifica o objeto ConfigurationElement para remover todos os valores que não devem ser salvos. (Herdado de ConfigurationElement)

Aplica-se a

Compartilhar via