SiteMapSection Clase

Definición

Espacio de nombres:: System.Web.Configuration

Ensamblado:: System.Web.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Define las opciones de configuración que se usan para admitir la infraestructura para configurar, almacenar y representar la navegación del sitio. Esta clase no puede heredarse.

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

Herencia: Object

ConfigurationElement

ConfigurationSection
SiteMapSection

Ejemplos

En este ejemplo se muestra cómo especificar valores mediante declaración para varios atributos de la siteMap sección, a los que también se puede tener acceso como miembros de la SiteMapSection clase .

En el siguiente ejemplo de archivo de configuración se muestra cómo especificar valores declarativamente para la siteMap sección .

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

En el ejemplo de código siguiente se muestra cómo usar la SiteMapSection clase .

#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

Comentarios

La SiteMapSection clase proporciona una manera de obtener acceso mediante programación y modificar el contenido de la sección del archivo siteMap de configuración.

Constructores

Nombre	Description
SiteMapSection()	Inicializa una nueva instancia de la SiteMapSection clase mediante la configuración predeterminada.

Propiedades

Nombre	Description
CurrentConfiguration	Obtiene una referencia a la instancia de nivel Configuration superior que representa la jerarquía de configuración a la que pertenece la instancia actual ConfigurationElement . (Heredado de ConfigurationElement)
DefaultProvider	Obtiene o establece el nombre del proveedor de navegación predeterminado.
ElementInformation	Obtiene un ElementInformation objeto que contiene la información y la funcionalidad no personalizables del ConfigurationElement objeto . (Heredado de ConfigurationElement)
ElementProperty	Obtiene el ConfigurationElementProperty objeto que representa el ConfigurationElement propio objeto. (Heredado de ConfigurationElement)
Enabled	Obtiene o establece un valor que indica si la característica de mapa de sitio de ASP.NET está habilitada.
EvaluationContext	Obtiene el objeto ContextInformation para el objeto ConfigurationElement. (Heredado de ConfigurationElement)
HasContext	Obtiene un valor que indica si la CurrentConfiguration propiedad es `null`. (Heredado de ConfigurationElement)
Item[ConfigurationProperty]	Obtiene o establece una propiedad o atributo de este elemento de configuración. (Heredado de ConfigurationElement)
Item[String]	Obtiene o establece una propiedad, un atributo o un elemento secundario de este elemento de configuración. (Heredado de ConfigurationElement)
LockAllAttributesExcept	Obtiene la colección de atributos bloqueados. (Heredado de ConfigurationElement)
LockAllElementsExcept	Obtiene la colección de elementos bloqueados. (Heredado de ConfigurationElement)
LockAttributes	Obtiene la colección de atributos bloqueados. (Heredado de ConfigurationElement)
LockElements	Obtiene la colección de elementos bloqueados. (Heredado de ConfigurationElement)
LockItem	Obtiene o establece un valor que indica si el elemento está bloqueado. (Heredado de ConfigurationElement)
Properties	Obtiene la colección de propiedades. (Heredado de ConfigurationElement)
Providers	Obtiene una ProviderSettingsCollection colección de ProviderSettings objetos .
SectionInformation	Obtiene un SectionInformation objeto que contiene la información y la funcionalidad no personalizables del ConfigurationSection objeto . (Heredado de ConfigurationSection)

Métodos

Nombre	Description
DeserializeElement(XmlReader, Boolean)	Lee XML del archivo de configuración. (Heredado de ConfigurationElement)
DeserializeSection(XmlReader)	Lee XML del archivo de configuración. (Heredado de ConfigurationSection)
Equals(Object)	Compara la instancia actual ConfigurationElement con el objeto especificado. (Heredado de ConfigurationElement)
GetHashCode()	Obtiene un valor único que representa la instancia actual ConfigurationElement . (Heredado de ConfigurationElement)
GetRuntimeObject()	Devuelve un objeto personalizado cuando se invalida en una clase derivada. (Heredado de ConfigurationSection)
GetTransformedAssemblyString(String)	Devuelve la versión transformada del nombre de ensamblado especificado. (Heredado de ConfigurationElement)
GetTransformedTypeString(String)	Devuelve la versión transformada del nombre de tipo especificado. (Heredado de ConfigurationElement)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
Init()	Establece el ConfigurationElement objeto en su estado inicial. (Heredado de ConfigurationElement)
InitializeDefault()	Se usa para inicializar un conjunto predeterminado de valores para el ConfigurationElement objeto . (Heredado de ConfigurationElement)
IsModified()	Indica si este elemento de configuración se ha modificado desde que se guardó o cargó por última vez cuando se implementó en una clase derivada. (Heredado de ConfigurationSection)
IsReadOnly()	Obtiene un valor que indica si el ConfigurationElement objeto es de solo lectura. (Heredado de ConfigurationElement)
ListErrors(IList)	Agrega los errores de propiedad no válida en este ConfigurationElement objeto y, en todos los subelementos, a la lista pasada. (Heredado de ConfigurationElement)
MemberwiseClone()	Crea una copia superficial del Objectactual. (Heredado de Object)
OnDeserializeUnrecognizedAttribute(String, String)	Obtiene un valor que indica si se encuentra un atributo desconocido durante la deserialización. (Heredado de ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Obtiene un valor que indica si se encuentra un elemento desconocido durante la deserialización. (Heredado de ConfigurationElement)
OnRequiredPropertyNotFound(String)	Produce una excepción cuando no se encuentra una propiedad necesaria. (Heredado de ConfigurationElement)
PostDeserialize()	Se llama después de la deserialización. (Heredado de ConfigurationElement)
PreSerialize(XmlWriter)	Se llama antes de la serialización. (Heredado de ConfigurationElement)
Reset(ConfigurationElement)	Restablece el estado interno del ConfigurationElement objeto, incluidos los bloqueos y las colecciones de propiedades. (Heredado de ConfigurationElement)
ResetModified()	Restablece el valor del IsModified() método a `false` cuando se implementa en una clase derivada. (Heredado de ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	Escribe el contenido de este elemento de configuración en el archivo de configuración cuando se implementa en una clase derivada. (Heredado de ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	Crea una cadena XML que contiene una vista no combinada del ConfigurationSection objeto como una sola sección para escribir en un archivo. (Heredado de ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	Escribe las etiquetas externas de este elemento de configuración en el archivo de configuración cuando se implementa en una clase derivada. (Heredado de ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Establece una propiedad en el valor especificado. (Heredado de ConfigurationElement)
SetReadOnly()	Establece la IsReadOnly() propiedad para el ConfigurationElement objeto y todos los subelementos. (Heredado de ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	Indica si el elemento especificado se debe serializar cuando la jerarquía de objetos de configuración se serializa para la versión de destino especificada de .NET Framework. (Heredado de ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	Indica si la propiedad especificada se debe serializar cuando la jerarquía de objetos de configuración se serializa para la versión de destino especificada de .NET Framework. (Heredado de ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	Indica si se debe serializar la instancia de ConfigurationSection actual cuando la jerarquía de objetos de configuración se serializa para la versión de destino especificada de .NET Framework. (Heredado de ConfigurationSection)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifica el ConfigurationElement objeto para quitar todos los valores que no se deben guardar. (Heredado de ConfigurationElement)

Se aplica a

Consulte también

Comentarios

¿Le ha resultado útil esta página?