SiteMapProvider.FindSiteMapNodeFromKey(String) メソッド

定義

名前空間:

System.Web

アセンブリ:

System.Web.dll

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

public:
 virtual System::Web::SiteMapNode ^ FindSiteMapNodeFromKey(System::String ^ key);

public virtual System.Web.SiteMapNode FindSiteMapNodeFromKey (string key);

abstract member FindSiteMapNodeFromKey : string -> System.Web.SiteMapNode
override this.FindSiteMapNodeFromKey : string -> System.Web.SiteMapNode

Public Overridable Function FindSiteMapNodeFromKey (key As String) As SiteMapNode

パラメーター

key

String

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

戻り値

SiteMapNode

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

注釈

実装はすべての SiteMapProvider ケースで返されます null 。 クラスから SiteMapProvider 派生したクラスは、メソッドを FindSiteMapNodeFromKey オーバーライドして、(メソッドで使用される URL ではなく) 一意のキーに基づいてルックアップ機能を FindSiteMapNode 提供できます。 サイト マップ プロバイダーの FindSiteMapNodeFromKey 実装で、オブジェクトのプロパティが SiteMapNode.Key サイト マップ構造の SiteMapNode プライマリ識別子として使用される場合は、このメソッドを実装します。

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

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

こちらもご覧ください

• FindSiteMapNode