SiteMapProvider.FindSiteMapNodeFromKey(String) メソッド

定義

指定したキーに基づいて 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。それ以外の場合は、対応するnullが見つからない場合、またはセキュリティ トリミングが有効になっていて、現在のユーザーに対してSiteMapNodeを返すことができない場合はSiteMapNode。 既定値は null です。

注釈

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

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

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

適用対象

こちらもご覧ください