XmlSiteMapProvider.FindSiteMapNodeFromKey メソッド

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

XmlSiteMapProvider.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 XmlSiteMapProvider
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)。

例外

例外の種類	条件
ProviderException	現在のサイト マップ プロバイダにリンクされている子プロバイダが、有効でないノードを返しました。

解説

XmlSiteMapProvider クラスは、FindSiteMapNodeFromKey メソッドをオーバーライドすることにより、基本クラスの実装が key に対応するノードを返さない場合に、そのノードのリンクされた子プロバイダを検索できるようにします。

StaticSiteMapProvider クラスの派生クラスであり、ASP.NET の既定のサイト マップ プロバイダである XmlSiteMapProvider オブジェクトは、既定で、SiteMapNode オブジェクトの Url プロパティを内部コレクションのルックアップ キーとして使用します。SiteMapNode の Url プロパティを設定する場合は、プロバイダのスコープ内で一意であることが必要です。Url が指定されていない場合、XmlSiteMapProvider は、自動的に Key を作成してノードを追跡します。

FindSiteMapNodeFromKey メソッドは、現在のプロバイダに関連付けられている子プロバイダの BuildSiteMap メソッドを呼び出す場合があります。このため、BuildSiteMap メソッドのトピックで説明した例外がスローされる場合があります。

プラットフォーム

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

参照

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