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

定義

名前空間:

System.Web

アセンブリ:

System.Web.dll

サイト マップ プロバイダーがオーバーライドして、指定した SiteMapNode オブジェクトの相対として 1 つ以上のレベルの親ノードと先祖ノードの最適化された取得を実行できるメソッドを提供します。

public:
 virtual void HintAncestorNodes(System::Web::SiteMapNode ^ node, int upLevel);

public virtual void HintAncestorNodes (System.Web.SiteMapNode node, int upLevel);

abstract member HintAncestorNodes : System.Web.SiteMapNode * int -> unit
override this.HintAncestorNodes : System.Web.SiteMapNode * int -> unit

Public Overridable Sub HintAncestorNodes (node As SiteMapNode, upLevel As Integer)

パラメーター

node

SiteMapNode

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

upLevel

Int32

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

例外

ArgumentOutOfRangeException

upLevel が -1 未満です。

ArgumentNullException

node が nullです。

注釈

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

サイト マップ プロバイダーは、メソッドを HintAncestorNodes オーバーライドして、指定した SiteMapNode オブジェクトの親ノードと先祖ノードの最適化された取得を実行できます。

この upLevel パラメーターは、指定したノードから走査する親ノードと先祖ノードのレベルの数を指定するために使用されます SiteMapNode。 要求されたレベルより少ないレベルが存在する場合、使用可能なすべての先祖ノードが指定されたバインド内で返されます。 必要に応じて、プロパティを使用して、親ノードを指定した SiteMapNode ノードに ParentNode リンクできます。

こちらもご覧ください

• HintNeighborhoodNodes(SiteMapNode, Int32, Int32)