XmlSiteMapProvider Třída

Definice

Obor názvů:: System.Web

Sestavení:: System.Web.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Třída XmlSiteMapProvider je odvozena od třídy SiteMapProvider a je výchozím poskytovatelem mapy webu pro ASP.NET. Třída XmlSiteMapProvider generuje stromy mapy webu ze souborů XML s příponou názvu souboru .mapa webu.

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

Dědičnost: Object

ProviderBase

SiteMapProvider

StaticSiteMapProvider
XmlSiteMapProvider

Implementuje: IDisposable

Poznámky

Třída XmlSiteMapProvider načte data mapy webu ze souboru XML, který následuje po známém schématu. Data mapy webu jsou svázaná značkami <siteMap> a skládají se z vnořených <siteMapNode> značek. Dvě omezení jsou stanovena třídami SiteMapProvider XmlSiteMapProvider struktury dat mapy webu:

Může existovat pouze jeden kořenový uzel.
U SiteMapNode objektů, které určují adresy URL, musí být adresy URL jedinečné v rámci oboru poskytovatele. (Pro uzly, které nezadávají adresy URL, musí být všechny klíče jedinečné.)

Následující příklad kódu ukazuje příklad souboru XML, který lze použít s 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 je výchozím zprostředkovatelem pro ASP.NET a čte data XML ze souboru s názvem Web.mapa webu, který se nachází v adresářové struktuře aplikace ASP.NET. Ve výchozím nastavení se soubor Web.mapa webu nachází v kořenovém adresáři aplikace; Pokud ale chcete změnit název nebo umístění souboru, ze kterého XmlSiteMapProvider se načítají data, můžete přepsat výchozí konfiguraci v souboru Web.config. Přepsáním výchozích nastavení konfigurace v souboru Web.config můžete podle potřeby přizpůsobit chování XmlSiteMapProvider pro každou aplikaci ASP.NET.

Následující příklad kódu ukazuje příklad Web.config souboru, kde XmlSiteMapProvider se stále používá, ale používá se jiný soubor mapy webu. Vzhledem k tomu, že všichni zprostředkovatelé v objektu SiteMapProviderCollection musí být pojmenovaní jedinečně, musí být v souboru Web.config zadán jiný název než výchozí, ale je také nastaven jako výchozí zprostředkovatel tak, aby se používal místo XmlSiteMapProvider, který je zadán ve výchozí konfiguraci ASP.NET.

Note

Název datového souboru navigace webu můžete změnit, ale jeho příponu nemůžete změnit. Pouze XmlSiteMapProvider čte data ze souborů, které jsou pojmenované s příponou názvu souboru .mapa webu.

<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

Name	Description
XmlSiteMapProvider()	Vytvoří novou, nepojmenovanou instanci XmlSiteMapProvider třídy.

Vlastnosti

Name	Description
CurrentNode	SiteMapNode Získá objekt, který představuje aktuálně požadovanou stránku.
CurrentNode	SiteMapNode Získá objekt, který představuje aktuálně požadovanou stránku. (Zděděno od SiteMapProvider)
Description	Získá stručný popis vhodný pro zobrazení v nástrojích pro správu nebo jiných uživatelských rozhraních (UI). (Zděděno od ProviderBase)
EnableLocalization	Získá nebo nastaví logickou hodnotu označující, zda jsou vráceny lokalizované hodnoty SiteMapNode atributů. (Zděděno od SiteMapProvider)
Name	Získá popisný název použitý k odkazování na zprostředkovatele během konfigurace. (Zděděno od ProviderBase)
ParentProvider	Získá nebo nastaví nadřazený SiteMapProvider objekt aktuálního zprostředkovatele. (Zděděno od SiteMapProvider)
ResourceKey	Získá nebo nastaví klíč prostředku, který se používá pro lokalizaci SiteMapNode atributů. (Zděděno od SiteMapProvider)
RootNode	Získá kořenový uzel mapy webu.
RootProvider	Získá kořenový SiteMapProvider objekt v aktuální hierarchii zprostředkovatele. (Zděděno od SiteMapProvider)
SecurityTrimmingEnabled	Získá logickou hodnotu označující, zda poskytovatel mapy webu filtruje uzly mapy webu na základě role uživatele. (Zděděno od SiteMapProvider)

Metody

Name	Description
AddNode(SiteMapNode, SiteMapNode)	SiteMapNode Přidá objekt do kolekcí, které jsou udržovány aktuálním poskytovatelem.
AddNode(SiteMapNode)	SiteMapNode Přidá objekt do kolekce uzlů, která je udržována poskytovatelem mapy webu. (Zděděno od SiteMapProvider)
AddProvider(String, SiteMapNode)	Propojuje podřízeného zprostředkovatele mapy webu s aktuálním poskytovatelem.
BuildSiteMap()	Načte informace o mapě webu ze souboru XML a sestaví je v paměti.
Clear()	Odebere všechny prvky v kolekcích podřízených a nadřazených uzlů mapy webu a zprostředkovatelů map webů, které XmlSiteMapProvider objekt interně sleduje jako součást jeho stavu.
Dispose()	Upozorní monitorování souboru Web.mapa webu, že XmlSiteMapProvider objekt už nevyžaduje monitorování souboru.
Dispose(Boolean)	Upozorní monitorování souboru Web.mapa webu, že XmlSiteMapProvider objekt už nevyžaduje monitorování souboru. Metoda Dispose(Boolean) přebírá logický parametr označující, zda metoda je volána uživatelským kódem.
Equals(Object)	Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object)
FindSiteMapNode(HttpContext)	SiteMapNode Načte objekt, který představuje aktuálně požadovanou stránku pomocí zadaného HttpContext objektu. (Zděděno od SiteMapProvider)
FindSiteMapNode(String)	SiteMapNode Načte objekt, který představuje stránku na zadané adrese URL.
FindSiteMapNodeFromKey(String)	SiteMapNode Načte objekt na základě zadaného klíče.
GetChildNodes(SiteMapNode)	Vrátí podřízené uzly mapy webu.
GetChildNodes(SiteMapNode)	Načte podřízené uzly mapy webu konkrétního SiteMapNode objektu. (Zděděno od StaticSiteMapProvider)
GetCurrentNodeAndHintAncestorNodes(Int32)	Poskytuje optimalizovanou metodu vyhledávání pro zprostředkovatele mapy webu při načítání uzlu pro aktuálně požadovanou stránku a načtení nadřazených a nadřazených uzlů mapy webu pro aktuální stránku. (Zděděno od SiteMapProvider)
GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)	Poskytuje optimalizovanou metodu vyhledávání pro zprostředkovatele mapy webu při načítání uzlu pro aktuálně požadovanou stránku a načítání uzlů mapy webu v blízkosti aktuálního uzlu. (Zděděno od SiteMapProvider)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetParentNode(SiteMapNode)	Vrátí nadřazený uzel mapy webu.
GetParentNode(SiteMapNode)	Načte uzel mapy nadřazeného webu konkrétního SiteMapNode objektu. (Zděděno od StaticSiteMapProvider)
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)	Poskytuje optimalizovanou metodu vyhledávání pro zprostředkovatele mapy webu při načítání nadřazeného uzlu pro aktuálně požadovanou stránku a načtení následnických uzlů pro nadřazeného objektu. (Zděděno od SiteMapProvider)
GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)	Poskytuje optimalizovanou metodu vyhledávání pro zprostředkovatele mapy webu při načítání nadřazeného uzlu pro zadaný SiteMapNode objekt a načítání jeho podřízených uzlů. (Zděděno od SiteMapProvider)
GetRootNodeCore()	Načte uzel nejvyšší úrovně aktuální struktury dat mapy webu.
GetType()	Získá Type aktuální instance. (Zděděno od Object)
HintAncestorNodes(SiteMapNode, Int32)	Poskytuje metodu, kterou můžou poskytovatelé map webu přepsat, aby provedli optimalizované načtení jedné nebo více úrovní nadřazených a nadřazených uzlů vzhledem k zadanému SiteMapNode objektu. (Zděděno od SiteMapProvider)
HintNeighborhoodNodes(SiteMapNode, Int32, Int32)	Poskytuje metodu, kterou můžou poskytovatelé mapy webu přepsat, aby provedli optimalizované načítání uzlů nalezených v blízkosti zadaného uzlu. (Zděděno od SiteMapProvider)
Initialize(String, NameValueCollection)	Inicializuje XmlSiteMapProvider objekt. Metoda Initialize(String, NameValueCollection) ve skutečnosti nevystaví mapu webu, připraví pouze stav, který XmlSiteMapProvider má provést.
IsAccessibleToUser(HttpContext, SiteMapNode)	Načte logickou hodnotu označující, zda zadaný SiteMapNode objekt může zobrazit uživatel v zadaném kontextu. (Zděděno od SiteMapProvider)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
RemoveNode(SiteMapNode)	Odebere zadaný SiteMapNode objekt ze všech kolekcí uzlů, které sleduje poskytovatel.
RemoveProvider(String)	Odebere z hierarchie pro aktuálního zprostředkovatele propojené podřízené mapy webu.
ResolveSiteMapNode(HttpContext)	SiteMapResolve Vyvolá událost. (Zděděno od SiteMapProvider)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Událost

Name	Description
SiteMapResolve	Vyvolá se CurrentNode při zavolání vlastnosti. (Zděděno od SiteMapProvider)

Platí pro

Viz také

Váš názor

Byla tato stránka užitečná?