SiteMapProvider.HintNeighborhoodNodes(SiteMapNode, Int32, Int32) メソッド


サイト マップ プロバイダーがオーバーライドして、指定したノードの近くで見つかったノードの最適化された取得を実行できるメソッドを提供します。Provides a method that site map providers can override to perform an optimized retrieval of nodes found in the proximity of the specified node.

 virtual void HintNeighborhoodNodes(System::Web::SiteMapNode ^ node, int upLevel, int downLevel);
public virtual void HintNeighborhoodNodes (System.Web.SiteMapNode node, int upLevel, int downLevel);
abstract member HintNeighborhoodNodes : System.Web.SiteMapNode * int * int -> unit
override this.HintNeighborhoodNodes : System.Web.SiteMapNode * int * int -> unit
Public Overridable Sub HintNeighborhoodNodes (node As SiteMapNode, upLevel As Integer, downLevel As Integer)



upLevel の参照ポイントとして動作する SiteMapNodeThe SiteMapNode that acts as a reference point for upLevel.


フェッチする先祖 SiteMapNode 世代の数。The number of ancestor SiteMapNode generations to fetch. 0 は、先祖ノードが取得されないことを示します。-1 は、すべての先祖 (およびその node レベル下までの子孫ノード) が取得され、キャッシュされることを示します。0 indicates no ancestor nodes are retrieved and -1 indicates that all ancestors (and their descendant nodes to the level of node) might be retrieved and cached.


フェッチする子孫 SiteMapNode 世代の数。The number of descendant SiteMapNode generations to fetch. 0 は、子孫ノードが取得されないことを示します。-1 は、すべての子孫ノードが取得され、キャッシュされることを示します。0 indicates no descendant nodes are retrieved and -1 indicates that all descendant nodes might be retrieved and cached.


upLevel または downLevel が -1 未満です。upLevel or downLevel is less than -1.

nodenull です。node is null.


既定の HintNeighborhoodNodes メソッドは、downLevel upLevel だけでなく、-1 未満のパラメーターと、nullnode パラメーターのみをチェックします。The default HintNeighborhoodNodes method only checks for an upLevel and downLevel parameters that are less than -1 and a node parameter that is null. XmlSiteMapProvider オブジェクトはメモリにサイトマップ情報をキャッシュするため、HintNeighborhoodNodes メソッドは使用されません。Because the XmlSiteMapProvider object caches site map information in memory, the HintNeighborhoodNodes method is not used.

サイトマッププロバイダーは、HintNeighborhoodNodes メソッドをオーバーライドして、指定した SiteMapNodeの近接部分に SiteMapNode オブジェクトの最適化された検索を実行できます。Site map providers can override the HintNeighborhoodNodes method to perform an optimized lookup of the SiteMapNode objects in the proximity of the specified SiteMapNode. upLevel パラメーターを使用して、指定した SiteMapNodeから走査する親ノードと先祖ノードのレベル数を指定します。The upLevel parameter is used to specify how many levels of parent and ancestor nodes to traverse from the specified SiteMapNode. downLevel パラメーターを使用して、現在のノードから取得する子ノードのレベル数を指定します。The downLevel parameter is used to specify how many levels of child nodes from the current node to retrieve. 優先する場合、先祖ノードと子孫ノードは、ParentNode プロパティと ChildNodes プロパティを使用して、HintNeighborhoodNodes メソッドによって返される SiteMapNode にリンクできます。If preferred, the ancestor and descendant nodes can be linked to the SiteMapNode that is returned by the HintNeighborhoodNodes method, using the ParentNode and ChildNodes properties.