SiteMap.Providers プロパティ

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

SiteMap.Providers プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

SiteMap クラスで使用可能な名前付き SiteMapProvider オブジェクトの読み取り専用コレクションを取得します。

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

Visual Basic (宣言)

Public Shared ReadOnly Property
 Providers As SiteMapProviderCollection

Visual Basic (使用法)

Dim value As SiteMapProviderCollection

value = SiteMap.Providers

C#

public static SiteMapProviderCollection Providers
 { get; }

C++

public:
static property SiteMapProviderCollection^ Providers {
    SiteMapProviderCollection^ get ();
}

J#

/** @property */
public static SiteMapProviderCollection get_Providers
 ()

JScript

public static function get
 Providers () : SiteMapProviderCollection

プロパティ値
名前付き SiteMapProvider オブジェクトの SiteMapProviderCollection。

例外

例外の種類	条件
InvalidOperationException	このサイト マップ機能は無効になっています。
ConfigurationErrorsException	構成に指定されている既定のプロバイダが存在しません。
HttpException	この機能は、信頼性が低以上の場合にのみサポートされます。

解説

Providers コレクションにリストされているサイト マップ プロバイダは、SiteMap クラスを初期化するために構成階層に指定されているプロバイダです。初期化中に SiteMap により使用されることが保証されるのは、既定のプロバイダ (Provider プロパティで指定) のみです。Providers コレクションにプロバイダが存在しているということは、それが構成に指定されていて、初期化中に使用可能であったことを意味します。

使用例

Providers コレクションを SiteMap クラスから取得して、それを反復処理する方法のコード例を次に示します。

Visual Basic

<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML
 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<SCRIPT runat="server">
Private Sub Page_Load(Sender As
 Object, E As EventArgs)

    ' Navigate the SiteMap built by the default SiteMapProvider.
    Response.Write(SiteMap.RootNode.ToString() & "<BR>")

    Response.Write(SiteMap.RootNode.Url & "<BR>")
    Response.Write(SiteMap.RootNode.Title & "<BR>")

    Dim sitemapnode As SiteMapNode
    For Each sitemapnode In
 SiteMap.RootNode.ChildNodes
        ' Iterate through the ChildNodes SiteMapNodesCollection
        ' maintained by the RootNode.
        Response.Write(sitemapnode.Url & "<BR>"
 )
    Next

    Dim providers As IDictionaryEnumerator
 = SiteMap.Providers.GetEnumerator()
    While (providers.MoveNext())
        Response.Write(providers.Current)
        Response.Write("&nbsp;&nbsp;&nbsp;")
        Response.Write("<BR>")
    End While
End Sub ' Page_Load

</SCRIPT>

C#

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<SCRIPT runat="server">
private void Page_Load(object sender, System.EventArgs
 e)
{
    // Navigate the SiteMap built by the default SiteMapProvider.
    Response.Write(SiteMap.RootNode.ToString() + "<BR>");

    Response.Write(SiteMap.RootNode.Url + "<BR>");
    Response.Write(SiteMap.RootNode.Title + "<BR>");

    foreach (SiteMapNode sitemapnode in SiteMap.RootNode.ChildNodes)
    {
        // Iterate through the ChildNodes SiteMapNodesCollection
        // maintained by the RootNode.
        Response.Write(sitemapnode.Url + "<BR>" );
    }

    IEnumerator providers = SiteMap.Providers.GetEnumerator();
    while (providers.MoveNext())
    {
        Response.Write(providers.Current);
        Response.Write("&nbsp;&nbsp;&nbsp;");
        Response.Write("<BR>");
    }
}
</SCRIPT>

サイトに構成されているプロバイダが既定のプロバイダだけではない場合、各プロバイダが表示されます。たとえば、サンプルの Microsoft Access プロバイダ (「StaticSiteMapProvider」を参照) を使用している場合、次の出力が表示されます。

XmlSiteMapProvider   System.Web.XmlSiteMapProvider
AccessSiteMapProvider   Samples.AspNet.AccessSiteMapProvider

プラットフォーム

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

参照

関連項目
SiteMap クラス
SiteMap メンバ
System.Web 名前空間
SiteMap.Provider プロパティ
SiteMapProvider
StaticSiteMapProvider