Udostępnij za pośrednictwem


XmlSiteMapProvider Klasa

Definicja

Klasa XmlSiteMapProvider pochodzi z SiteMapProvider klasy i jest domyślnym dostawcą mapy witryny dla ASP.NET. Klasa XmlSiteMapProvider generuje drzewa mapy witryny z plików XML z rozszerzeniem nazwy pliku .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
Dziedziczenie
Implementuje

Uwagi

Klasa XmlSiteMapProvider ładuje dane mapy witryny z pliku XML, który jest zgodny ze znanym schematem. Dane mapy witryny są powiązane z <siteMap> tagami i składają się z zagnieżdżonych <siteMapNode> tagów. Dwa ograniczenia są nakładane przez SiteMapProvider klasy i XmlSiteMapProvider na strukturę danych mapy lokacji:

  • Istnieje tylko jeden węzeł główny.

  • W przypadku SiteMapNode obiektów, które określają adresy URL, adresy URL muszą być unikatowe w zakresie dostawcy. (W przypadku węzłów, które nie określają adresów URL, wszystkie klucze muszą być unikatowe).

Poniższy przykład kodu przedstawia przykład pliku XML, który może być używany z elementem 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>  

Jest XmlSiteMapProvider to domyślny dostawca ASP.NET i odczytuje dane XML z pliku o nazwie Web.sitemap znajdującego się w strukturze katalogów aplikacji ASP.NET. Domyślnie plik Web.sitemap znajduje się w katalogu głównym aplikacji; Jeśli jednak chcesz zmienić nazwę lub lokalizację pliku, z którego XmlSiteMapProvider są ładowane dane, możesz zastąpić domyślną konfigurację w pliku Web.config. Przesłaniając domyślne ustawienia konfiguracji w pliku Web.config, można dostosować zachowanie każdej aplikacji ASP.NET zgodnie z XmlSiteMapProvider potrzebami.

Poniższy przykład kodu przedstawia przykładowy plik Web.config, w którym XmlSiteMapProvider jest nadal używany, ale jest używany inny plik mapy witryny. Ponieważ wszyscy dostawcy w SiteMapProviderCollection obiekcie muszą być nazwani unikatowo, ten, który jest określony w pliku Web.config używa nazwy innej niż domyślna, ale jest również ustawiony jako dostawca domyślny, aby był używany zamiast XmlSiteMapProvider określony w domyślnej konfiguracji ASP.NET.

Uwaga

Możesz zmienić nazwę pliku danych nawigacji witryny, ale nie można zmienić jego rozszerzenia. Tylko XmlSiteMapProvider odczytuje dane z plików o nazwie z rozszerzeniem nazwy pliku .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>  

Konstruktory

XmlSiteMapProvider()

Tworzy nowe, nienazwane wystąpienie XmlSiteMapProvider klasy .

Właściwości

CurrentNode

SiteMapNode Pobiera obiekt reprezentujący aktualnie żądaną stronę.

CurrentNode

SiteMapNode Pobiera obiekt reprezentujący aktualnie żądaną stronę.

(Odziedziczone po SiteMapProvider)
Description

Pobiera krótki, przyjazny opis odpowiedni do wyświetlania w narzędziach administracyjnych lub innych interfejsach użytkownika (UI).

(Odziedziczone po ProviderBase)
EnableLocalization

Pobiera lub ustawia wartość logiczną wskazującą, czy zwracane są zlokalizowane wartości atrybutów SiteMapNode .

(Odziedziczone po SiteMapProvider)
Name

Pobiera przyjazną nazwę używaną do odwoływania się do dostawcy podczas konfiguracji.

(Odziedziczone po ProviderBase)
ParentProvider

Pobiera lub ustawia obiekt nadrzędny SiteMapProvider bieżącego dostawcy.

(Odziedziczone po SiteMapProvider)
ResourceKey

Pobierz lub ustawia klucz zasobu używany do lokalizowania SiteMapNode atrybutów.

(Odziedziczone po SiteMapProvider)
RootNode

Pobiera węzeł główny mapy witryny.

RootProvider

Pobiera obiekt główny SiteMapProvider w bieżącej hierarchii dostawcy.

(Odziedziczone po SiteMapProvider)
SecurityTrimmingEnabled

Pobiera wartość logiczną wskazującą, czy dostawca mapy lokacji filtruje węzły mapy lokacji na podstawie roli użytkownika.

(Odziedziczone po SiteMapProvider)

Metody

AddNode(SiteMapNode, SiteMapNode)

SiteMapNode Dodaje obiekt do kolekcji, które są obsługiwane przez bieżącego dostawcę.

AddNode(SiteMapNode)

SiteMapNode Dodaje obiekt do kolekcji węzłów, która jest utrzymywana przez dostawcę mapy witryny.

(Odziedziczone po SiteMapProvider)
AddProvider(String, SiteMapNode)

Łączy dostawcę mapy lokacji podrzędnej z bieżącym dostawcą.

BuildSiteMap()

Ładuje informacje o mapie witryny z pliku XML i tworzy je w pamięci.

Clear()

Usuwa wszystkie elementy w kolekcjach węzłów podrzędnych i nadrzędnych węzłów mapy lokacji oraz dostawców map lokacji, które XmlSiteMapProvider obiekt wewnętrznie śledzi w ramach jego stanu.

Dispose()

Powiadamia monitor pliku Web.sitemap, że XmlSiteMapProvider obiekt nie wymaga już monitorowania pliku.

Dispose(Boolean)

Powiadamia monitor pliku Web.sitemap, że XmlSiteMapProvider obiekt nie wymaga już monitorowania pliku. Metoda Dispose(Boolean) przyjmuje parametr logiczny wskazujący, czy metoda jest wywoływana przez kod użytkownika.

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.

(Odziedziczone po Object)
FindSiteMapNode(HttpContext)

SiteMapNode Pobiera obiekt reprezentujący aktualnie żądaną stronę przy użyciu określonego HttpContext obiektu.

(Odziedziczone po SiteMapProvider)
FindSiteMapNode(String)

SiteMapNode Pobiera obiekt reprezentujący stronę pod określonym adresem URL.

FindSiteMapNodeFromKey(String)

SiteMapNode Pobiera obiekt na podstawie określonego klucza.

GetChildNodes(SiteMapNode)

Zwraca węzły podrzędne mapy lokacji.

GetChildNodes(SiteMapNode)

Pobiera węzły mapy lokacji podrzędnej określonego SiteMapNode obiektu.

(Odziedziczone po StaticSiteMapProvider)
GetCurrentNodeAndHintAncestorNodes(Int32)

Udostępnia zoptymalizowaną metodę wyszukiwania dla dostawców mapy lokacji podczas pobierania węzła dla aktualnie żądanej strony i pobierania węzłów mapy witryny nadrzędnej i węzłów mapy lokacji programu ancestor dla bieżącej strony.

(Odziedziczone po SiteMapProvider)
GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)

Udostępnia zoptymalizowaną metodę wyszukiwania dla dostawców mapy lokacji podczas pobierania węzła dla aktualnie żądanej strony i pobierania węzłów mapy lokacji w pobliżu bieżącego węzła.

(Odziedziczone po SiteMapProvider)
GetHashCode()

Służy jako domyślna funkcja skrótu.

(Odziedziczone po Object)
GetParentNode(SiteMapNode)

Zwraca węzeł nadrzędny mapy witryny.

GetParentNode(SiteMapNode)

Pobiera węzeł mapy lokacji nadrzędnej określonego SiteMapNode obiektu.

(Odziedziczone po StaticSiteMapProvider)
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)

Udostępnia zoptymalizowaną metodę wyszukiwania dla dostawców mapy lokacji podczas pobierania węzła ancestor dla aktualnie żądanej strony i pobierania węzłów podrzędnych dla obiektu ancestor.

(Odziedziczone po SiteMapProvider)
GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)

Udostępnia zoptymalizowaną metodę wyszukiwania dla dostawców map lokacji podczas pobierania węzła podrzędnego dla określonego SiteMapNode obiektu i pobierania jego węzłów podrzędnych.

(Odziedziczone po SiteMapProvider)
GetRootNodeCore()

Pobiera węzeł najwyższego poziomu bieżącej struktury danych mapy lokacji.

GetType()

Type Pobiera bieżące wystąpienie.

(Odziedziczone po Object)
HintAncestorNodes(SiteMapNode, Int32)

Zapewnia metodę, którą dostawcy mapy lokacji mogą zastąpić w celu przeprowadzenia zoptymalizowanego pobierania jednego lub kilku poziomów węzłów nadrzędnych i węzłów nadrzędnych względem określonego SiteMapNode obiektu.

(Odziedziczone po SiteMapProvider)
HintNeighborhoodNodes(SiteMapNode, Int32, Int32)

Zapewnia metodę, którą dostawcy mapy lokacji mogą zastąpić w celu przeprowadzenia zoptymalizowanego pobierania węzłów znajdujących się w pobliżu określonego węzła.

(Odziedziczone po SiteMapProvider)
Initialize(String, NameValueCollection)

Inicjuje XmlSiteMapProvider obiekt. Metoda Initialize(String, NameValueCollection) nie tworzy mapy lokacji, przygotowuje tylko stan XmlSiteMapProvider do wykonania.

IsAccessibleToUser(HttpContext, SiteMapNode)

Pobiera wartość logiczną wskazującą, czy określony SiteMapNode obiekt może być wyświetlany przez użytkownika w określonym kontekście.

(Odziedziczone po SiteMapProvider)
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
RemoveNode(SiteMapNode)

Usuwa określony SiteMapNode obiekt ze wszystkich kolekcji węzłów śledzonych przez dostawcę.

RemoveProvider(String)

Usuwa połączonego dostawcę mapy lokacji podrzędnej z hierarchii bieżącego dostawcy.

ResolveSiteMapNode(HttpContext)

SiteMapResolve Zgłasza zdarzenie.

(Odziedziczone po SiteMapProvider)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Zdarzenia

SiteMapResolve

Występuje, gdy właściwość jest wywoływana CurrentNode .

(Odziedziczone po SiteMapProvider)

Dotyczy

Zobacz też