SiteMapProvider.GetCurrentNodeAndHintAncestorNodes(Int32) SiteMapProvider.GetCurrentNodeAndHintAncestorNodes(Int32) SiteMapProvider.GetCurrentNodeAndHintAncestorNodes(Int32) SiteMapProvider.GetCurrentNodeAndHintAncestorNodes(Int32) Method

定義

現在要求されているページのノードを取得し、現在のページの親および先祖のサイト マップ ノードをフェッチする際、サイト マップ プロバイダーに最適化された検索メソッドを提供します。Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the parent and ancestor site map nodes for the current page.

public:
 virtual System::Web::SiteMapNode ^ GetCurrentNodeAndHintAncestorNodes(int upLevel);
public virtual System.Web.SiteMapNode GetCurrentNodeAndHintAncestorNodes (int upLevel);
abstract member GetCurrentNodeAndHintAncestorNodes : int -> System.Web.SiteMapNode
override this.GetCurrentNodeAndHintAncestorNodes : int -> System.Web.SiteMapNode
Public Overridable Function GetCurrentNodeAndHintAncestorNodes (upLevel As Integer) As SiteMapNode

パラメーター

upLevel
Int32 Int32 Int32 Int32

取得する先祖のサイト マップ ノードの世代数。The number of ancestor site map node generations to get. 値 -1 は、プロバイダーによってすべての先祖が取得され、キャッシュされることを示します。A value of -1 indicates that all ancestors might be retrieved and cached by the provider.

戻り値

現在要求されているページを表す SiteMapNodeSiteMapNode が見つからなかった場合、または見つかったが現在のユーザーに返すことができない場合は nullA SiteMapNode that represents the currently requested page; otherwise, null, if the SiteMapNode is not found or cannot be returned for the current user.

例外

注釈

GetCurrentNodeAndHintAncestorNodesメソッドの既定の実装はCurrentNodeプロパティを返しますが、サイトGetCurrentNodeAndHintAncestorNodesマッププロバイダーはメソッドをオーバーライドし、カスタムキャッシュ機構を使用して現在のを返すように最適化された実装を提供できます。SiteMapNode、親の親ノードと先祖ノードを含めます。The default implementation of the GetCurrentNodeAndHintAncestorNodes method returns the CurrentNode property; however, site map providers can override the GetCurrentNodeAndHintAncestorNodes method and provide an optimized implementation that uses custom caching mechanisms to return the current SiteMapNode, as well as the parent and ancestor nodes of the parent.

パラメーター upLevelは、取得する親ノードと先祖ノードのレベル数を指定するために使用されます。The upLevel parameter is used to specify how many levels of parent and ancestor nodes to retrieve. 優先する場合は、 SiteMapNode ParentNodeプロパティを使用して、親ノードと先祖ノードをGetCurrentNodeAndHintAncestorNodesメソッドによって返されるオブジェクトにリンクできます。If preferred, the parent and ancestor nodes can be linked to the SiteMapNode object that is returned by the GetCurrentNodeAndHintAncestorNodes method, using the ParentNode property.

ASP.NET の既定のサイトマッププロバイダーであるXmlSiteMapProvider SiteMapNode クラスは、サイトマップ全体をメモリ内にキャッシュします。これにより、特定のオブジェクトのに対してクエリを実行した場合、オーバーヘッドがほとんど発生XmlSiteMapProviderしません。The XmlSiteMapProvider class, which is the default site map provider for ASP.NET, caches the entire site map in memory, which results in little or no overhead when querying the XmlSiteMapProvider for specific SiteMapNode objects.

適用対象

こちらもご覧ください