XmlSiteMapProvider XmlSiteMapProvider XmlSiteMapProvider XmlSiteMapProvider Class

Definition

Die XmlSiteMapProvider-Klasse ist von der SiteMapProvider-Klasse abgeleitet und stellt den Standard-Siteübersichtsanbieter für ASP.NET dar.The XmlSiteMapProvider class is derived from the SiteMapProvider class and is the default site map provider for ASP.NET. Die XmlSiteMapProvider-Klasse generiert Siteübersichtsstrukturen aus XML-Dateien, die die Dateinamenerweiterung .sitemap aufweisen.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
Vererbung
Implementiert

Hinweise

Die XmlSiteMapProvider -Klasse lädt Site Übersichts Daten aus einer XML-Datei, die einem bekannten Schema folgt.The XmlSiteMapProvider class loads site map data from an XML file that follows a known schema. Die Site Übersichts Daten sind durch <siteMap> Tags begrenzt und bestehen <siteMapNode> aus schlossenen Tags.The site map data is bounded by <siteMap> tags and consists of nested <siteMapNode> tags. Zwei Einschränkungen werden von der SiteMapProvider -Klasse und der- XmlSiteMapProvider Klasse für die Struktur der Site Übersichts Daten auferlegt:Two constraints are imposed by the SiteMapProvider and XmlSiteMapProvider classes on the structure of the site map data:

  • Es kann nur ein Stamm Knoten vorhanden sein.Only one root node can exist.

  • Bei SiteMapNode Objekten, die URLs angeben, müssen die URLs innerhalb des Gültigkeits Bereichs des Anbieters eindeutig sein.For SiteMapNode objects that specify URLs, the URLs must be unique within the scope of the provider. (Bei Knoten, die keine URLs angeben, müssen alle Schlüssel eindeutig sein.)(For nodes that do not specify URLs, all keys must be unique.)

Das folgende Codebeispiel zeigt ein Beispiel für eine XML-Datei, die mit dem XmlSiteMapProviderverwendet werden kann.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 Ist der Standardanbieter für ASP.net und liest XML-Daten aus einer Datei mit dem Namen Web. Sitemap, die sich innerhalb der Verzeichnisstruktur der ASP.NET-Anwendung befindet.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. Standardmäßig befindet sich die Datei Web. Sitemap im Anwendungs Stammverzeichnis. Wenn Sie jedoch den Namen oder den Speicherort der Datei ändern möchten, von der die XmlSiteMapProvider Daten geladen werden, können Sie die Standardkonfiguration in der Datei "Web. config" überschreiben.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. Durch Überschreiben der Standard Konfigurationseinstellungen in der Datei "Web. config" können Sie das Verhalten XmlSiteMapProvider der für jede ASP.NET-Anwendung nach Bedarf anpassen.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.

Im folgenden Codebeispiel wird eine Web. config-Beispieldatei veranschaulicht, XmlSiteMapProvider in der weiterhin verwendet wird, aber eine andere Site Übersichts Datei verwendet wird.The following code example demonstrates an example Web.config file, where the XmlSiteMapProvider is still used, but a different site map file is used. Da alle Anbieter in einem SiteMapProviderCollection -Objekt eindeutig benannt werden müssen, wird in der Datei "Web. config" der in der Datei "Web. config" angegebene Name verwendet, der nicht der Standardwert ist, sondern auch als Standardanbieter XmlSiteMapProvider festgelegt wird, sodass er anstelle des-Objekts verwendet wird, das in angegeben wird. e ASP.net-Standardkonfiguration.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.

Hinweis

Sie können den Namen der Datendatei für die Standort Navigation ändern, aber die Erweiterung kann nicht geändert werden.You can change the name of the site navigation data file, but you cannot change its extension. Der XmlSiteMapProvider liest nur Daten aus Dateien, die mit der Dateinamenerweiterung. Sitemap benannt werden.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>  

Konstruktoren

XmlSiteMapProvider() XmlSiteMapProvider() XmlSiteMapProvider() XmlSiteMapProvider()

Erstellt eine neue, unbenannte Instanz der XmlSiteMapProvider-Klasse.Creates a new, unnamed, instance of the XmlSiteMapProvider class.

Eigenschaften

CurrentNode CurrentNode CurrentNode CurrentNode

Ruft das SiteMapNode-Objekt ab, das die gerade angeforderte Seite darstellt.Gets the SiteMapNode object that represents the currently requested page.

Description Description Description Description

Ruft eine kurze, benutzerfreundliche Beschreibung ab, die für die Anzeige in Verwaltungstools oder anderen Benutzeroberflächen geeignet ist.Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Inherited from ProviderBase)
EnableLocalization EnableLocalization EnableLocalization EnableLocalization

Ruft einen booleschen Wert ab, der angibt, ob lokalisierte Werte von SiteMapNode-Attributen zurückgegeben werden, oder legt diesen Wert fest.Gets or sets a Boolean value indicating whether localized values of SiteMapNode attributes are returned.

(Inherited from SiteMapProvider)
Name Name Name Name

Ruft den Anzeigennamen ab, der verwendet wird, um während der Konfiguration auf den Anbieter zu verweisen.Gets the friendly name used to refer to the provider during configuration.

(Inherited from ProviderBase)
ParentProvider ParentProvider ParentProvider ParentProvider

Ruft das übergeordnete SiteMapProvider-Objekt des aktuellen Anbieters ab oder legt dieses fest.Gets or sets the parent SiteMapProvider object of the current provider.

(Inherited from SiteMapProvider)
ResourceKey ResourceKey ResourceKey ResourceKey

Ruft den Ressourcenschlüssel zum Lokalisieren von SiteMapNode-Attributen ab oder legt diesen fest.Get or sets the resource key that is used for localizing SiteMapNode attributes.

(Inherited from SiteMapProvider)
RootNode RootNode RootNode RootNode

Ruft den Stammknoten der Siteübersicht ab.Gets the root node of the site map.

RootProvider RootProvider RootProvider RootProvider

Ruft das SiteMapProvider-Stammobjekt in der aktuellen Anbieterhierarchie ab.Gets the root SiteMapProvider object in the current provider hierarchy.

(Inherited from SiteMapProvider)
SecurityTrimmingEnabled SecurityTrimmingEnabled SecurityTrimmingEnabled SecurityTrimmingEnabled

Ruft einen booleschen Wert ab, der angibt, ob ein Siteübersichtsanbieter Siteübersichtsknoten auf seiner Benutzerrolle basierend filtert.Gets a Boolean value indicating whether a site map provider filters site map nodes based on a user's role.

(Inherited from SiteMapProvider)

Methoden

AddNode(SiteMapNode) AddNode(SiteMapNode) AddNode(SiteMapNode) AddNode(SiteMapNode)

Fügt der vom Siteübersichtsanbieter verwalteten Knotenauflistung ein SiteMapNode-Objekt hinzu.Adds a SiteMapNode object to the node collection that is maintained by the site map provider.

(Inherited from SiteMapProvider)
AddNode(SiteMapNode, SiteMapNode) AddNode(SiteMapNode, SiteMapNode) AddNode(SiteMapNode, SiteMapNode) AddNode(SiteMapNode, SiteMapNode)

Fügt den vom aktuellen Anbieter verwalteten Auflistungen ein SiteMapNode-Objekt hinzu.Adds a SiteMapNode object to the collections that are maintained by the current provider.

AddProvider(String, SiteMapNode) AddProvider(String, SiteMapNode) AddProvider(String, SiteMapNode) AddProvider(String, SiteMapNode)

Verknüpft einen untergeordneten Siteübersichtsanbieter mit dem aktuellen Anbieter.Links a child site map provider to the current provider.

BuildSiteMap() BuildSiteMap() BuildSiteMap() BuildSiteMap()

Lädt die Siteübersichtsinformationen aus einer XML-Datei und erstellt sie im Arbeitsspeicher.Loads the site map information from an XML file and builds it in memory.

Clear() Clear() Clear() Clear()

Entfernt alle Elemente aus den Auflistungen untergeordneter und übergeordneter Siteübersichtsknoten und Siteübersichtsanbieter, die vom XmlSiteMapProvider-Objekt gemäß seines Zustands intern nachverfolgt werden.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() Dispose() Dispose() Dispose()

Benachrichtigt die Dateiüberwachung der Datei Web.sitemap darüber, dass das XmlSiteMapProvider-Objekt keine Überwachung der Datei mehr benötigt.Notifies the file monitor of the Web.sitemap file that the XmlSiteMapProvider object no longer requires the file to be monitored.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Benachrichtigt die Dateiüberwachung der Datei Web.sitemap darüber, dass das XmlSiteMapProvider-Objekt keine Überwachung der Datei mehr benötigt.Notifies the file monitor of the Web.sitemap file that the XmlSiteMapProvider object no longer requires the file to be monitored. Die Dispose(Boolean)-Methode nimmt einen booleschen Parameter an, der angibt, ob die Methode von Benutzercode aufgerufen wird.The Dispose(Boolean) method takes a Boolean parameter indicating whether the method is called by user code.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindSiteMapNode(HttpContext) FindSiteMapNode(HttpContext) FindSiteMapNode(HttpContext) FindSiteMapNode(HttpContext)

Ruft ein SiteMapNode-Objekt ab, das die gerade angeforderte Seite mithilfe des angegebenen HttpContext-Objekts darstellt.Retrieves a SiteMapNode object that represents the currently requested page using the specified HttpContext object.

(Inherited from SiteMapProvider)
FindSiteMapNode(String) FindSiteMapNode(String) FindSiteMapNode(String) FindSiteMapNode(String)

Ruft ein SiteMapNode-Objekt ab, das die Seite an der angegebenen URL darstellt.Retrieves a SiteMapNode object that represents the page at the specified URL.

FindSiteMapNodeFromKey(String) FindSiteMapNodeFromKey(String) FindSiteMapNodeFromKey(String) FindSiteMapNodeFromKey(String)

Ruft ein SiteMapNode-Objekt auf Grundlage eines angegebenen Schlüssels ab.Retrieves a SiteMapNode object based on a specified key.

GetChildNodes(SiteMapNode) GetChildNodes(SiteMapNode) GetChildNodes(SiteMapNode) GetChildNodes(SiteMapNode)

Gibt die untergeordneten Knoten der Siteübersicht zurück.Returns the child nodes of the site map.

GetCurrentNodeAndHintAncestorNodes(Int32) GetCurrentNodeAndHintAncestorNodes(Int32) GetCurrentNodeAndHintAncestorNodes(Int32) GetCurrentNodeAndHintAncestorNodes(Int32)

Stellt Siteübersichtsanbietern eine optimierte Nachschlagemethode zum Abrufen des Knotens für die gerade angeforderte Seite und zum Abrufen der mittelbar und unmittelbar übergeordneten Knoten für die aktuelle Seite bereit.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.

(Inherited from SiteMapProvider)
GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32) GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32) GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32) GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)

Stellt Siteübersichtsanbietern eine optimierte Nachschlagemethode zum Abrufen des Knotens für die gerade angeforderte Seite und zum Abrufen der Siteübersichtsknoten im unmittelbaren Umfeld des aktuellen Knotens bereit.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.

(Inherited from SiteMapProvider)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Inherited from Object)
GetParentNode(SiteMapNode) GetParentNode(SiteMapNode) GetParentNode(SiteMapNode) GetParentNode(SiteMapNode)

Gibt den übergeordneten Knoten des Lageplans zurück.Returns the parent node of the site map.

GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32) GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32) GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32) GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)

Stellt Siteübersichtsanbietern eine optimierte Nachschlagemethode zum Abrufen eines mittelbar übergeordneten Knotens für die gerade angeforderte Seite und zum Abrufen der mittelbar untergeordneten Knoten für den übergeordneten Knoten bereit.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.

(Inherited from SiteMapProvider)
GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32) GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32) GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32) GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)

Stellt Siteübersichtsanbietern eine optimierte Nachschlagemethode zum Abrufen eines mittelbar übergeordneten Knotens für das angegebene SiteMapNode-Objekt und zum Abrufen der unmittelbar untergeordneten Knoten bereit.Provides an optimized lookup method for site map providers when retrieving an ancestor node for the specified SiteMapNode object and fetching its child nodes.

(Inherited from SiteMapProvider)
GetRootNodeCore() GetRootNodeCore() GetRootNodeCore() GetRootNodeCore()

Ruft den Knoten der obersten Ebene der aktuellen Datenstruktur der Siteübersicht ab.Retrieves the top-level node of the current site map data structure.

GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
HintAncestorNodes(SiteMapNode, Int32) HintAncestorNodes(SiteMapNode, Int32) HintAncestorNodes(SiteMapNode, Int32) HintAncestorNodes(SiteMapNode, Int32)

Stellt eine Methode bereit, die Siteübersichtsanbieter überschreiben können, um mindestens eine Ebene mittelbar und unmittelbar übergeordneter Knoten (relativ zum angegebenen SiteMapNode-Objekt) optimal abzurufen.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.

(Inherited from SiteMapProvider)
HintNeighborhoodNodes(SiteMapNode, Int32, Int32) HintNeighborhoodNodes(SiteMapNode, Int32, Int32) HintNeighborhoodNodes(SiteMapNode, Int32, Int32) HintNeighborhoodNodes(SiteMapNode, Int32, Int32)

Stellt eine Methode bereit, die Siteübersichtsanbieter überschreiben können, um einen optimierten Abruf von Knoten auszuführen, die im unmittelbaren Umfeld des angegebenen Knotens gefunden werden.Provides a method that site map providers can override to perform an optimized retrieval of nodes found in the proximity of the specified node.

(Inherited from SiteMapProvider)
Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection)

Initialisiert das XmlSiteMapProvider-Objekt.Initializes the XmlSiteMapProvider object. Die Initialize(String, NameValueCollection)-Methode erstellt nicht direkt eine Siteübersicht. Sie bereitet lediglich den Zustand des XmlSiteMapProvider dafür vor.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) IsAccessibleToUser(HttpContext, SiteMapNode) IsAccessibleToUser(HttpContext, SiteMapNode) IsAccessibleToUser(HttpContext, SiteMapNode)

Ruft einen booleschen Wert ab, der angibt, ob das angegebene SiteMapNode-Objekt vom Benutzer im angegebenen Kontext angezeigt werden kann.Retrieves a Boolean value indicating whether the specified SiteMapNode object can be viewed by the user in the specified context.

(Inherited from SiteMapProvider)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
RemoveNode(SiteMapNode) RemoveNode(SiteMapNode) RemoveNode(SiteMapNode) RemoveNode(SiteMapNode)

Entfernt das angegebene SiteMapNode-Objekt aus allen Knotenauflistungen, die vom Anbieter verfolgt werden.Removes the specified SiteMapNode object from all node collections that are tracked by the provider.

RemoveProvider(String) RemoveProvider(String) RemoveProvider(String) RemoveProvider(String)

Entfernt einen verknüpften untergeordneten Siteübersichtsanbieter aus der Hierarchie für den aktuellen Anbieter.Removes a linked child site map provider from the hierarchy for the current provider.

ResolveSiteMapNode(HttpContext) ResolveSiteMapNode(HttpContext) ResolveSiteMapNode(HttpContext) ResolveSiteMapNode(HttpContext)

Löst das SiteMapResolve-Ereignis aus.Raises the SiteMapResolve event.

(Inherited from SiteMapProvider)
ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Ereignisse

SiteMapResolve SiteMapResolve SiteMapResolve SiteMapResolve

Tritt ein, wenn die CurrentNode-Eigenschaft aufgerufen wird.Occurs when the CurrentNode property is called.

(Inherited from SiteMapProvider)

Gilt für:

Siehe auch