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

例外

ProviderException

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

注釈

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

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

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

適用対象

こちらもご覧ください