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

定義

名前空間:

System.Web

アセンブリ:

System.Web.dll

サイト マップ プロバイダーがオーバーライドして、指定したノードの近くで見つかったノードの最適化された取得を実行できるメソッドを提供します。

public:
 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)

パラメーター

node

SiteMapNode

upLevel の参照ポイントとして動作する SiteMapNode。

upLevel

Int32

フェッチする先祖 SiteMapNode 世代の数。 0 は、先祖ノードが取得されないことを示します。-1 は、すべての先祖 (およびその node レベル下までの子孫ノード) が取得され、キャッシュされることを示します。

downLevel

Int32

フェッチする子孫 SiteMapNode 世代の数。 0 は、子孫ノードが取得されないことを示します。-1 は、すべての子孫ノードが取得され、キャッシュされることを示します。

例外

ArgumentOutOfRangeException

upLevel または downLevel が -1 未満です。

ArgumentNullException

node が nullです。

注釈

既定HintNeighborhoodNodesのメソッドでは、-1 node 未満の パラメーターとdownLevel、 パラメーターのみがチェックupLevelされますnull。 オブジェクトは XmlSiteMapProvider サイト マップ情報をメモリにキャッシュするため、 HintNeighborhoodNodes メソッドは使用されません。

サイト マップ プロバイダーは、 メソッドをHintNeighborhoodNodesオーバーライドして、指定した SiteMapNodeの近接でオブジェクトの最適化された検索SiteMapNodeを実行できます。 パラメーターは upLevel 、指定した から走査する親ノードと先祖ノードのレベルの数を指定するために使用されます SiteMapNode。 パラメーターは downLevel 、現在のノードから取得する子ノードのレベルの数を指定するために使用されます。 必要に応じて、 プロパティと プロパティをSiteMapNode使用して、 メソッドによってHintNeighborhoodNodes返される に先祖ノードとChildNodes子孫ノードをParentNodeリンクできます。

こちらもご覧ください

• HintAncestorNodes(SiteMapNode, Int32)