StaticSiteMapProvider.FindSiteMapNodeFromKey メソッド

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

StaticSiteMapProvider.FindSiteMapNodeFromKey メソッド

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

指定したキーに基づいて SiteMapNode オブジェクトを取得します。

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

Visual Basic (宣言)

Public Overrides Function
 FindSiteMapNodeFromKey ( _
    key As String _
) As SiteMapNode

Visual Basic (使用法)

Dim instance As StaticSiteMapProvider
Dim key As String
Dim returnValue As SiteMapNode

returnValue = instance.FindSiteMapNodeFromKey(key)

C#

public override SiteMapNode FindSiteMapNodeFromKey (
    string key
)

C++

public:
virtual SiteMapNode^ FindSiteMapNodeFromKey (
    String^ key
) override

J#

public SiteMapNode FindSiteMapNodeFromKey (
    String key
)

JScript

public override function FindSiteMapNodeFromKey
 (
    key : String
) : SiteMapNode

パラメータ

key

SiteMapNode の作成に使用するルックアップ キー。

戻り値
key で示されるページを表す SiteMapNode。セキュリティ トリミングが有効で、サイト マップ ノードを現在のユーザーに表示できない場合、または key に対応するサイト マップ ノードがサイト マップ コレクション ノードに見つからなかった場合は null 参照 (Visual Basic では Nothing)。

解説

FindSiteMapNodeFromKey メソッドは、key に基づいてサイト マップ ノードを内部 Hashtable オブジェクトから取得します。

StaticSiteMapProvider クラスから派生し、ASP.NET の既定のサイト マップ プロバイダである XmlSiteMapProvider オブジェクトは、既定で、SiteMapNode の Url プロパティを内部コレクションのルックアップ キーとして使用します。SiteMapNode の Url プロパティを設定する場合、サイト マップ プロバイダのスコープ内で一意であることが必要です。FindSiteMapNode メソッドは、該当する Url に基づいてサイト マップ ノードの取得を試みます。それ以外の場合は、Key プロパティおよび対応する FindSiteMapNodeFromKey メソッドを使用してノードを取得できます。

StaticSiteMapProvider には、key パラメータに基づいて SiteMapNode クラスのインスタンスを検索する既定の実装があります。サイト マップ プロバイダの実装側が AddNode メソッドを使用している場合、StaticSiteMapProvider は、SiteMapNode.Key プロパティの値に基づいて各 SiteMapNode への参照を格納済みです。既定で、XmlSiteMapProvider は、SiteMapNode.Url プロパティの値がない SiteMapNode クラスのインスタンスの GUID を生成します。カスタム サイト マップ プロバイダの実装側は、SiteMapNode クラスのインスタンスに SiteMapNode.Url プロパティの値がない場合に備えて、SiteMapNode.Key プロパティの一意の値を生成する独自の機構を用意する必要があります。

SiteMapProvider クラスと XmlSiteMapProvider クラスは、ASP.NET の既定のサイト マップ プロバイダ実装です。これらのクラスでは、クラスが管理するさまざまなコレクションで、SiteMapNode オブジェクトの URL がキーとして使用されます。

プラットフォーム

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

参照

関連項目
StaticSiteMapProvider クラス
StaticSiteMapProvider メンバ
System.Web 名前空間
FindSiteMapNode