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

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

注釈

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

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

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

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

こちらもご覧ください

• FindSiteMapNode