XmlSiteMapProvider.FindSiteMapNodeFromKey(String) XmlSiteMapProvider.FindSiteMapNodeFromKey(String) XmlSiteMapProvider.FindSiteMapNodeFromKey(String) XmlSiteMapProvider.FindSiteMapNodeFromKey(String) Method

定義

指定したキーに基づいて SiteMapNode オブジェクトを取得します。Retrieves a SiteMapNode object based on a specified key.

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 String String String

SiteMapNode の検索に使用する検索キー。A lookup key with which to search for a SiteMapNode.

戻り値

key で示されるページを表す SiteMapNode。セキュリティ トリミングが有効で、ノードを現在のユーザーに表示できない場合、または key に対応するノードがノード コレクションで見つからなかった場合は nullA SiteMapNode that represents the page identified by key; otherwise, null, if security trimming is enabled and the node cannot be shown to the current user or the node is not found by key in the node collection.

例外

現在のサイト マップ プロバイダーにリンクされている子プロバイダーが、有効でないノードを返しました。A child provider linked to the current site map provider returned a node that is not valid.

注釈

クラスXmlSiteMapProviderは、 FindSiteMapNodeFromKeyメソッドをオーバーライドして、基底クラスの実装がのkeyノードを返さない場合に、リンクされた子プロバイダーが確実にノードを検索するようにします。The XmlSiteMapProvider class overrides the FindSiteMapNodeFromKey method to ensure that any linked child providers are searched for the node, if the implementation for the base class does not return a node for key.

クラスから派生し、ASP.NET XmlSiteMapProvider Urlの既定のサイトマッププロバイダーであるオブジェクトは、既定で、 SiteMapNodeオブジェクトのプロパティを内部コレクション内の参照キーとして使用します。 StaticSiteMapProviderThe XmlSiteMapProvider object, derived from the StaticSiteMapProvider class and the default site map provider for ASP.NET, uses the Url property of a SiteMapNode object as a lookup key in its internal collections, by default. Url のプロパティが設定されている場合は、プロバイダーのスコープ内で一意である必要SiteMapNodeがあります。If the Url property of the SiteMapNode is set, it must be unique within the scope of the provider. が指定UrlXmlSiteMapProviderれていない場合、 Keyは、ノードを追跡するを自動的に生成します。If no Url is specified, the XmlSiteMapProvider automatically generates a Key to track the nodes.

メソッドFindSiteMapNodeFromKeyは、現在のBuildSiteMapプロバイダーに関連付けられているすべての子プロバイダーでメソッドを呼び出す場合があります。The FindSiteMapNodeFromKey method might call the BuildSiteMap method on any child providers that are associated with the current provider. そのため、 BuildSiteMapメソッドに記述されている例外がスローされる可能性があります。Therefore, the exceptions that are described in the BuildSiteMap method might be thrown.

適用対象

こちらもご覧ください