XmlSiteMapProvider クラスとは何？わかりやすく解説 Weblio辞書

索引トップ用語の索引ランキング

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

public class XmlSiteMapProvider : StaticSiteMapProvider,
 IDisposable

C++

public ref class XmlSiteMapProvider : public
 StaticSiteMapProvider, IDisposable

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