SiteMap.RootNode プロパティ

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

SiteMap.RootNode プロパティ

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

サイトのナビゲーション構造の最上位ページを表す SiteMapNode オブジェクトを取得します。

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

Visual Basic (宣言)

Public Shared ReadOnly Property
 RootNode As SiteMapNode

Visual Basic (使用法)

Dim value As SiteMapNode

value = SiteMap.RootNode

C#

public static SiteMapNode RootNode { get;
 }

C++

public:
static property SiteMapNode^ RootNode {
    SiteMapNode^ get ();
}

J#

/** @property */
public static SiteMapNode get_RootNode ()

JScript

public static function get
 RootNode () : SiteMapNode

プロパティ値
サイト ナビゲーション構造の最上位ページを表す SiteMapNode。セキュリティ トリミングが有効でノードを現在のユーザーに返せない場合は null 参照 (Visual Basic では Nothing)。

例外

例外の種類	条件
InvalidOperationException	このサイト マップ機能は無効になっています。 または RootNode が null 参照 (Visual Basic では Nothing) に解決されました。これは、セキュリティ トリミングが有効で、ルート ノードが現在のユーザーに表示されない場合に発生します。
ConfigurationErrorsException	構成に指定されている既定のプロバイダが存在しません。
HttpException	この機能は、信頼性が低以上の場合にのみサポートされます。

解説

SiteMap クラスは、RootNode プロパティをプロバイダから要求して取得します。プロバイダ階層がある場合、SiteMap クラスは階層のルート プロバイダのルート ノードを取得します。既定のプロバイダのルート ノードにアクセスするには、Provider プロパティを呼び出します。これにより、既定のプロバイダとその RootNode プロパティの両方が取得されます。

SiteMap クラスの既定のプロバイダである XmlSiteMapProvider オブジェクトがサポートする RootNode は 1 つだけです。

独自の SiteMapProvider クラスを実装して、抽象プロパティ RootNode をオーバーライドする場合、SiteMapNode インスタンスの RootNode プロパティを追跡するために独自の実装を用意する必要があります。

ルート ノードはすべてのユーザーに表示されるよう設計する必要があります。セキュリティ トリミングが有効の状態でルート ノードが一部のユーザーに表示されない場合、RootNode プロパティにより InvalidOperationException 例外が発生します。

使用例

RootNode プロパティを使用して、ページ階層における現在の場所に関係なく、サイトのルート ノードを表す SiteMapNode オブジェクトを取得する方法のコード例を次に示します。

Visual Basic

<Script runat="server">

Private Sub Page_Load(sender As
 Object, e As EventArgs)

    ' Examine the CurrentNode, and navigate the SiteMap relative to
 it.
    Response.Write(SiteMap.CurrentNode.Title & "<BR>")
    Response.Write("<FONT COLOR='red'>" & SiteMap.CurrentNode.Url
 & "</FONT><BR>")

    ' What nodes are children of the CurrentNode?
    If (SiteMap.CurrentNode.HasChildNodes) Then
        Dim ChildNodesEnumerator As IEnumerator
 = SiteMap.CurrentNode.ChildNodes.GetEnumerator()
        While (ChildNodesEnumerator.MoveNext())
            ' Prints the Title of each node.
            Response.Write(ChildNodesEnumerator.Current.ToString() & "<BR>")
        End While
    End If
    Response.Write("<HR>")

    ' Examine the RootNode, and navigate the SiteMap relative to it.
    Response.Write(SiteMap.RootNode.Title & "<BR>")
    Response.Write(SiteMap.RootNode.Url & "<BR>")

    ' What nodes are children of the RootNode?
    If (SiteMap.RootNode.HasChildNodes) Then
        Dim RootNodesChildrenEnumerator As
 IEnumerator = SiteMap.RootNode.ChildNodes.GetEnumerator()
        While (RootNodesChildrenEnumerator.MoveNext())
            ' Prints the Title of each node.
            Response.Write(RootNodesChildrenEnumerator.Current.ToString() & "<BR>")
        End While
    End If

End Sub ' Page_Load
</Script>

C#

<Script runat="server">
private void Page_Load(object sender, System.EventArgs
 e)
{
    // Examine the CurrentNode, and navigate the SiteMap relative to
 it.
    Response.Write(SiteMap.CurrentNode.Title + "<BR>");
    Response.Write("<FONT COLOR='red'>" + SiteMap.CurrentNode.Url
 + "</FONT><BR>");

    // What nodes are children of the CurrentNode?
    if (SiteMap.CurrentNode.HasChildNodes) {
        IEnumerator childNodesEnumerator = SiteMap.CurrentNode.ChildNodes.GetEnumerator();
        while (childNodesEnumerator.MoveNext()) {
            // Prints the Title of each node.
            Response.Write(childNodesEnumerator.Current.ToString() + "<BR>");
        }
    }
    Response.Write("<HR>");

    // Examine the RootNode, and navigate the SiteMap relative to it.
    Response.Write(SiteMap.RootNode.Title + "<BR>");
    Response.Write(SiteMap.RootNode.Url + "<BR>");

    // What nodes are children of the RootNode?
    if (SiteMap.RootNode.HasChildNodes) {
        IEnumerator rootNodesChildrenEnumerator = SiteMap.RootNode.ChildNodes.GetEnumerator();
        while (rootNodesChildrenEnumerator.MoveNext()) {
            // Prints the Title of each node.
            Response.Write(rootNodesChildrenEnumerator.Current.ToString() + "<BR>");
        }
    }
}
</Script>

プラットフォーム

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.CurrentNode プロパティ