XmlSiteMapProvider

.NET Framework クラス ライブラリ リファレンス

XmlSiteMapProvider イベント

パブリック イベント

	名前	説明
	SiteMapResolve	CurrentNode プロパティが呼び出されると発生します。 ( SiteMapProvider から継承されます。)

参照

関連項目

XmlSiteMapProvider クラス
System.Web 名前空間
SiteMapProvider クラス
StaticSiteMapProvider クラス

その他の技術情報

ASP.NET サイト ナビゲーションの概要
ASP.NET サイト マップ
ASP.NET サイト ナビゲーション プロバイダ
方法 : 簡単なサイト ナビゲーションを追加する
ASP.NET のサイト ナビゲーションの保護

XmlSiteMapProvider クラス

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

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

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

Visual Basic (宣言)

Public Class XmlSiteMapProvider
    Inherits StaticSiteMapProvider
    Implements IDisposable

Visual Basic (使用法)

Dim instance As XmlSiteMapProvider

C#

public class XmlSiteMapProvider : StaticSiteMapProvider,
 IDisposable

C++

public ref class XmlSiteMapProvider : public
 StaticSiteMapProvider, IDisposable

J#

public class XmlSiteMapProvider extends StaticSiteMapProvider
 implements IDisposable

JScript

public class XmlSiteMapProvider extends
 StaticSiteMapProvider implements IDisposable

解説

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

• ルート ノードは 1 つだけ存在できます。

• URL を指定する SiteMapNode では、その URL がプロバイダのスコープ内で一意である必要があります。URL を指定しないノードでは、すべてのキーが一意である必要があります。

次のコード例は、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>

Topic	Location
方法 : ASP.NET のサイト マップ プロバイダを実装する	ASP .NET Web アプリケーションの作成
方法 : SiteMapDataSource Web サーバー コントロールによって取得されたノードをフィルタ処理する	ASP .NET Web アプリケーションの作成
方法 : サイトマップ ノードをコードによって列挙する	ASP .NET Web アプリケーションの作成
方法 : 簡単なサイト ナビゲーションを追加する	ASP .NET Web アプリケーションの作成
方法 : 複数のサイト マップとサイトマップ プロバイダを設定する	ASP .NET Web アプリケーションの作成
方法 : 非階層 Web Server コントロール内にサイト マップ データを表示する	ASP .NET Web アプリケーションの作成

.NET Framework のセキュリティ

• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.Configuration.Provider.ProviderBase
     System.Web.SiteMapProvider
       System.Web.StaticSiteMapProvider
        System.Web.XmlSiteMapProvider

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
XmlSiteMapProvider メンバ
System.Web 名前空間
SiteMapProvider クラス
StaticSiteMapProvider クラス
その他の技術情報
ASP.NET サイト ナビゲーションの概要
ASP.NET サイト マップ
ASP.NET サイト ナビゲーション プロバイダ
方法 : 簡単なサイト ナビゲーションを追加する
ASP.NET のサイト ナビゲーションの保護

XmlSiteMapProvider コンストラクタ

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

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

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New XmlSiteMapProvider

C#

public XmlSiteMapProvider ()

C++

public:
XmlSiteMapProvider ()

J#

public XmlSiteMapProvider ()

JScript

public function XmlSiteMapProvider ()

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
XmlSiteMapProvider クラス
XmlSiteMapProvider メンバ
System.Web 名前空間

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 クラス
System.Web 名前空間
SiteMapProvider クラス
StaticSiteMapProvider クラス

その他の技術情報

ASP.NET サイト ナビゲーションの概要
ASP.NET サイト マップ
ASP.NET サイト ナビゲーション プロバイダ
方法 : 簡単なサイト ナビゲーションを追加する
ASP.NET のサイト ナビゲーションの保護

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 クラス
System.Web 名前空間
SiteMapProvider クラス
StaticSiteMapProvider クラス

その他の技術情報

ASP.NET サイト ナビゲーションの概要
ASP.NET サイト マップ
ASP.NET サイト ナビゲーション プロバイダ
方法 : 簡単なサイト ナビゲーションを追加する
ASP.NET のサイト ナビゲーションの保護

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 クラス
System.Web 名前空間
SiteMapProvider クラス
StaticSiteMapProvider クラス

その他の技術情報

ASP.NET サイト ナビゲーションの概要
ASP.NET サイト マップ
ASP.NET サイト ナビゲーション プロバイダ
方法 : 簡単なサイト ナビゲーションを追加する
ASP.NET のサイト ナビゲーションの保護