XmlSiteMapProviderとは? わかりやすく解説

XmlSiteMapProvider イベント


XmlSiteMapProvider クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web
アセンブリ: System.Web (system.web.dll 内)
構文構文

Public Class XmlSiteMapProvider
    Inherits StaticSiteMapProvider
    Implements IDisposable
Dim instance As XmlSiteMapProvider
public class XmlSiteMapProvider : StaticSiteMapProvider,
 IDisposable
public ref class XmlSiteMapProvider : public
 StaticSiteMapProvider, IDisposable
public class XmlSiteMapProvider extends StaticSiteMapProvider
 implements IDisposable
public class XmlSiteMapProvider extends
 StaticSiteMapProvider implements IDisposable
解説解説

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

次のコード例は、XmlSiteMapProvider で使用できる XML ファイルの例を示しています。

<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>
.NET Framework のセキュリティ.NET Framework のセキュリティ
継承階層継承階層
System.Object
   System.Configuration.Provider.ProviderBase
     System.Web.SiteMapProvider
       System.Web.StaticSiteMapProvider
        System.Web.XmlSiteMapProvider
スレッド セーフスレッド セーフ
この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照

XmlSiteMapProvider コンストラクタ


XmlSiteMapProvider プロパティ


パブリック プロパティパブリック プロパティ

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

XmlSiteMapProvider メソッド


パブリック メソッドパブリック メソッド

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

XmlSiteMapProvider メンバ

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

XmlSiteMapProvider データ型で公開されるメンバを以下の表に示します。


パブリック コンストラクタパブリック コンストラクタ
  名前 説明
パブリック メソッド XmlSiteMapProvider XmlSiteMapProvider クラスの名前のない新しいインスタンスを作成します。
パブリック プロパティパブリック プロパティ
  名前 説明
パブリック プロパティ CurrentNode  現在要求されているページを表す SiteMapNode オブジェクトを取得します。(SiteMapProvider から継承されます。)
パブリック プロパティ Description  管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。(ProviderBase から継承されます。)
パブリック プロパティ EnableLocalization  SiteMapNode 属性のローカライズされた値が返されるかどうかを示すブール値を取得または設定します。(SiteMapProvider から継承されます。)
パブリック プロパティ Name  構成時にプロバイダを参照するために使用される表示名を取得します。(ProviderBase から継承されます。)
パブリック プロパティ ParentProvider  現在のプロバイダの親 SiteMapProvider オブジェクトを取得または設定します。(SiteMapProvider から継承されます。)
パブリック プロパティ ResourceKey  SiteMapNode 属性のローカライズに使用するリソース キーを取得または設定します。 (SiteMapProvider から継承されます。)
パブリック プロパティ RootNode オーバーライドされます。 サイト マップのルート ノードを取得します。
パブリック プロパティ RootProvider  現在のプロバイダ階層のルート SiteMapProvider オブジェクトを取得します。(SiteMapProvider から継承されます。)
パブリック プロパティ SecurityTrimmingEnabled  サイト マップ プロバイダがユーザーのロールに基づいてサイト マップ ノードをフィルタ処理するかどうかを示すブール値を取得します。(SiteMapProvider から継承されます。)
パブリック メソッドパブリック メソッド
( プロテクト メソッド も参照)
  名前 説明
パブリック メソッド BuildSiteMap オーバーライドされます。 XML ファイルからサイト マップ情報を読み込み、メモリ内で構築します。
パブリック メソッド Dispose オーバーロードされます。 Web.sitemap ファイルの監視機能に対し、XmlSiteMapProvider オブジェクトがファイルの監視を要求していないことを通知します。
パブリック メソッド Equals  オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
パブリック メソッド FindSiteMapNode オーバーロードされます。 サイト マップ ノードを検索条件に基づいて取得します。
パブリック メソッド FindSiteMapNodeFromKey オーバーライドされます。 指定したキーに基づいて SiteMapNode オブジェクトを取得します。
パブリック メソッド GetChildNodes  特定の SiteMapNode オブジェクトの子サイト マップ ノードを取得します。 (StaticSiteMapProvider から継承されます。)
パブリック メソッド GetCurrentNodeAndHintAncestorNodes  現在要求されているページのノードを検索し、現在のページの親および先祖のサイト マップ ノードをフェッチする際に、最適化された検索メソッドをサイト マップ プロバイダに提供します。 (SiteMapProvider から継承されます。)
パブリック メソッド GetCurrentNodeAndHintNeighborhoodNodes  現在要求されているページのノードを検索し、現在のノードの近くのサイト マップ ノードをフェッチする際に、最適化された検索メソッドをサイト マップ プロバイダに提供します。 (SiteMapProvider から継承されます。)
パブリック メソッド GetHashCode  特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
パブリック メソッド GetParentNode  特定の SiteMapNode オブジェクトの親サイト マップ ノードを取得します。 (StaticSiteMapProvider から継承されます。)
パブリック メソッド GetParentNodeRelativeToCurrentNodeAndHintDownFromParent  現在要求されているページの先祖ノードを検索し、その先祖の子孫ノードをフェッチする際に、最適化された検索メソッドをサイト マップ プロバイダに提供します。 (SiteMapProvider から継承されます。)
パブリック メソッド GetParentNodeRelativeToNodeAndHintDownFromParent  指定した SiteMapNode オブジェクトの先祖ノードを取得して、その子ノードをフェッチする際に、最適化された検索メソッドをサイト マップ プロバイダに提供します。 (SiteMapProvider から継承されます。)
パブリック メソッド GetType  現在のインスタンスの Type を取得します。 (Object から継承されます。)
パブリック メソッド HintAncestorNodes  サイト マップ プロバイダがオーバーライドして、指定した SiteMapNode オブジェクトの相対として 1 つ以上のレベルの親ノードと先祖ノードの最適化された取得を実行できるメソッドを提供します。 (SiteMapProvider から継承されます。)
パブリック メソッド HintNeighborhoodNodes  サイト マップ プロバイダがオーバーライドして、指定したノードの近くで見つかったノードの最適化された取得を実行できるメソッドを提供します。 (SiteMapProvider から継承されます。)
パブリック メソッド Initialize オーバーライドされます。 XmlSiteMapProvider オブジェクトを初期化します。Initialize メソッドは、実際のサイト マップ構築は行わず、構築するための XmlSiteMapProvider の状態を準備するだけです。
パブリック メソッド IsAccessibleToUser  指定した SiteMapNode オブジェクトを指定したコンテキストでユーザーが表示できるかどうかを示すブール値を取得します。 (SiteMapProvider から継承されます。)
パブリック メソッド ReferenceEquals  指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
パブリック メソッド ToString  現在の Object を表す String を返します。 (Object から継承されます。)
プロテクト メソッドプロテクト メソッド
  名前 説明
プロテクト メソッド AddNode オーバーロードされます。 現在のプロバイダで管理しているコレクションに SiteMapNode オブジェクトを追加します。
プロテクト メソッド AddProvider 子サイト マップ プロバイダを現在のプロバイダにリンクします。
プロテクト メソッド Clear オーバーライドされます。 XmlSiteMapProvider オブジェクトが状態の一部として内部的に追跡する、子サイト マップ ノード、親サイト マップ ノード、およびサイト マップ プロバイダのコレクションに含まれているすべての要素を削除します。
プロテクト メソッド Dispose オーバーロードされます。 Web.sitemap ファイルの監視機能に対し、XmlSiteMapProvider オブジェクトがファイルの監視を要求していないことを通知します。
プロテクト メソッド Finalize  Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
プロテクト メソッド GetRootNodeCore オーバーライドされます。 現在のサイト マップ データ構造の最上位ノードを取得します。
プロテクト メソッド GetRootNodeCoreFromProvider  指定したサイト マップ プロバイダによって現在管理されている全ノードのルート ノードを取得します。 (SiteMapProvider から継承されます。)
プロテクト メソッド MemberwiseClone  現在の Object の簡易コピーを作成します。 (Object から継承されます。)
プロテクト メソッド RemoveNode オーバーライドされます。 指定した SiteMapNode オブジェクトを、プロバイダによる追跡対象のすべてのノード コレクションから削除します。
プロテクト メソッド RemoveProvider 現在のプロバイダの階層から、リンクされている子サイト マップ プロバイダを削除します。
プロテクト メソッド ResolveSiteMapNode  SiteMapResolve イベントを発生させます。 (SiteMapProvider から継承されます。)
パブリック イベントパブリック イベント
  名前 説明
パブリック イベント SiteMapResolve  CurrentNode プロパティが呼び出されると発生します。 (SiteMapProvider から継承されます。)
参照参照



英和和英テキスト翻訳

英語⇒日本語日本語⇒英語

辞書ショートカット

すべての辞書の索引

「XmlSiteMapProvider」の関連用語

XmlSiteMapProviderのお隣キーワード
検索ランキング

   

英語⇒日本語
日本語⇒英語
   



XmlSiteMapProviderのページの著作権

   
日本マイクロソフト株式会社日本マイクロソフト株式会社
© 2026 Microsoft.All rights reserved.

©2026 GRAS Group, Inc.RSS