SiteMapProvider.FindSiteMapNodeFromKey メソッド

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

SiteMapProvider.FindSiteMapNodeFromKey メソッド

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

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

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As SiteMapProvider
Dim key As String
Dim returnValue As SiteMapNode

returnValue = instance.FindSiteMapNodeFromKey(key)

C#

public virtual SiteMapNode FindSiteMapNodeFromKey (
    string key
)

C++

public:
virtual SiteMapNode^ FindSiteMapNodeFromKey (
    String^ key
)

J#

public SiteMapNode FindSiteMapNodeFromKey (
    String key
)

JScript

public function FindSiteMapNodeFromKey (
    key : String
) : SiteMapNode

パラメータ

key

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

戻り値
key で示されるページを表す SiteMapNode。対応する SiteMapNode が見つからなかった場合、またはセキュリティ トリミングが有効で、SiteMapNode を現在のユーザーに返すことができない場合は、null 参照 (Visual Basic では Nothing)。既定値は null 参照 (Visual Basic では Nothing) です。

解説

SiteMapProvider 実装は、どのような場合でも null 参照 (Visual Basic では Nothing) を返します。SiteMapProvider クラスの派生クラスは、FindSiteMapNodeFromKey メソッドをオーバーライドして、固有キー (URL の代わりに FindSiteMapNode メソッドで使用) に基づいた検索機能を実現できます。サイト マップ プロバイダの実装で SiteMapNode オブジェクトの SiteMapNode.Key プロパティをサイト マップ構造のプライマリ ID として使用する場合は、FindSiteMapNodeFromKey メソッドを実装します。

StaticSiteMapProvider クラスは、URL を定義しないサイト マップ ノードの検索を処理する実装を提供します。

XmlSiteMapProvider クラスは、ASP.NET の既定のサイト マップ プロバイダです。このクラスでは、クラスが管理するさまざまなコレクションで、SiteMapNode の URL がキーとして使用されます。このため、ノードに URL を指定する場合、その URL はサイト マップ プロバイダのスコープ内で一意であることが必要です。URL の指定がない場合、SiteMapNode を識別するための一意の識別子が生成されます。

プラットフォーム

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

参照

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