XmlSiteMapProvider クラス

リファレンス

定義

名前空間:: System.Web

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

XmlSiteMapProvider クラスは、SiteMapProvider クラスから派生します。これは、ASP.NET の既定のサイトマッププロバイダーです。 XmlSiteMapProvider クラスは、ファイル名拡張子が .sitemap の XML ファイルからサイトマップツリーを生成します。

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

継承: Object

ProviderBase

SiteMapProvider

StaticSiteMapProvider
XmlSiteMapProvider

実装: IDisposable

注釈

クラスは、既知の XmlSiteMapProvider スキーマに従う XML ファイルからサイトマップデータを読み込みます。サイトマップデータはタグで <siteMap> 囲まれており、入れ子になった <siteMapNode> タグで構成されます。サイトマップデータの構造に対して SiteMapProvider クラスと XmlSiteMapProvider クラスによって、次の 2 つの制約が課されます。

存在できるルートノードは 1 つだけです。
URL を指定するオブジェクトの場合 SiteMapNode 、URL はプロバイダーのスコープ内で一意である必要があります。 (URL を指定しないノードの場合、すべてのキーは一意である必要があります)。

次のコード例は、で使用できる XML ファイルの例を 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は ASP.NET の既定のプロバイダーであり、ASP.NET アプリケーションのディレクトリ構造内にある Web.sitemap という名前のファイルから XML データを読み取ります。既定では、Web.sitemap ファイルはアプリケーションルートにあります。ただし、データの読み込み元のファイルの名前または場所を変更する XmlSiteMapProvider 場合は、Web.config ファイルの既定の構成をオーバーライドできます。 Web.config ファイルの既定の構成設定をオーバーライドすることで、必要に応じて、ASP.NET アプリケーションごとにの XmlSiteMapProvider 動作を調整できます。

次のコード例は、Web.config ファイルの例を示しています。ここで XmlSiteMapProvider 、は引き続き使用されますが、別のサイトマップファイルが使用されます。オブジェクト内のすべてのプロバイダーは一意に名前を SiteMapProviderCollection 付ける必要があるため、Web.config ファイルで指定されたプロバイダーは既定以外の名前を使用しますが、既定のプロバイダーとしても設定されるため、既定の ASP.NET 構成で指定されているの XmlSiteMapProvider 代わりに使用されます。

注意

サイトナビゲーションデータファイルの名前は変更できますが、その拡張子は変更できません。は XmlSiteMapProvider 、ファイル名拡張子 .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>

コンストラクター

XmlSiteMapProvider()

XmlSiteMapProvider クラスの名前のない新しいインスタンスを作成します。

プロパティ

CurrentNode	現在要求されているページを表す SiteMapNode オブジェクトを取得します。
CurrentNode	現在要求されているページを表す SiteMapNode オブジェクトを取得します。 (継承元 SiteMapProvider)
Description	管理ツールまたは他のユーザーインターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。 (継承元 ProviderBase)
EnableLocalization	SiteMapNode 属性のローカライズされた値が返されるかどうかを示すブール値を取得または設定します。 (継承元 SiteMapProvider)
Name	構成時にプロバイダーを参照するために使用される表示名を取得します。 (継承元 ProviderBase)
ParentProvider	現在のプロバイダーの親 SiteMapProvider オブジェクトを取得または設定します。 (継承元 SiteMapProvider)
ResourceKey	SiteMapNode 属性のローカライズに使用するリソースキーを取得または設定します。 (継承元 SiteMapProvider)
RootNode	サイトマップのルートノードを取得します。
RootProvider	現在のプロバイダー階層のルート SiteMapProvider オブジェクトを取得します。 (継承元 SiteMapProvider)
SecurityTrimmingEnabled	サイトマッププロバイダーがユーザーのロールに基づいてサイトマップノードをフィルター処理するかどうかを示すブール値を取得します。 (継承元 SiteMapProvider)

メソッド

AddNode(SiteMapNode, SiteMapNode)	現在のプロバイダーで管理しているコレクションに SiteMapNode オブジェクトを追加します。
AddNode(SiteMapNode)	サイトマッププロバイダーが管理するノードコレクションに SiteMapNode オブジェクトを追加します。 (継承元 SiteMapProvider)
AddProvider(String, SiteMapNode)	子サイトマッププロバイダーを現在のプロバイダーにリンクします。
BuildSiteMap()	XML ファイルからサイトマップ情報を読み込み、メモリ内で構築します。
Clear()	XmlSiteMapProvider オブジェクトが状態の一部として内部的に追跡する、子サイトマップノード、親サイトマップノード、およびサイトマッププロバイダーのコレクションに含まれているすべての要素を削除します。
Dispose()	Web.sitemap ファイルの監視機能に対し、XmlSiteMapProvider オブジェクトがファイルの監視を要求していないことを通知します。
Dispose(Boolean)	Web.sitemap ファイルの監視機能に対し、XmlSiteMapProvider オブジェクトがファイルの監視を要求していないことを通知します。 Dispose(Boolean) メソッドは、メソッドがユーザーコードによって呼び出されているかどうかを示すブール型のパラメーターをとります。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
FindSiteMapNode(HttpContext)	現在要求されているページを表す SiteMapNode オブジェクトを、指定した HttpContext オブジェクトを使用して取得します。 (継承元 SiteMapProvider)
FindSiteMapNode(String)	指定した URL のページを表す SiteMapNode オブジェクトを取得します。
FindSiteMapNodeFromKey(String)	指定したキーに基づいて SiteMapNode オブジェクトを取得します。
GetChildNodes(SiteMapNode)	サイトマップの子ノードを返します。
GetChildNodes(SiteMapNode)	特定の SiteMapNode オブジェクトの子サイトマップノードを取得します。 (継承元 StaticSiteMapProvider)
GetCurrentNodeAndHintAncestorNodes(Int32)	現在要求されているページのノードを取得し、現在のページの親および先祖のサイトマップノードをフェッチする際、サイトマッププロバイダーに最適化された検索メソッドを提供します。 (継承元 SiteMapProvider)
GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)	現在要求されているページのノードを検索し、現在のノードの近くのサイトマップノードをフェッチする際、サイトマッププロバイダーに最適化された検索メソッドを提供します。 (継承元 SiteMapProvider)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetParentNode(SiteMapNode)	サイトマップの親ノードを返します。
GetParentNode(SiteMapNode)	特定の SiteMapNode オブジェクトの親サイトマップノードを取得します。 (継承元 StaticSiteMapProvider)
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)	現在要求されているページの先祖ノードを取得し、その先祖の子孫ノードをフェッチする際、サイトマッププロバイダーに最適化された検索メソッドを提供します。 (継承元 SiteMapProvider)
GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)	指定した SiteMapNode オブジェクトの先祖ノードを取得して、その子ノードをフェッチする際に、サイトマッププロバイダーに最適化された検索メソッドを提供します。 (継承元 SiteMapProvider)
GetRootNodeCore()	現在のサイトマップデータ構造の最上位ノードを取得します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
HintAncestorNodes(SiteMapNode, Int32)	サイトマッププロバイダーがオーバーライドして、指定した SiteMapNode オブジェクトの相対として 1 つ以上のレベルの親ノードと先祖ノードの最適化された取得を実行できるメソッドを提供します。 (継承元 SiteMapProvider)
HintNeighborhoodNodes(SiteMapNode, Int32, Int32)	サイトマッププロバイダーがオーバーライドして、指定したノードの近くで見つかったノードの最適化された取得を実行できるメソッドを提供します。 (継承元 SiteMapProvider)
Initialize(String, NameValueCollection)	XmlSiteMapProvider オブジェクトを初期化します。 Initialize(String, NameValueCollection) メソッドは、実際のサイトマップ構築は行わず、構築するための XmlSiteMapProvider の状態を準備するだけです。
IsAccessibleToUser(HttpContext, SiteMapNode)	指定した SiteMapNode オブジェクトを、指定したコンテキストでユーザーが表示できるかどうかを示すブール値を取得します。 (継承元 SiteMapProvider)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
RemoveNode(SiteMapNode)	指定した SiteMapNode オブジェクトを、プロバイダーによる追跡対象のすべてのノードコレクションから削除します。
RemoveProvider(String)	現在のプロバイダーの階層から、リンクされている子サイトマッププロバイダーを削除します。
ResolveSiteMapNode(HttpContext)	SiteMapResolve イベントを発生させます。 (継承元 SiteMapProvider)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

イベント

SiteMapResolve

CurrentNode プロパティが呼び出されると発生します。

(継承元 SiteMapProvider)

適用対象

次の方法で共有