XmlSiteMapProvider.Initialize メソッドとは何？わかりやすく解説 Weblio辞書

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

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

XmlSiteMapProvider.Initialize メソッド

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

XmlSiteMapProvider オブジェクトを初期化します。Initialize メソッドは、実際のサイトマップ構築は行わず、構築するための XmlSiteMapProvider の状態を準備するだけです。

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

Visual Basic (宣言)

Public Overrides Sub Initialize
 ( _
    name As String, _
    attributes As NameValueCollection _
)

Visual Basic (使用法)

Dim instance As XmlSiteMapProvider
Dim name As String
Dim attributes As NameValueCollection

instance.Initialize(name, attributes)

public override void Initialize (
    string name,
    NameValueCollection attributes
)

C++

public:
virtual void Initialize (
    String^ name, 
    NameValueCollection^ attributes
) override

public void Initialize (
    String name, 
    NameValueCollection attributes
)

JScript

public override function Initialize (
    name : String, 
    attributes : NameValueCollection
)

パラメータ

name: 初期化する XmlSiteMapProvider。

attributes: name の初期化を支援する追加属性を含む NameValueCollection。これらの属性は、Web.config ファイルの XmlSiteMapProvider 構成から読み取られます。

例外

例外の種類	条件
InvalidOperationException	XmlSiteMapProvider が何度も初期化されています。
HttpException	SiteMapNode が、サイトマップファイルの参照時に物理パスを使用しました。または siteMapFile 属性で示された仮想パスの解析試行時にエラーが発生しました。

例外の種類

条件

InvalidOperationException

XmlSiteMapProvider が何度も初期化されています。

HttpException

SiteMapNode が、サイトマップファイルの参照時に物理パスを使用しました。

または

siteMapFile 属性で示された仮想パスの解析試行時にエラーが発生しました。

解説

XmlSiteMapProvider クラスは、継承された Initialize メソッドをオーバーライドすることにより、siteMapFile 属性や description 属性など、複数の属性を attributes コレクションに適用します。

使用例

XmlSiteMapProvider クラスの新しいインスタンスを作成し、このクラスを初期化して XML データからサイトマップを構築する方法を次のコード例に示します。

<%@ Page Language="c#" %>
<SCRIPT runat="server">
 private void Page_Load(object sender, System.EventArgs
 e) {
     // Create an instance of the XmlSiteMapProvider class.
     XmlSiteMapProvider testXmlProvider = new XmlSiteMapProvider();
     NameValueCollection providerAttributes = new NameValueCollection(1);
     providerAttributes.Add("siteMapFile","test.sitemap");
 
     // Initialize the provider with a provider name and file name.
     testXmlProvider.Initialize("testProvider", providerAttributes);

     // Call the BuildSiteMap to load the site map information into
 memory.
     testXmlProvider.BuildSiteMap();

     // Prints "/myvirtualdirectory/WebForm1.aspx"
     Response.Write(testXmlProvider.RootNode.Url + "<BR>");

     // Prints "/myvirtualdirectory/WebForm2.aspx"
     Response.Write(testXmlProvider.CurrentNode.Url + "<BR>");
 }
 </SCRIPT>

上記のコード例では、ASP.NET アプリケーションの仮想ルートに配置されている XML ファイルを使用しています。ファイルの形式は次のようになります。

<siteMap>
  <siteMapNode title="RootNode" description="The root page." url="WebForm1.aspx">
    <siteMapNode title="CurrentNode" description="Some sub page." url="WebForm2.aspx"/>
  </siteMapNode>
</siteMap>

プラットフォーム

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