SiteMapProvider 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í.
Proporciona una clase base común para todos los proveedores de datos del mapa del sitio y un medio para que los desarrolladores implementen proveedores de datos del mapa del sitio personalizados que se pueden utilizar con la infraestructura del mapa del sitio ASP.NET como almacenes persistentes para los objetos SiteMap.
public ref class SiteMapProvider abstract : System::Configuration::Provider::ProviderBase
public abstract class SiteMapProvider : System.Configuration.Provider.ProviderBase
type SiteMapProvider = class
inherit ProviderBase
Public MustInherit Class SiteMapProvider
Inherits ProviderBase
- Herencia
- Derivado
Ejemplos
En el ejemplo de código siguiente se muestra cómo escribir una clase que implementa la clase abstracta SiteMapProvider . En este ejemplo solo se incluye un ejemplo SiteMapProvider y un archivo de texto de ejemplo que funciona con él. Para ejecutar el ejemplo, también necesita una entrada en el archivo Web.config y una página de .aspx. Puede encontrarlas en la documentación de la SiteMapDataSource.SiteMapProvider propiedad .
En el ejemplo se usa un archivo delimitado por comas que sigue una estructura esperada para cargar información del mapa del sitio. La primera línea del archivo representa el nodo raíz del mapa del sitio y las líneas posteriores son subnodos. Cada subnodo identifica su nodo primario por dirección URL. A continuación se muestra un ejemplo de un archivo que cumple estos criterios.
default.aspx,Home,MyCompany Home Page,
sale.aspx,Now On Sale,Check Out These Great Deals!,default.aspx
catalog.aspx,Online Catalog,Browse Our Many Great Items!,default.aspx
SimpleTextSiteMapProvider
proporciona implementaciones de ejemplo de todas las SiteMapProvider propiedades y métodos.
using System;
using System.Configuration.Provider;
using System.Collections;
using System.Collections.Specialized;
using System.IO;
using System.Security.Permissions;
using System.Web;
namespace Samples.AspNet.CS
{
[AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal)]
public class SimpleTextSiteMapProvider : SiteMapProvider
{
private SiteMapProvider parentSiteMapProvider = null;
private string simpleTextProviderName = null;
private string sourceFilename = null;
private SiteMapNode rootNode = null;
private ArrayList siteMapNodes = null;
private ArrayList childParentRelationship = null;
// A default constructor. The Name property is initialized in the
// Initialize method.
public SimpleTextSiteMapProvider()
{
}
// Implement the CurrentNode property.
public override SiteMapNode CurrentNode
{
get
{
string currentUrl = FindCurrentUrl();
// Find the SiteMapNode that represents the current page.
SiteMapNode currentNode = FindSiteMapNode(currentUrl);
return currentNode;
}
}
// Implement the RootNode property.
public override SiteMapNode RootNode
{
get
{
return rootNode;
}
}
// Implement the ParentProvider property.
public override SiteMapProvider ParentProvider
{
get
{
return parentSiteMapProvider;
}
set
{
parentSiteMapProvider = value;
}
}
// Implement the RootProvider property.
public override SiteMapProvider RootProvider
{
get
{
// If the current instance belongs to a provider hierarchy, it
// cannot be the RootProvider. Rely on the ParentProvider.
if (this.ParentProvider != null)
{
return ParentProvider.RootProvider;
}
// If the current instance does not have a ParentProvider, it is
// not a child in a hierarchy, and can be the RootProvider.
else
{
return this;
}
}
}
// Implement the FindSiteMapNode method.
public override SiteMapNode FindSiteMapNode(string rawUrl)
{
// Does the root node match the URL?
if (RootNode.Url == rawUrl)
{
return RootNode;
}
else
{
SiteMapNode candidate = null;
// Retrieve the SiteMapNode that matches the URL.
lock (this)
{
candidate = GetNode(siteMapNodes, rawUrl);
}
return candidate;
}
}
// Implement the GetChildNodes method.
public override SiteMapNodeCollection GetChildNodes(SiteMapNode node)
{
SiteMapNodeCollection children = new SiteMapNodeCollection();
// Iterate through the ArrayList and find all nodes that have the specified node as a parent.
lock (this)
{
for (int i = 0; i < childParentRelationship.Count; i++)
{
string nodeUrl = ((DictionaryEntry)childParentRelationship[i]).Key as string;
SiteMapNode parent = GetNode(childParentRelationship, nodeUrl);
if (parent != null && node.Url == parent.Url)
{
// The SiteMapNode with the Url that corresponds to nodeUrl
// is a child of the specified node. Get the SiteMapNode for
// the nodeUrl.
SiteMapNode child = FindSiteMapNode(nodeUrl);
if (child != null)
{
children.Add(child as SiteMapNode);
}
else
{
throw new Exception("ArrayLists not in sync.");
}
}
}
}
return children;
}
protected override SiteMapNode GetRootNodeCore()
{
return RootNode;
}
// Implement the GetParentNode method.
public override SiteMapNode GetParentNode(SiteMapNode node)
{
// Check the childParentRelationship table and find the parent of the current node.
// If there is no parent, the current node is the RootNode.
SiteMapNode parent = null;
lock (this)
{
// Get the Value of the node in childParentRelationship
parent = GetNode(childParentRelationship, node.Url);
}
return parent;
}
// Implement the ProviderBase.Initialize property.
// Initialize is used to initialize the state that the Provider holds, but
// not actually build the site map.
public override void Initialize(string name, NameValueCollection attributes)
{
lock (this)
{
base.Initialize(name, attributes);
simpleTextProviderName = name;
sourceFilename = attributes["siteMapFile"];
siteMapNodes = new ArrayList();
childParentRelationship = new ArrayList();
// Build the site map in memory.
LoadSiteMapFromStore();
}
}
// Private helper methods
private SiteMapNode GetNode(ArrayList list, string url)
{
for (int i = 0; i < list.Count; i++)
{
DictionaryEntry item = (DictionaryEntry)list[i];
if ((string)item.Key == url)
return item.Value as SiteMapNode;
}
return null;
}
// Get the URL of the currently displayed page.
private string FindCurrentUrl()
{
try
{
// The current HttpContext.
HttpContext currentContext = HttpContext.Current;
if (currentContext != null)
{
return currentContext.Request.RawUrl;
}
else
{
throw new Exception("HttpContext.Current is Invalid");
}
}
catch (Exception e)
{
throw new NotSupportedException("This provider requires a valid context.",e);
}
}
protected virtual void LoadSiteMapFromStore()
{
string pathToOpen;
lock (this)
{
// If a root node exists, LoadSiteMapFromStore has already
// been called, and the method can return.
if (rootNode != null)
{
return;
}
else
{
pathToOpen = HttpContext.Current.Server.MapPath("~" + "\\" + sourceFilename);
if (File.Exists(pathToOpen))
{
// Open the file to read from.
using (StreamReader sr = File.OpenText(pathToOpen))
{
// Clear the state of the collections and rootNode
rootNode = null;
siteMapNodes.Clear();
childParentRelationship.Clear();
// Parse the file and build the site map
string s = "";
string[] nodeValues = null;
SiteMapNode temp = null;
while ((s = sr.ReadLine()) != null)
{
// Build the various SiteMapNode objects and add
// them to the ArrayList collections. The format used
// is: URL,TITLE,DESCRIPTION,PARENTURL
nodeValues = s.Split(',');
temp = new SiteMapNode(this,
HttpRuntime.AppDomainAppVirtualPath + "/" + nodeValues[0],
HttpRuntime.AppDomainAppVirtualPath + "/" + nodeValues[0],
nodeValues[1],
nodeValues[2]);
// Is this a root node yet?
if (null == rootNode &&
string.IsNullOrEmpty(nodeValues[3]))
{
rootNode = temp;
}
// If not the root node, add the node to the various collections.
else
{
siteMapNodes.Add(new DictionaryEntry(temp.Url, temp));
// The parent node has already been added to the collection.
SiteMapNode parentNode =
FindSiteMapNode(HttpRuntime.AppDomainAppVirtualPath + "/" + nodeValues[3]);
if (parentNode != null)
{
childParentRelationship.Add(new DictionaryEntry(temp.Url, parentNode));
}
else
{
throw new Exception("Parent node not found for current node.");
}
}
}
}
}
else
{
throw new Exception("File not found");
}
}
}
return;
}
}
}
Imports System.Collections
Imports System.Collections.Specialized
Imports System.Configuration.Provider
Imports System.IO
Imports System.Security.Permissions
Imports System.Web
Namespace Samples.AspNet.VB
<AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class SimpleTextSiteMapProvider
Inherits SiteMapProvider
Private parentSiteMapProvider As SiteMapProvider = Nothing
Private simpleTextProviderName As String = Nothing
Private sourceFilename As String = Nothing
Private aRootNode As SiteMapNode = Nothing
Private siteMapNodes As ArrayList = Nothing
Private childParentRelationship As ArrayList = Nothing
' A default constructor. The Name property is initialized in the
' Initialize method.
Public Sub New()
End Sub
' Implement the CurrentNode property.
Public Overrides ReadOnly Property CurrentNode() As SiteMapNode
Get
Dim currentUrl As String = FindCurrentUrl()
' Find the SiteMapNode that represents the current page.
Dim aCurrentNode As SiteMapNode = FindSiteMapNode(currentUrl)
Return aCurrentNode
End Get
End Property
' Implement the RootNode property.
Public Overrides ReadOnly Property RootNode() As SiteMapNode
Get
Return aRootNode
End Get
End Property
' Implement the ParentProvider property.
Public Overrides Property ParentProvider() As SiteMapProvider
Get
Return parentSiteMapProvider
End Get
Set(ByVal value As SiteMapProvider)
parentSiteMapProvider = Value
End Set
End Property
' Implement the RootProvider property.
Public Overrides ReadOnly Property RootProvider() As SiteMapProvider
Get
' If the current instance belongs to a provider hierarchy, it
' cannot be the RootProvider. Rely on the ParentProvider.
If Not (Me.ParentProvider Is Nothing) Then
Return ParentProvider.RootProvider
' If the current instance does not have a ParentProvider, it is
' not a child in a hierarchy, and can be the RootProvider.
Else
Return Me
End If
End Get
End Property
' Implement the FindSiteMapNode method.
Public Overrides Function FindSiteMapNode(ByVal rawUrl As String) As SiteMapNode
' Does the root node match the URL?
If RootNode.Url = rawUrl Then
Return RootNode
Else
Dim candidate As SiteMapNode = Nothing
' Retrieve the SiteMapNode that matches the URL.
SyncLock Me
candidate = GetNode(siteMapNodes, rawUrl)
End SyncLock
Return candidate
End If
End Function 'FindSiteMapNode
' Implement the GetChildNodes method.
Public Overrides Function GetChildNodes(ByVal node As SiteMapNode) As SiteMapNodeCollection
Dim children As New SiteMapNodeCollection()
' Iterate through the ArrayList and find all nodes that have the specified node as a parent.
SyncLock Me
Dim i As Integer
For i = 0 To childParentRelationship.Count - 1
Dim de As DictionaryEntry = CType(childParentRelationship(i), DictionaryEntry)
Dim nodeUrl As String = CType(de.Key, String)
Dim parent As SiteMapNode = GetNode(childParentRelationship, nodeUrl)
If Not (parent Is Nothing) AndAlso node.Url = parent.Url Then
' The SiteMapNode with the Url that corresponds to nodeUrl
' is a child of the specified node. Get the SiteMapNode for
' the nodeUrl.
Dim child As SiteMapNode = FindSiteMapNode(nodeUrl)
If Not (child Is Nothing) Then
children.Add(CType(child, SiteMapNode))
Else
Throw New Exception("ArrayLists not in sync.")
End If
End If
Next i
End SyncLock
Return children
End Function 'GetChildNodes
Protected Overrides Function GetRootNodeCore() As SiteMapNode
Return RootNode
End Function ' GetRootNodeCore()
' Implement the GetParentNode method.
Public Overrides Function GetParentNode(ByVal node As SiteMapNode) As SiteMapNode
' Check the childParentRelationship table and find the parent of the current node.
' If there is no parent, the current node is the RootNode.
Dim parent As SiteMapNode = Nothing
SyncLock Me
' Get the Value of the node in childParentRelationship
parent = GetNode(childParentRelationship, node.Url)
End SyncLock
Return parent
End Function 'GetParentNode
' Implement the ProviderBase.Initialize method.
' Initialize is used to initialize the state that the Provider holds, but
' not actually build the site map.
Public Overrides Sub Initialize(ByVal name As String, ByVal attributes As NameValueCollection)
SyncLock Me
MyBase.Initialize(name, attributes)
simpleTextProviderName = name
sourceFilename = attributes("siteMapFile")
siteMapNodes = New ArrayList()
childParentRelationship = New ArrayList()
' Build the site map in memory.
LoadSiteMapFromStore()
End SyncLock
End Sub
' Private helper methods
Private Function GetNode(ByVal list As ArrayList, ByVal url As String) As SiteMapNode
Dim i As Integer
For i = 0 To list.Count - 1
Dim item As DictionaryEntry = CType(list(i), DictionaryEntry)
If CStr(item.Key) = url Then
Return CType(item.Value, SiteMapNode)
End If
Next i
Return Nothing
End Function 'GetNode
' Get the URL of the currently displayed page.
Private Function FindCurrentUrl() As String
Try
' The current HttpContext.
Dim currentContext As HttpContext = HttpContext.Current
If Not (currentContext Is Nothing) Then
Return currentContext.Request.RawUrl
Else
Throw New Exception("HttpContext.Current is Invalid")
End If
Catch e As Exception
Throw New NotSupportedException("This provider requires a valid context.", e)
End Try
End Function 'FindCurrentUrl
Protected Overridable Sub LoadSiteMapFromStore()
Dim pathToOpen As String
SyncLock Me
' If a root node exists, LoadSiteMapFromStore has already
' been called, and the method can return.
If Not (aRootNode Is Nothing) Then
Return
Else
pathToOpen = HttpContext.Current.Server.MapPath("~" & "\\" & sourceFilename)
If File.Exists(pathToOpen) Then
' Open the file to read from.
Dim sr As StreamReader = File.OpenText(pathToOpen)
Try
' Clear the state of the collections and aRootNode
aRootNode = Nothing
siteMapNodes.Clear()
childParentRelationship.Clear()
' Parse the file and build the site map
Dim s As String = ""
Dim nodeValues As String() = Nothing
Dim temp As SiteMapNode = Nothing
Do
s = sr.ReadLine()
If Not s Is Nothing Then
' Build the various SiteMapNode objects and add
' them to the ArrayList collections. The format used
' is: URL,TITLE,DESCRIPTION,PARENTURL
nodeValues = s.Split(","c)
temp = New SiteMapNode(Me, _
HttpRuntime.AppDomainAppVirtualPath & "/" & nodeValues(0), _
HttpRuntime.AppDomainAppVirtualPath & "/" & nodeValues(0), _
nodeValues(1), _
nodeValues(2))
' Is this a root node yet?
If aRootNode Is Nothing AndAlso _
(nodeValues(3) Is Nothing OrElse _
nodeValues(3) = String.Empty) Then
aRootNode = temp
' If not the root node, add the node to the various collections.
Else
siteMapNodes.Add(New DictionaryEntry(temp.Url, temp))
' The parent node has already been added to the collection.
Dim parentNode As SiteMapNode = _
FindSiteMapNode(HttpRuntime.AppDomainAppVirtualPath & "/" & nodeValues(3))
If Not (parentNode Is Nothing) Then
childParentRelationship.Add(New DictionaryEntry(temp.Url, parentNode))
Else
Throw New Exception("Parent node not found for current node.")
End If
End If
End If
Loop Until s Is Nothing
Finally
sr.Close()
End Try
Else
Throw New Exception("File not found")
End If
End If
End SyncLock
Return
End Sub
End Class
End Namespace
Comentarios
Las StaticSiteMapProvider clases y XmlSiteMapProvider representan las implementaciones predeterminadas de la clase abstracta SiteMapProvider . XmlSiteMapProvider usa un archivo XML denominado Web.sitemap para almacenar datos de mapa del sitio. Para obtener más información sobre el archivo Web.sitemap, consulta mapas del sitio ASP.NET.
La SiteMapProvider clase admite el concepto de jerarquía de proveedores de mapa de sitio declarando las RootProvider propiedades y ParentProvider . Un SiteMapProvider puede ser un elemento secundario o primario de otro proveedor. Esto permite escenarios en los que diferentes áreas de contenido de un sitio son propiedad o se implementan en diferentes grupos de desarrollo que mantienen sus propios mapas de sitio y proveedores de mapas de sitio.
Todos los SiteMapProvider objetos se configuran en los archivos Web.config. Los proveedores de mapas de sitio que se declaran en estos archivos de configuración se cargan en tiempo de ejecución y se usan para cargar y procesar los datos de navegación del sitio. El SiteMap objeto , que realiza un seguimiento de todos los proveedores que están disponibles para él a través de su Providers colección de propiedades, proporciona acceso mediante programación a los datos de navegación administrados por los proveedores. En el ejemplo de código siguiente se muestra el formato que se usa para declarar un proveedor de mapa de sitio en un archivo Web.config.
<siteMap defaultProvider="<name>">
<providers>
<add
name="<friendly name>"
type="<fully qualified class name>, <assembly name (optional)>"
siteMapFile = "<file name>" />
</providers>
</siteMap>
Otros componentes de la infraestructura de mapa del sitio, como los SiteMapPath controles y TreeView , usan los datos de navegación del sitio cargados por estos proveedores para mostrar la información del mapa del sitio para los usuarios.
Si implementa su propio proveedor de mapas de sitio, puede colocar el archivo de origen en el directorio App_Code de la aplicación ASP.NET y, a continuación, el ensamblado se compilará automáticamente. También puede colocar su propio proveedor de mapa de sitio en la caché global de ensamblados (GAC) y proporcionar una referencia completa a él en el archivo Web.config. Para obtener más información sobre los servicios del compilador, vea Trabajar con ensamblados y la caché global de ensamblados.
Notas a los implementadores
Cuando hereda de la SiteMapProvider clase , debe invalidar los siguientes miembros: GetRootNodeCore(), FindSiteMapNode(String), GetChildNodes(SiteMapNode)y GetParentNode(SiteMapNode).
Constructores
SiteMapProvider() |
Inicializa una nueva instancia de la clase SiteMapProvider. |
Propiedades
CurrentNode |
Obtiene el objeto SiteMapNode que representa la página solicitada actualmente. |
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. |
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. |
ResourceKey |
Obtiene o establece la clave de recurso utilizada para localizar los atributos SiteMapNode. |
RootNode |
Obtiene objeto SiteMapNode raíz de los datos del mapa del sitio representado por el proveedor actual. |
RootProvider |
Obtiene el objeto SiteMapProvider raíz de la jerarquía de proveedores actual. |
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. |
Métodos
AddNode(SiteMapNode) |
Agrega un objeto SiteMapNode a la colección de nodos mantenida por el proveedor del mapa del sitio. |
AddNode(SiteMapNode, SiteMapNode) |
Agrega un objeto SiteMapNode a la colección de nodos mantenida por el proveedor del mapa del sitio y especifica el objeto SiteMapNode primario. |
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. |
FindSiteMapNode(String) |
Cuando se reemplaza en una clase derivada, 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) |
Cuando se reemplaza en una clase derivada, recupera los nodos secundarios de un SiteMapNode concreto. |
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. |
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. |
GetHashCode() |
Sirve como la función hash predeterminada. (Heredado de Object) |
GetParentNode(SiteMapNode) |
Cuando se reemplaza en una clase derivada, recupera el nodo primario de un SiteMapNodeconcreto. |
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. |
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. |
GetRootNodeCore() |
Cuando se reemplaza en una clase derivada, se recupera el nodo raíz de todos los nodos administrados actualmente por el proveedor actual. |
GetRootNodeCoreFromProvider(SiteMapProvider) |
Recupera el nodo raíz de todos los nodos administrados actualmente por el proveedor del mapa del sitio especificado. |
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. |
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. |
Initialize(String, NameValueCollection) |
Inicializa la implementación de SiteMapProvider, incluyendo todos los recursos necesarios para cargar los datos del mapa del sitio desde el almacenamiento persistente. |
IsAccessibleToUser(HttpContext, SiteMapNode) |
Recupera un valor booleano que indica si el usuario puede ver el objeto SiteMapNode especificado en el contexto indicado. |
MemberwiseClone() |
Crea una copia superficial del Object actual. (Heredado de Object) |
RemoveNode(SiteMapNode) |
Quita el objeto SiteMapNode especificado de la colección de nodos mantenida por el proveedor del mapa del sitio. |
ResolveSiteMapNode(HttpContext) |
Genera el evento SiteMapResolve. |
ToString() |
Devuelve una cadena que representa el objeto actual. (Heredado de Object) |
Eventos
SiteMapResolve |
Se produce cuando se llama a la propiedad CurrentNode. |