XmlSiteMapProvider Classe

Définition

La classe XmlSiteMapProvider est dérivée de la classe SiteMapProvider et est le fournisseur de plan de site par défaut pour ASP.NET.The XmlSiteMapProvider class is derived from the SiteMapProvider class and is the default site map provider for ASP.NET. La classe XmlSiteMapProvider génère des arborescences de plans de site à partir de fichiers XML avec l'extension de nom de fichier .sitemap.The XmlSiteMapProvider class generates site map trees from XML files with the file name extension .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
Héritage
Implémente

Remarques

La XmlSiteMapProvider classe charge les données de plan de site à partir d’un fichier XML qui suit un schéma connu.The XmlSiteMapProvider class loads site map data from an XML file that follows a known schema. Les données de plan de site sont délimitées par <siteMap> des balises et se composent de <siteMapNode> balises imbriquées.The site map data is bounded by <siteMap> tags and consists of nested <siteMapNode> tags. Deux contraintes sont imposées SiteMapProvider par XmlSiteMapProvider les classes et sur la structure des données de plan de site:Two constraints are imposed by the SiteMapProvider and XmlSiteMapProvider classes on the structure of the site map data:

  • Un seul nœud racine peut exister.Only one root node can exist.

  • Pour SiteMapNode les objets qui spécifient des URL, les URL doivent être uniques dans l’étendue du fournisseur.For SiteMapNode objects that specify URLs, the URLs must be unique within the scope of the provider. (Pour les nœuds qui ne spécifient pas d’URL, toutes les clés doivent être uniques.)(For nodes that do not specify URLs, all keys must be unique.)

L’exemple de code suivant montre un exemple de fichier XML qui peut être utilisé avec XmlSiteMapProvider.The following code example shows an example of an XML file that can be used with the 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 Est le fournisseur par défaut pour ASP.net et il lit les données XML à partir d’un fichier nommé Web. sitemap situé dans la structure de répertoires de l’application ASP.net.The XmlSiteMapProvider is the default provider for ASP.NET and it reads XML data from a file named Web.sitemap that is located within the directory structure of the ASP.NET application. Par défaut, le fichier Web. sitemap se trouve à la racine de l’application; Toutefois, si vous souhaitez modifier le nom ou l’emplacement du fichier à partir duquel le XmlSiteMapProvider charge les données, vous pouvez remplacer la configuration par défaut dans votre fichier Web. config.By default, the Web.sitemap file is located at the application root; however, if you want to change the name or location of the file from which the XmlSiteMapProvider loads data, you can override the default configuration in your Web.config file. En remplaçant les paramètres de configuration par défaut dans votre fichier Web. config, vous pouvez personnaliser le comportement de XmlSiteMapProvider pour chaque application ASP.net, si nécessaire.By overriding the default configuration settings in your Web.config file, you can tailor the behavior of the XmlSiteMapProvider for each ASP.NET application, as necessary.

L’exemple de code suivant montre un exemple de fichier Web. config, XmlSiteMapProvider où est toujours utilisé, mais un autre fichier de plan de site est utilisé.The following code example demonstrates an example Web.config file, where the XmlSiteMapProvider is still used, but a different site map file is used. Étant donné que tous les SiteMapProviderCollection fournisseurs d’un objet doivent être nommés de manière unique, celui qui est spécifié dans le fichier Web. config utilise un nom autre que celui par défaut, mais il est également défini comme fournisseur par défaut afin qu’il XmlSiteMapProvider soit utilisé à la place du spécifié dans Th configuration ASP.NET par défaut.Because all providers in a SiteMapProviderCollection object must be named uniquely, the one that is specified in the Web.config file uses a name other than the default but is also set as the default provider so that it will be used instead of the XmlSiteMapProvider that is specified in the default ASP.NET configuration.

Notes

Vous pouvez modifier le nom du fichier de données de navigation du site, mais vous ne pouvez pas modifier son extension.You can change the name of the site navigation data file, but you cannot change its extension. Le XmlSiteMapProvider lit uniquement les données des fichiers portant l’extension de nom de fichier. sitemap.The XmlSiteMapProvider only reads data from files that are named with the file name extension .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>  

Constructeurs

XmlSiteMapProvider()

Crée une nouvelle instance sans nom de la classe XmlSiteMapProvider.Creates a new, unnamed, instance of the XmlSiteMapProvider class.

Propriétés

CurrentNode

Obtient l'objet SiteMapNode qui représente la page actuellement demandée.Gets the SiteMapNode object that represents the currently requested page.

Description

Obtient une description brève et conviviale qui peut s'afficher dans les outils d'administration ou d'autres interfaces utilisateur.Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Hérité de ProviderBase)
EnableLocalization

Obtient ou définit une valeur Boolean qui indique si des valeurs localisées des attributs SiteMapNode sont retournées.Gets or sets a Boolean value indicating whether localized values of SiteMapNode attributes are returned.

(Hérité de SiteMapProvider)
Name

Obtient le nom convivial qui référence le fournisseur au cours de la configuration.Gets the friendly name used to refer to the provider during configuration.

(Hérité de ProviderBase)
ParentProvider

Obtient ou définit l'objet SiteMapProvider parent du fournisseur actuel.Gets or sets the parent SiteMapProvider object of the current provider.

(Hérité de SiteMapProvider)
ResourceKey

Obtient ou définit la clé de ressource utilisée pour localiser des attributs SiteMapNode.Get or sets the resource key that is used for localizing SiteMapNode attributes.

(Hérité de SiteMapProvider)
RootNode

Obtient le nœud racine du plan de site.Gets the root node of the site map.

RootProvider

Obtient l'objet SiteMapProvider racine dans la hiérarchie de fournisseur actuelle.Gets the root SiteMapProvider object in the current provider hierarchy.

(Hérité de SiteMapProvider)
SecurityTrimmingEnabled

Obtient une valeur Boolean qui indique si un fournisseur de plan de site filtre ou non des nœuds en fonction du rôle d'un utilisateur.Gets a Boolean value indicating whether a site map provider filters site map nodes based on a user's role.

(Hérité de SiteMapProvider)

Méthodes

AddNode(SiteMapNode)

Ajoute un objet SiteMapNode à la collection de nœuds gérée par le fournisseur de plan de site.Adds a SiteMapNode object to the node collection that is maintained by the site map provider.

(Hérité de SiteMapProvider)
AddNode(SiteMapNode, SiteMapNode)

Ajoute un objet SiteMapNode aux collections gérées par le fournisseur actuel.Adds a SiteMapNode object to the collections that are maintained by the current provider.

AddProvider(String, SiteMapNode)

Lie un fournisseur de plan de site enfant au fournisseur actuel.Links a child site map provider to the current provider.

BuildSiteMap()

Charge les informations de plan de site à partir d'un fichier XML et les génère en mémoire.Loads the site map information from an XML file and builds it in memory.

Clear()

Supprime tous les éléments dans les collections de nœuds de plan de site enfants et parents et les fournisseurs de plan de site dont l'objet XmlSiteMapProvider effectue le suivi en interne dans le cadre de son état.Removes all elements in the collections of child and parent site map nodes and site map providers that the XmlSiteMapProvider object internally tracks as part of its state.

Dispose()

Avertit le programme de contrôle de fichiers du fichier Web.sitemap que l'objet XmlSiteMapProvider ne requiert plus le contrôle du fichier.Notifies the file monitor of the Web.sitemap file that the XmlSiteMapProvider object no longer requires the file to be monitored.

Dispose(Boolean)

Avertit le programme de contrôle de fichiers du fichier Web.sitemap que l'objet XmlSiteMapProvider ne requiert plus le contrôle du fichier.Notifies the file monitor of the Web.sitemap file that the XmlSiteMapProvider object no longer requires the file to be monitored. La méthode Dispose(Boolean) accepte un paramètre Boolean qui indique si la méthode est appelée par du code utilisateur.The Dispose(Boolean) method takes a Boolean parameter indicating whether the method is called by user code.

Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.Determines whether the specified object is equal to the current object.

(Hérité de Object)
FindSiteMapNode(HttpContext)

Récupère un objet SiteMapNode qui représente la page actuellement demandée à l'aide de l'objet HttpContext spécifié.Retrieves a SiteMapNode object that represents the currently requested page using the specified HttpContext object.

(Hérité de SiteMapProvider)
FindSiteMapNode(String)

Récupère un objet SiteMapNode qui représente la page à l'URL spécifiée.Retrieves a SiteMapNode object that represents the page at the specified URL.

FindSiteMapNodeFromKey(String)

Récupère un objet SiteMapNode selon une clé spécifiée.Retrieves a SiteMapNode object based on a specified key.

GetChildNodes(SiteMapNode)

Retourne les nœuds enfants du plan de site.Returns the child nodes of the site map.

GetCurrentNodeAndHintAncestorNodes(Int32)

Fournit une méthode de recherche optimisée pour les fournisseurs de plan de site lors de la récupération du nœud pour la page actuellement demandée et lors de l'extraction des nœuds de plan de site parents et ancêtres de la page actuelle.Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the parent and ancestor site map nodes for the current page.

(Hérité de SiteMapProvider)
GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)

Fournit une méthode de recherche optimisée aux fournisseurs de plan de site lors de la récupération du nœud pour la page actuellement demandée et lors de l'extraction de nœuds de plan de site situés à proximité du nœud actuel.Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the site map nodes in the proximity of the current node.

(Hérité de SiteMapProvider)
GetHashCode()

Sert de fonction de hachage par défaut.Serves as the default hash function.

(Hérité de Object)
GetParentNode(SiteMapNode)

Retourne le nœud parent du plan de site.Returns the parent node of the site map.

GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)

Fournit une méthode de recherche optimisée pour les fournisseurs de plan de site lors de la récupération d'un nœud ancêtre pour la page actuellement demandée et lors de l'extraction des nœuds descendants pour l'ancêtre.Provides an optimized lookup method for site map providers when retrieving an ancestor node for the currently requested page and fetching the descendant nodes for the ancestor.

(Hérité de SiteMapProvider)
GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)

Fournit une méthode de recherche optimisée pour les fournisseurs de plan de site lors de la récupération d'un nœud ancêtre pour l'objet SiteMapNode spécifié et lors de l'extraction de ses nœuds enfants.Provides an optimized lookup method for site map providers when retrieving an ancestor node for the specified SiteMapNode object and fetching its child nodes.

(Hérité de SiteMapProvider)
GetRootNodeCore()

Récupère le nœud de haut niveau de la structure de données du plan de site en cours.Retrieves the top-level node of the current site map data structure.

GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
HintAncestorNodes(SiteMapNode, Int32)

Fournit une méthode que les fournisseurs de plan de site peuvent substituer pour exécuter une récupération optimisée d'un ou plusieurs niveaux de nœuds parents et ancêtres relatifs à l'objet SiteMapNode spécifié.Provides a method that site map providers can override to perform an optimized retrieval of one or more levels of parent and ancestor nodes, relative to the specified SiteMapNode object.

(Hérité de SiteMapProvider)
HintNeighborhoodNodes(SiteMapNode, Int32, Int32)

Fournit une méthode que les fournisseurs de plan de site peuvent substituer pour exécuter une récupération optimisée des nœuds trouvés à proximité du nœud spécifié.Provides a method that site map providers can override to perform an optimized retrieval of nodes found in the proximity of the specified node.

(Hérité de SiteMapProvider)
Initialize(String, NameValueCollection)

Initialise l'objet XmlSiteMapProvider.Initializes the XmlSiteMapProvider object. La méthode Initialize(String, NameValueCollection) ne génère pas réellement de plan de site ; elle prépare seulement l'état de XmlSiteMapProvider à cette fin.The Initialize(String, NameValueCollection) method does not actually build a site map, it only prepares the state of the XmlSiteMapProvider to do so.

IsAccessibleToUser(HttpContext, SiteMapNode)

Récupère une valeur Boolean qui indique si l'objet SiteMapNode spécifié peut être affiché par l'utilisateur dans le contexte spécifié.Retrieves a Boolean value indicating whether the specified SiteMapNode object can be viewed by the user in the specified context.

(Hérité de SiteMapProvider)
MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
RemoveNode(SiteMapNode)

Supprime l'objet SiteMapNode spécifié de toutes les collections de nœuds suivies par le fournisseur.Removes the specified SiteMapNode object from all node collections that are tracked by the provider.

RemoveProvider(String)

Supprime un fournisseur de plan de site enfant lié de la hiérarchie pour le fournisseur actuel.Removes a linked child site map provider from the hierarchy for the current provider.

ResolveSiteMapNode(HttpContext)

Déclenche l'événement SiteMapResolve.Raises the SiteMapResolve event.

(Hérité de SiteMapProvider)
ToString()

Retourne une chaîne qui représente l'objet en cours.Returns a string that represents the current object.

(Hérité de Object)

Événements

SiteMapResolve

Se produit lorsque la propriété CurrentNode est appelée.Occurs when the CurrentNode property is called.

(Hérité de SiteMapProvider)

S’applique à

Voir aussi