SiteMapSection Clase
Definición
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 utilizan para permitir la infraestructura para configurar, almacenar y representar la navegación del sitio. Esta clase no puede heredarse.
public ref class SiteMapSection sealed : System::Configuration::ConfigurationSectionpublic sealed class SiteMapSection : System.Configuration.ConfigurationSectiontype SiteMapSection = class
inherit ConfigurationSectionPublic NotInheritable Class SiteMapSection
Inherits ConfigurationSection- Herencia
Ejemplos
En este ejemplo se muestra cómo especificar los valores mediante declaración para varios atributos de la sección, a los siteMap 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 los valores mediante declaración 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 acceder y modificar mediante programación el contenido de la sección del archivo siteMap de configuración.
Constructores
| SiteMapSection() |
Inicializa una nueva instancia de la clase SiteMapSection utilizando las opciones predeterminadas. |
Propiedades
| CurrentConfiguration |
Obtiene una referencia a la instancia de Configuration de nivel superior que representa la jerarquía de configuración a la que pertenece la instancia actual de ConfigurationElement. (Heredado de ConfigurationElement) |
| DefaultProvider |
Obtiene o establece el nombre del proveedor de navegación predeterminado. |
| ElementInformation |
Obtiene un objeto ElementInformation que contiene la funcionalidad e información no personalizable del objeto ConfigurationElement. (Heredado de ConfigurationElement) |
| ElementProperty |
Obtiene el objeto ConfigurationElementProperty que representa al propio objeto ConfigurationElement. (Heredado de ConfigurationElement) |
| Enabled |
Obtiene o establece un valor que indica si se habilita la característica de mapa del sitio de ASP.NET. |
| EvaluationContext |
Obtiene el objeto ContextInformation para el objeto ConfigurationElement. (Heredado de ConfigurationElement) |
| HasContext |
Obtiene un valor que indica si la propiedad CurrentConfiguration es |
| 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 colección ProviderSettingsCollection de objetos ProviderSettings. |
| SectionInformation |
Obtiene un objeto SectionInformation que contiene la funcionalidad e información no personalizable del objeto ConfigurationSection. (Heredado de ConfigurationSection) |
Métodos
| 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 de ConfigurationElement con el objeto especificado. (Heredado de ConfigurationElement) |
| GetHashCode() |
Obtiene un valor único que representa la instancia actual de ConfigurationElement. (Heredado de ConfigurationElement) |
| GetRuntimeObject() |
Devuelve un objeto personalizado cuando se reemplaza 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 objeto ConfigurationElement en su estado inicial. (Heredado de ConfigurationElement) |
| InitializeDefault() |
Se utiliza para inicializar un conjunto predeterminado de valores para el objeto ConfigurationElement. (Heredado de ConfigurationElement) |
| IsModified() |
Indica si se ha modificado este elemento de configuración desde la última vez en que se guardo o cargó al implementarlo en una clase derivada. (Heredado de ConfigurationSection) |
| IsReadOnly() |
Obtiene un valor que indica si el objeto ConfigurationElement es de solo lectura. (Heredado de ConfigurationElement) |
| ListErrors(IList) |
Agrega a la lista que se pasa los errores de propiedad no válida que hay en este objeto ConfigurationElement y en todos los subelementos. (Heredado de ConfigurationElement) |
| MemberwiseClone() |
Crea una copia superficial del Object actual. (Heredado de Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
Obtiene un valor que indica si se ha encontrado un atributo desconocido durante la deserialización. (Heredado de ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
Obtiene un valor que indica si se ha encontrado un elemento desconocido durante la deserialización. (Heredado de ConfigurationElement) |
| OnRequiredPropertyNotFound(String) |
Se inicia una excepción cuando no se encuentra una propiedad necesaria. (Heredado de ConfigurationElement) |
| PostDeserialize() |
Se llama a este método después de la deserialización. (Heredado de ConfigurationElement) |
| PreSerialize(XmlWriter) |
Se llama a este método antes de la serialización. (Heredado de ConfigurationElement) |
| Reset(ConfigurationElement) |
Restablece el estado interno del objeto ConfigurationElement, incluyendo los bloqueos y las colecciones de propiedades. (Heredado de ConfigurationElement) |
| ResetModified() |
Restablece el valor del método IsModified() en |
| 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 separada del objeto ConfigurationSection como una sección única 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 propiedad IsReadOnly() para el objeto ConfigurationElement y todos los subelementos. (Heredado de ConfigurationElement) |
| ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) |
Indica si el elemento especificado debe serializarse cuando la jerarquía de objetos de configuración se serializa para la versión de destino especificada del .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 del .NET Framework. (Heredado de ConfigurationSection) |
| ShouldSerializeSectionInTargetVersion(FrameworkName) |
Indica si la instancia actual ConfigurationSection se debe serializar cuando la jerarquía de objetos de configuración se serializa para la versión de destino especificada del .NET Framework. (Heredado de ConfigurationSection) |
| ToString() |
Devuelve una cadena que representa el objeto actual. (Heredado de Object) |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Modifica el objeto ConfigurationElement para quitar todos los valores que no se deben guardar. (Heredado de ConfigurationElement) |