XmlSiteMapProvider Clase

  • Referencia

Definición

Espacio de nombres:
System.Web
Ensamblado:
System.Web.dll

La clase XmlSiteMapProvider se deriva de la clase SiteMapProvider y es el proveedor de mapa del sitio predeterminado para ASP.NET. La clase XmlSiteMapProvider genera árboles de mapa del sitio a partir de archivos XML con la extensión de nombre de archivo .sitemap.

public ref class XmlSiteMapProvider : System::Web::StaticSiteMapProvider, IDisposable
public class XmlSiteMapProvider : System.Web.StaticSiteMapProvider, IDisposable
type XmlSiteMapProvider = class
    inherit StaticSiteMapProvider
    interface IDisposable
Public Class XmlSiteMapProvider
Inherits StaticSiteMapProvider
Implements IDisposable
Herencia
Object
ProviderBase
SiteMapProvider
StaticSiteMapProvider
XmlSiteMapProvider
Implementaciones
IDisposable

Comentarios

La XmlSiteMapProvider clase carga datos de mapa de sitio desde un archivo XML que sigue un esquema conocido. Los datos del mapa del sitio están enlazados por <siteMap> etiquetas y constan de etiquetas anidadas <siteMapNode> . Las clases y XmlSiteMapProvider imponen SiteMapProvider dos restricciones en la estructura de los datos del mapa del sitio:

  • Solo puede existir un nodo raíz.

  • Para SiteMapNode los objetos que especifican direcciones URL, las direcciones URL deben ser únicas dentro del ámbito del proveedor. (Para los nodos que no especifican direcciones URL, todas las claves deben ser únicas).

En el ejemplo de código siguiente se muestra un ejemplo de un archivo XML que se puede usar con .XmlSiteMapProvider

<siteMap>  
  <siteMapNode title="RootNode" description="This is the root node of the site map. There can be only one root node." url="Page1.aspx" >  
    <siteMapNode title="ChildofRootNode" description="Descriptions do not have to be unique." url="Page2.aspx">  
      <siteMapNode title="ChildOfChildNode" description="SiteMapNode objects can be nested to any level." url="Page3.aspx"/>  
    </siteMapNode>  
    <siteMapNode title="ChildofRootNode" description="Descriptions do not have to be unique." url="Page4.aspx"/>  
  </siteMapNode>  
</siteMap>

XmlSiteMapProvider es el proveedor predeterminado para ASP.NET y lee datos XML de un archivo denominado Web.sitemap que se encuentra dentro de la estructura de directorios de la aplicación ASP.NET. De forma predeterminada, el archivo Web.sitemap se encuentra en la raíz de la aplicación; Sin embargo, si desea cambiar el nombre o la ubicación del archivo desde el que cargan XmlSiteMapProvider los datos, puede invalidar la configuración predeterminada en el archivo Web.config. Al invalidar los valores de configuración predeterminados en el archivo Web.config, puede adaptar el comportamiento de XmlSiteMapProvider para cada aplicación ASP.NET, según sea necesario.

En el ejemplo de código siguiente se muestra un ejemplo Web.config archivo, donde XmlSiteMapProvider se sigue usando , pero se usa un archivo de mapa de sitio diferente. Dado que todos los proveedores de un SiteMapProviderCollection objeto deben denominarse de forma única, el especificado en el archivo Web.config usa un nombre distinto del predeterminado, pero también se establece como proveedor predeterminado para que se use en lugar del XmlSiteMapProvider especificado en la configuración de ASP.NET predeterminada.

Nota

Puede cambiar el nombre del archivo de datos de navegación del sitio, pero no puede cambiar su extensión. El XmlSiteMapProvider único lee datos de archivos denominados con la extensión de nombre de archivo .sitemap.

<siteMap defaultProvider="MyXmlSiteMapProvider" enabled="true">  
  <providers>  
    <add name="MyXmlSiteMapProvider"  
      description="SiteMap provider that reads in .sitemap files."  
      type="System.Web.XmlSiteMapProvider, System.Web, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"  
      siteMapFile="CustomWeb.sitemap" />  
  </providers>  
</siteMap>

Constructores

XmlSiteMapProvider()

Crea una nueva instancia, sin nombre, de la clase XmlSiteMapProvider.

Propiedades

CurrentNode

Obtiene el objeto SiteMapNode que representa la página solicitada actualmente.
CurrentNode

Obtiene el objeto SiteMapNode que representa la página solicitada actualmente.

(Heredado de SiteMapProvider)
Description

Obtiene una descripción breve y fácil de comprender apropiada para mostrarla en las herramientas administrativas u otras interfaces de usuario.

(Heredado de ProviderBase)
EnableLocalization

Obtiene o establece un valor booleano que indica si se van a devolver valores localizados de los atributos SiteMapNode.

(Heredado de SiteMapProvider)
Name

Obtiene el nombre descriptivo utilizado para hacer referencia al proveedor durante la configuración.

(Heredado de ProviderBase)
ParentProvider

Obtiene o establece el objeto SiteMapProvider primario del proveedor actual.

(Heredado de SiteMapProvider)
ResourceKey

Obtiene o establece la clave de recurso utilizada para localizar los atributos SiteMapNode.

(Heredado de SiteMapProvider)
RootNode

Obtiene el nodo raíz del mapa del sitio.
RootProvider

Obtiene el objeto SiteMapProvider raíz de la jerarquía de proveedores actual.

(Heredado de SiteMapProvider)
SecurityTrimmingEnabled

Obtiene un valor booleano que indica si un proveedor del mapa del sitio filtra los nodos del mapa del sitio basándose en el rol de un usuario.

(Heredado de SiteMapProvider)

Métodos

AddNode(SiteMapNode, SiteMapNode)

Agrega un objeto SiteMapNode a las colecciones que mantiene el proveedor actual.
AddNode(SiteMapNode)

Agrega un objeto SiteMapNode a la colección de nodos mantenida por el proveedor del mapa del sitio.

(Heredado de SiteMapProvider)
AddProvider(String, SiteMapNode)

Vincula un proveedor del mapa del sitio secundario al proveedor actual.
BuildSiteMap()

Carga la información del mapa del sitio de un archivo XML y lo crea en memoria.
Clear()

Quita todos los elementos de las colecciones de nodos secundarios y primarios del mapa del sitio y proveedores del mapa del sitio cuyo seguimiento efectúa internamente el objeto XmlSiteMapProvider como parte de su estado.
Dispose()

Notifica al supervisor de archivos del archivo Web.sitemap que el objeto XmlSiteMapProvider ya no requiere que se supervise el archivo.
Dispose(Boolean)

Notifica al supervisor de archivos del archivo Web.sitemap que el objeto XmlSiteMapProvider ya no requiere que se supervise el archivo. El método Dispose(Boolean) acepta un parámetro booleano que indica si el código de usuario llama al método.
Equals(Object)

Determina si el objeto especificado es igual que el objeto actual.

(Heredado de Object)
FindSiteMapNode(HttpContext)

Recupera un objeto SiteMapNode que representa la página solicitada actualmente mediante el objeto HttpContext especificado.

(Heredado de SiteMapProvider)
FindSiteMapNode(String)

Recupera un objeto SiteMapNode que representa la página en la dirección URL especificada.
FindSiteMapNodeFromKey(String)

Recupera un objeto SiteMapNode basándose en una clave especificada.
GetChildNodes(SiteMapNode)

Devuelve los nodos secundarios del mapa del sitio.
GetChildNodes(SiteMapNode)

Recupera los nodos secundarios del mapa del sitio de un objeto SiteMapNode concreto.

(Heredado de StaticSiteMapProvider)
GetCurrentNodeAndHintAncestorNodes(Int32)

Proporciona un método de búsqueda optimizado para los proveedores del mapa del sitio en las operaciones de recuperación de un nodo para hallar la página solicitada actualmente y de extracción de los nodos primarios y antecesores del mapa del sitio correspondientes a la página actual.

(Heredado de SiteMapProvider)
GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)

Proporciona un método de búsqueda optimizado para los proveedores del mapa del sitio en las operaciones de recuperación de un nodo para hallar la página solicitada actualmente y de extracción de los nodos del mapa del sitio próximos al nodo actual.

(Heredado de SiteMapProvider)
GetHashCode()

Sirve como la función hash predeterminada.

(Heredado de Object)
GetParentNode(SiteMapNode)

Devuelve el nodo primario del mapa del sitio.
GetParentNode(SiteMapNode)

Recupera el nodo primario del mapa del sitio de un objeto SiteMapNode concreto.

(Heredado de StaticSiteMapProvider)
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)

Proporciona un método de búsqueda optimizado para los proveedores del mapa del sitio al recuperar un nodo antecesor correspondiente a la página solicitada actualmente y extraer los nodos descendientes del antecesor.

(Heredado de SiteMapProvider)
GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)

Proporciona un método de búsqueda optimizado para los proveedores del mapa del sitio al recuperar un nodo antecesor para el objeto SiteMapNode especificado y extraer sus nodos secundarios.

(Heredado de SiteMapProvider)
GetRootNodeCore()

Recupera el nodo de nivel superior de la estructura de datos del mapa del sitio actual.
GetType()

Obtiene el Type de la instancia actual.

(Heredado de Object)
HintAncestorNodes(SiteMapNode, Int32)

Proporciona un método que los proveedores del mapa del sitio pueden reemplazar para realizar una recuperación optimizada de uno o más niveles de nodos primarios y antecesores, de manera relativa al objeto SiteMapNode especificado.

(Heredado de SiteMapProvider)
HintNeighborhoodNodes(SiteMapNode, Int32, Int32)

Proporciona un método que los proveedores del mapa del sitio pueden reemplazar para realizar una recuperación optimizada de los nodos próximos al nodo especificado.

(Heredado de SiteMapProvider)
Initialize(String, NameValueCollection)

Inicializa el objeto XmlSiteMapProvider. El método Initialize(String, NameValueCollection) realmente no crea un mapa del sitio, se limita a preparar el estado del objeto XmlSiteMapProvider para que lo haga.
IsAccessibleToUser(HttpContext, SiteMapNode)

Recupera un valor booleano que indica si el usuario puede ver el objeto SiteMapNode especificado en el contexto indicado.

(Heredado de SiteMapProvider)
MemberwiseClone()

Crea una copia superficial del Object actual.

(Heredado de Object)
RemoveNode(SiteMapNode)

Quita el objeto SiteMapNode especificado de todas las colecciones de nodos de las que el proveedor realiza el seguimiento.
RemoveProvider(String)

Quita un proveedor del mapa del sitio secundario vinculado de la jerarquía del proveedor actual.
ResolveSiteMapNode(HttpContext)

Genera el evento SiteMapResolve.

(Heredado de SiteMapProvider)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)

Eventos

SiteMapResolve

Se produce cuando se llama a la propiedad CurrentNode.

(Heredado de SiteMapProvider)

Se aplica a

Consulte también