XmlSiteMapProvider Třída
Definice
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 SiteMapProvider třídy a je výchozím zprostředkovatelem mapy webu pro ASP.NET. Třída XmlSiteMapProvider generuje stromy map webů ze souborů XML s příponou názvu souboru .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
- Dědičnost
- Implementuje
Poznámky
Třída XmlSiteMapProvider načte data mapy webu ze souboru XML, který se řídí známým schématem. Data mapy webu jsou ohraničená značkami <siteMap>
a skládají se z vnořených <siteMapNode>
značek. Dvě omezení jsou uložena třídami SiteMapProvider a XmlSiteMapProvider na strukturu dat mapy webu:
Může existovat pouze jeden kořenový uzel.
Pro SiteMapNode objekty, které určují adresy URL, musí být adresy URL jedinečné v rámci rozsahu zprostředkovatele. (U uzlů, 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 objektem 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>
Je XmlSiteMapProvider výchozí zprostředkovatel pro ASP.NET a čte data XML ze souboru s názvem Web.sitemap, který se nachází v adresářové struktuře aplikace ASP.NET. Ve výchozím nastavení je soubor Web.sitemap umístěn v kořenovém adresáři aplikace; Pokud však chcete změnit název nebo umístění souboru, ze kterého se XmlSiteMapProvider data načítají, můžete přepsat výchozí konfiguraci v souboru Web.config. Přepsáním výchozího nastavení konfigurace v souboru Web.config můžete podle potřeby přizpůsobit chování XmlSiteMapProvider aplikace 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í mít jedinečný název, ten, který je zadán v souboru Web.config, používá jiný název než výchozí, ale je také nastaven jako výchozí zprostředkovatel, aby se použil místo XmlSiteMapProvider toho, který je zadán ve výchozí konfiguraci ASP.NET.
Poznámka
Název souboru s daty navigace na webu můžete změnit, ale nemůžete změnit jeho příponu. Pouze XmlSiteMapProvider čte data ze souborů, které jsou pojmenovány s příponou názvu souboru .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() |
Vytvoří novou nepojmenovanou instanci XmlSiteMapProvider třídy. |
Vlastnosti
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é SiteMapNode hodnoty atributů. (Zděděno od SiteMapProvider) |
Name |
Získá popisný název použitý k odkaz na poskytovatele 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ískejte nebo nastaví klíč prostředku, který se používá k 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 zprostředkovatel mapy webu filtruje uzly mapy webu na základě role uživatele. (Zděděno od SiteMapProvider) |
Metody
AddNode(SiteMapNode, SiteMapNode) |
SiteMapNode Přidá objekt do kolekcí, které jsou spravovány aktuálním zprostředkovatelem. |
AddNode(SiteMapNode) |
SiteMapNode Přidá objekt do kolekce uzlů, který je spravován poskytovatelem mapy webu. (Zděděno od SiteMapProvider) |
AddProvider(String, SiteMapNode) |
Prováže podřízeného zprostředkovatele mapy webu s aktuálním poskytovatelem. |
BuildSiteMap() |
Načte informace mapy webu ze souboru XML a vytvoří 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ů mapy webu, které XmlSiteMapProvider objekt interně sleduje jako součást svého stavu. |
Dispose() |
Upozorní monitorování souborů souboru Web.sitemap, že XmlSiteMapProvider objekt již nevyžaduje sledování souboru. |
Dispose(Boolean) |
Upozorní monitorování souborů souboru Web.sitemap, že XmlSiteMapProvider objekt již nevyžaduje sledování souboru. Metoda Dispose(Boolean) přebírá logický parametr označující, zda je metoda volána uživatelským kódem. |
Equals(Object) |
Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object) |
FindSiteMapNode(HttpContext) |
Načte SiteMapNode objekt, který představuje aktuálně požadovanou stránku pomocí zadaného HttpContext objektu. (Zděděno od SiteMapProvider) |
FindSiteMapNode(String) |
Načte SiteMapNode objekt, který představuje stránku na zadané adrese URL. |
FindSiteMapNodeFromKey(String) |
Načte SiteMapNode 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čítání 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 poskytovatele 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í hashovací funkce. (Zděděno od Object) |
GetParentNode(SiteMapNode) |
Vrátí nadřazený uzel mapy webu. |
GetParentNode(SiteMapNode) |
Načte nadřazený uzel mapy webu konkrétního SiteMapNode objektu. (Zděděno od StaticSiteMapProvider) |
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32) |
Poskytuje optimalizovanou metodu vyhledávání pro poskytovatele mapy webu při načítání nadřazeného uzlu pro aktuálně požadovanou stránku a načítání následnických uzlů pro nadřazenou položku. (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í datové struktury mapy webu. |
GetType() |
Získá aktuální Type instanci. (Zděděno od Object) |
HintAncestorNodes(SiteMapNode, Int32) |
Poskytuje metodu, kterou zprostředkovatelé mapy webu mohou 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 zprostředkovatelé mapy webu přepsat, aby provedli optimalizované načtení 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 nevytácí mapu webu, pouze připraví stav XmlSiteMapProvider webu. |
IsAccessibleToUser(HttpContext, SiteMapNode) |
Načte logickou hodnotu označující, zda SiteMapNode zadaný objekt může být zobrazen uživatelem v zadaném kontextu. (Zděděno od SiteMapProvider) |
MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object) |
RemoveNode(SiteMapNode) |
Odebere zadaný SiteMapNode objekt ze všech kolekcí uzlů, které jsou sledovány poskytovatelem. |
RemoveProvider(String) |
Odebere propojeného podřízeného zprostředkovatele mapy webu z hierarchie aktuálního zprostředkovatele. |
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
SiteMapResolve |
Nastane při zavolání CurrentNode vlastnosti. (Zděděno od SiteMapProvider) |