XmlSiteMapProvider Klass

Definition

Namnområde:
System.Web
Sammansättning:
System.Web.dll

Klassen XmlSiteMapProvider härleds från klassen SiteMapProvider och är standardprovidern för webbplatsöversikt för ASP.NET. Klassen XmlSiteMapProvider genererar webbplatsmappningsträd från XML-filer med filnamnstillägget .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
Arv
Object
ProviderBase
SiteMapProvider
StaticSiteMapProvider
XmlSiteMapProvider
Implementeringar
IDisposable

Kommentarer

Klassen XmlSiteMapProvider läser in webbplatsmappningsdata från en XML-fil som följer ett känt schema. Webbplatsöversiktsdata begränsas av <siteMap> taggar och består av kapslade <siteMapNode> taggar. Två begränsningar tillämpas av SiteMapProvider klasserna och XmlSiteMapProvider på strukturen för webbplatsöversiktsdata:

  • Endast en rotnod kan finnas.

  • För SiteMapNode objekt som anger URL:er måste URL:erna vara unika inom providerns omfång. (För noder som inte anger URL:er måste alla nycklar vara unika.)

I följande kodexempel visas ett exempel på en XML-fil som kan användas med 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 är standardprovidern för ASP.NET och läser XML-data från en fil med namnet Web.sitemap som finns inom ASP.NET-programmets katalogstruktur. Som standard finns filen Web.sitemap i programroten. Men om du vill ändra namnet eller platsen för filen som XmlSiteMapProvider data läses in från kan du åsidosätta standardkonfigurationen i Web.config-filen. Genom att åsidosätta standardkonfigurationsinställningarna i din Web.config-fil kan du anpassa beteendet för XmlSiteMapProvider för varje ASP.NET program efter behov.

I följande kodexempel visas ett exempel Web.config fil, där XmlSiteMapProvider den fortfarande används, men en annan webbplatsöversiktsfil används. Eftersom alla providers i ett SiteMapProviderCollection-objekt måste namnges unikt, använder den som anges i Web.config-filen ett annat namn än standardvärdet, men anges också som standardprovider så att det används i stället för den XmlSiteMapProvider som anges i standardkonfigurationen ASP.NET.

Note

Du kan ändra namnet på webbplatsnavigeringsdatafilen, men du kan inte ändra dess tillägg. Den XmlSiteMapProvider enda läser data från filer som namnges med filnamnstillägget .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>

Konstruktorer

Name Description
XmlSiteMapProvider()

Skapar en ny, namnlös instans av XmlSiteMapProvider klassen.

Egenskaper

Name Description
CurrentNode

Hämtar objektet SiteMapNode som representerar den begärda sidan.
CurrentNode

Hämtar objektet SiteMapNode som representerar den begärda sidan.

(Ärvd från SiteMapProvider)
Description

Hämtar en kort, vänlig beskrivning som är lämplig för visning i administrativa verktyg eller andra användargränssnitt (UIs).

(Ärvd från ProviderBase)
EnableLocalization

Hämtar eller anger ett booleskt värde som anger om lokaliserade värden SiteMapNode för attribut returneras.

(Ärvd från SiteMapProvider)
Name

Hämtar det eget namn som används för att referera till providern under konfigurationen.

(Ärvd från ProviderBase)
ParentProvider

Hämtar eller anger det överordnade SiteMapProvider objektet för den aktuella providern.

(Ärvd från SiteMapProvider)
ResourceKey

Hämta eller ange resursnyckeln som används för att lokalisera SiteMapNode attribut.

(Ärvd från SiteMapProvider)
RootNode

Hämtar rotnoden för platskartan.
RootProvider

Hämtar rotobjektet SiteMapProvider i den aktuella providerhierarkin.

(Ärvd från SiteMapProvider)
SecurityTrimmingEnabled

Hämtar ett booleskt värde som anger om en webbplatsöversiktsprovider filtrerar platsmappningsnoder baserat på en användares roll.

(Ärvd från SiteMapProvider)

Metoder

Name Description
AddNode(SiteMapNode, SiteMapNode)

Lägger till ett SiteMapNode objekt i de samlingar som underhålls av den aktuella providern.
AddNode(SiteMapNode)

Lägger till ett SiteMapNode objekt i nodsamlingen som underhålls av webbplatsöversiktsprovidern.

(Ärvd från SiteMapProvider)
AddProvider(String, SiteMapNode)

Länkar en underordnad webbplatsöversiktsprovider till den aktuella providern.
BuildSiteMap()

Läser in webbplatsöversiktsinformationen från en XML-fil och skapar den i minnet.
Clear()

Tar bort alla element i samlingar av underordnade och överordnade platsmappningsnoder och platskartproviders som XmlSiteMapProvider objektet internt spårar som en del av dess tillstånd.
Dispose()

Meddelar filövervakaren för filen web.sitemap att XmlSiteMapProvider objektet inte längre kräver att filen övervakas.
Dispose(Boolean)

Meddelar filövervakaren för filen web.sitemap att XmlSiteMapProvider objektet inte längre kräver att filen övervakas. Metoden Dispose(Boolean) tar en boolesk parameter som anger om metoden anropas av användarkod.
Equals(Object)

Avgör om det angivna objektet är lika med det aktuella objektet.

(Ärvd från Object)
FindSiteMapNode(HttpContext)

Hämtar ett SiteMapNode objekt som representerar den begärda sidan med det angivna HttpContext objektet.

(Ärvd från SiteMapProvider)
FindSiteMapNode(String)

Hämtar ett SiteMapNode objekt som representerar sidan på den angivna URL:en.
FindSiteMapNodeFromKey(String)

Hämtar ett SiteMapNode objekt baserat på en angiven nyckel.
GetChildNodes(SiteMapNode)

Returnerar de underordnade noderna i webbplatskartan.
GetChildNodes(SiteMapNode)

Hämtar de underordnade platsmappningsnoderna för ett specifikt SiteMapNode objekt.

(Ärvd från StaticSiteMapProvider)
GetCurrentNodeAndHintAncestorNodes(Int32)

Tillhandahåller en optimerad uppslagsmetod för webbplatsöversiktsproviders när du hämtar noden för den aktuella sidan och hämtar de överordnade och överordnade platsmappningsnoderna för den aktuella sidan.

(Ärvd från SiteMapProvider)
GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)

Tillhandahåller en optimerad uppslagsmetod för webbplatskartproviders när du hämtar noden för den aktuella sidan och hämtar platsmappningsnoderna i närheten av den aktuella noden.

(Ärvd från SiteMapProvider)
GetHashCode()

Fungerar som standard-hash-funktion.

(Ärvd från Object)
GetParentNode(SiteMapNode)

Returnerar den överordnade noden för webbplatsöversikten.
GetParentNode(SiteMapNode)

Hämtar den överordnade platsmappningsnoden för ett specifikt SiteMapNode objekt.

(Ärvd från StaticSiteMapProvider)
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)

Tillhandahåller en optimerad uppslagsmetod för webbplatskartproviders när du hämtar en överordnad nod för den aktuella begärda sidan och hämtar de underordnade noderna för den överordnade noden.

(Ärvd från SiteMapProvider)
GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)

Tillhandahåller en optimerad uppslagsmetod för platskartasproviders när du hämtar en överordnad nod för det angivna SiteMapNode objektet och hämtar dess underordnade noder.

(Ärvd från SiteMapProvider)
GetRootNodeCore()

Hämtar noden på den översta nivån i den aktuella webbplatsöversiktens datastruktur.
GetType()

Hämtar den aktuella instansen Type .

(Ärvd från Object)
HintAncestorNodes(SiteMapNode, Int32)

Tillhandahåller en metod som webbplatsöversiktsproviders kan åsidosätta för att utföra en optimerad hämtning av en eller flera nivåer av överordnade och överordnade noder i förhållande till det angivna SiteMapNode objektet.

(Ärvd från SiteMapProvider)
HintNeighborhoodNodes(SiteMapNode, Int32, Int32)

Tillhandahåller en metod som webbplatsöversiktsleverantörer kan åsidosätta för att utföra en optimerad hämtning av noder som finns i närheten av den angivna noden.

(Ärvd från SiteMapProvider)
Initialize(String, NameValueCollection)

Initierar XmlSiteMapProvider-objektet. Metoden Initialize(String, NameValueCollection) skapar faktiskt inte en webbplatskarta, den förbereder bara tillståndet för XmlSiteMapProvider att göra det.
IsAccessibleToUser(HttpContext, SiteMapNode)

Hämtar ett booleskt värde som anger om det angivna SiteMapNode objektet kan visas av användaren i den angivna kontexten.

(Ärvd från SiteMapProvider)
MemberwiseClone()

Skapar en ytlig kopia av den aktuella Object.

(Ärvd från Object)
RemoveNode(SiteMapNode)

Tar bort det angivna SiteMapNode objektet från alla nodsamlingar som spåras av providern.
RemoveProvider(String)

Tar bort en länkad underordnad webbplatsöversiktsprovider från hierarkin för den aktuella providern.
ResolveSiteMapNode(HttpContext)

Genererar händelsen SiteMapResolve .

(Ärvd från SiteMapProvider)
ToString()

Returnerar en sträng som representerar det aktuella objektet.

(Ärvd från Object)

Händelser

Name Description
SiteMapResolve

Inträffar när egenskapen CurrentNode anropas.

(Ärvd från SiteMapProvider)

Gäller för

Se även