XmlSiteMapProvider クラス

定義

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 を指定しないノードの場合、すべてのキーは一意である必要があります)。

次のコード例は、 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の代わりに使用されます。

<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>

こちらもご覧ください

• SiteMapProvider
• StaticSiteMapProvider
• ASP.NET サイト ナビゲーションの概要
• ASP.NET サイト マップ
• ASP.NET サイト ナビゲーション プロバイダー
• 方法: 簡単なサイト ナビゲーションを追加する
• ASP.NET サイト ナビゲーションのセキュリティ保護