XmlSiteMapProvider Classe

Définition

Espace de noms:
System.Web
Assembly:
System.Web.dll

La classe XmlSiteMapProvider est dérivée de la classe SiteMapProvider et est le fournisseur de carte de site par défaut pour ASP.NET. La XmlSiteMapProvider classe génère des arborescences de mappage de site à partir de fichiers XML avec l’extension de nom de fichier .plan.

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
Object
ProviderBase
SiteMapProvider
StaticSiteMapProvider
XmlSiteMapProvider
Implémente
IDisposable

Remarques

La XmlSiteMapProvider classe charge des données de carte de site à partir d’un fichier XML qui suit un schéma connu. Les données de carte de site sont limitées par <siteMap> des balises et se composent de balises imbriquées <siteMapNode> . Deux contraintes sont imposées par les classes et XmlSiteMapProvider la SiteMapProvider structure des données de carte de site :

  • Un seul nœud racine peut exister.

  • Pour SiteMapNode les objets qui spécifient des URL, les URL doivent être uniques dans l’étendue du fournisseur. (Pour les nœuds qui ne spécifient pas d’URL, toutes les clés doivent être uniques.)

L’exemple de code suivant montre un exemple de fichier XML qui peut être utilisé avec le XmlSiteMapProviderfichier .

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

L'XmlSiteMapProvider est le fournisseur par défaut de ASP.NET et lit les données XML à partir d’un fichier nommé Web.millisecond qui se trouve dans la structure de répertoires de l’application ASP.NET. Par défaut, le fichier Web.plan se trouve à la racine de l’application ; Toutefois, si vous souhaitez modifier le nom ou l’emplacement du fichier à partir duquel les XmlSiteMapProvider données sont chargées, vous pouvez remplacer la configuration par défaut dans votre fichier Web.config. En substituant les paramètres de configuration par défaut dans votre fichier Web.config, vous pouvez adapter le comportement du XmlSiteMapProvider pour chaque application ASP.NET, si nécessaire.

L’exemple de code suivant illustre un exemple Web.config fichier, où le XmlSiteMapProvider fichier est toujours utilisé, mais un autre fichier de carte de site est utilisé. Étant donné que tous les fournisseurs d’un objet SiteMapProviderCollection doivent être nommés de manière unique, celui spécifié dans le fichier Web.config utilise un nom autre que le fournisseur par défaut, mais il est également défini comme fournisseur par défaut afin qu’il soit utilisé au lieu du XmlSiteMapProvider spécifié dans la configuration par défaut ASP.NET.

Note

Vous pouvez modifier le nom du fichier de données de navigation du site, mais vous ne pouvez pas modifier son extension. La XmlSiteMapProvider seule lecture des données à partir de fichiers nommés avec l’extension de nom de fichier .plan.

<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

Nom Description
XmlSiteMapProvider()

Crée une instance sans nom de la XmlSiteMapProvider classe.

Propriétés

Nom Description
CurrentNode

Obtient l’objet SiteMapNode qui représente la page actuellement demandée.
CurrentNode

Obtient l’objet SiteMapNode qui représente la page actuellement demandée.

(Hérité de SiteMapProvider)
Description

Obtient une brève description conviviale adaptée à l’affichage dans les outils d’administration ou d’autres interfaces utilisateur (UIs).

(Hérité de ProviderBase)
EnableLocalization

Obtient ou définit une valeur booléenne indiquant si les valeurs localisées des SiteMapNode attributs sont retournées.

(Hérité de SiteMapProvider)
Name

Obtient le nom convivial utilisé pour faire référence au fournisseur pendant la configuration.

(Hérité de ProviderBase)
ParentProvider

Obtient ou définit l’objet parent SiteMapProvider du fournisseur actuel.

(Hérité de SiteMapProvider)
ResourceKey

Obtient ou définit la clé de ressource utilisée pour localiser SiteMapNode les attributs.

(Hérité de SiteMapProvider)
RootNode

Obtient le nœud racine de la carte de site.
RootProvider

Obtient l’objet racine SiteMapProvider dans la hiérarchie du fournisseur actuel.

(Hérité de SiteMapProvider)
SecurityTrimmingEnabled

Obtient une valeur booléenne indiquant si un fournisseur de cartes de site filtre les nœuds de carte de site en fonction du rôle d’un utilisateur.

(Hérité de SiteMapProvider)

Méthodes

Nom Description
AddNode(SiteMapNode, SiteMapNode)

Ajoute un SiteMapNode objet aux collections conservées par le fournisseur actuel.
AddNode(SiteMapNode)

Ajoute un SiteMapNode objet à la collection de nœuds gérée par le fournisseur de cartes de site.

(Hérité de SiteMapProvider)
AddProvider(String, SiteMapNode)

Lie un fournisseur de carte de site enfant au fournisseur actuel.
BuildSiteMap()

Charge les informations de carte de site à partir d’un fichier XML et les génère en mémoire.
Clear()

Supprime tous les éléments dans les collections de nœuds de carte de site enfant et parent et les fournisseurs de cartes de site que l’objet XmlSiteMapProvider effectue en interne dans le cadre de son état.
Dispose()

Avertit le moniteur de fichier du fichier Web.plan que l’objet XmlSiteMapProvider n’a plus besoin de l’analyse du fichier.
Dispose(Boolean)

Avertit le moniteur de fichier du fichier Web.plan que l’objet XmlSiteMapProvider n’a plus besoin de l’analyse du fichier. La Dispose(Boolean) méthode prend un paramètre booléen indiquant si la méthode est appelée par le code utilisateur.
Equals(Object)

Détermine si l’objet spécifié est égal à l’objet actuel.

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

Récupère un SiteMapNode objet qui représente la page actuellement demandée à l’aide de l’objet spécifié HttpContext .

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

Récupère un SiteMapNode objet qui représente la page à l’URL spécifiée.
FindSiteMapNodeFromKey(String)

Récupère un SiteMapNode objet basé sur une clé spécifiée.
GetChildNodes(SiteMapNode)

Retourne les nœuds enfants de la carte de site.
GetChildNodes(SiteMapNode)

Récupère les nœuds de carte de site enfant d’un objet spécifique SiteMapNode .

(Hérité de StaticSiteMapProvider)
GetCurrentNodeAndHintAncestorNodes(Int32)

Fournit une méthode de recherche optimisée pour les fournisseurs de cartes de site lors de la récupération du nœud pour la page actuellement demandée et l’extraction des nœuds de carte de site parent et ancêtre pour la page active.

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

Fournit une méthode de recherche optimisée pour les fournisseurs de carte de site lors de la récupération du nœud pour la page actuellement demandée et l’extraction des nœuds de carte de site à proximité du nœud actuel.

(Hérité de SiteMapProvider)
GetHashCode()

Sert de fonction de hachage par défaut.

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

Retourne le nœud parent de la carte de site.
GetParentNode(SiteMapNode)

Récupère le nœud de carte de site parent d’un objet spécifique SiteMapNode .

(Hérité de StaticSiteMapProvider)
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)

Fournit une méthode de recherche optimisée pour les fournisseurs de cartes de site lors de la récupération d’un nœud ancêtre pour la page actuellement demandée et l’extraction des nœuds descendants pour l’ancêtre.

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

Fournit une méthode de recherche optimisée pour les fournisseurs de carte de site lors de la récupération d’un nœud ancêtre pour l’objet spécifié SiteMapNode et l’extraction de ses nœuds enfants.

(Hérité de SiteMapProvider)
GetRootNodeCore()

Récupère le nœud de niveau supérieur de la structure de données de carte de site actuelle.
GetType()

Obtient la Type de l’instance actuelle.

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

Fournit une méthode que les fournisseurs de cartes de site peuvent remplacer pour effectuer une récupération optimisée d’un ou plusieurs niveaux de nœuds parents et ancêtres, par rapport à l’objet spécifié SiteMapNode .

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

Fournit une méthode que les fournisseurs de carte de site peuvent remplacer pour effectuer une récupération optimisée des nœuds trouvés à proximité du nœud spécifié.

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

Initialise l'objet XmlSiteMapProvider. La Initialize(String, NameValueCollection) méthode ne crée pas réellement de carte de site, elle prépare uniquement l’état de la carte XmlSiteMapProvider .
IsAccessibleToUser(HttpContext, SiteMapNode)

Récupère une valeur booléenne indiquant si l’objet spécifié SiteMapNode peut être consulté par l’utilisateur dans le contexte spécifié.

(Hérité de SiteMapProvider)
MemberwiseClone()

Crée une copie superficielle du Objectactuel.

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

Supprime l’objet spécifié SiteMapNode de toutes les collections de nœuds suivies par le fournisseur.
RemoveProvider(String)

Supprime un fournisseur de carte de site enfant lié de la hiérarchie pour le fournisseur actuel.
ResolveSiteMapNode(HttpContext)

Déclenche l’événement SiteMapResolve.

(Hérité de SiteMapProvider)
ToString()

Retourne une chaîne qui représente l’objet actuel.

(Hérité de Object)

Événements

Nom Description
SiteMapResolve

Se produit lorsque la CurrentNode propriété est appelée.

(Hérité de SiteMapProvider)

S’applique à

Voir aussi