StaticSiteMapProvider.FindSiteMapNodeFromKey(String) メソッド

定義

名前空間:
System.Web
アセンブリ:
System.Web.dll

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

public:
 override System::Web::SiteMapNode ^ FindSiteMapNodeFromKey(System::String ^ key);
public override System.Web.SiteMapNode FindSiteMapNodeFromKey(string key);
override this.FindSiteMapNodeFromKey : string -> System.Web.SiteMapNode
Public Overrides Function FindSiteMapNodeFromKey (key As String) As SiteMapNode

パラメーター

key
String

SiteMapNodeが作成されるルックアップ キー。

返品

SiteMapNode

SiteMapNodeによって識別されるページを表すkey。セキュリティ トリミングが有効で、サイト マップ ノードを現在のユーザーに表示できない場合、またはサイト マップ ノード がサイト マップ ノード コレクションにnullによって見つからない場合は、key。

注釈

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

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

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

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

適用対象

こちらもご覧ください