SiteMapProvider.GetParentNodeRelativeToNodeAndHintDownFromParent メソッド

定義

名前空間:

System.Web

アセンブリ:

System.Web.dll

指定した SiteMapNode オブジェクトの先祖ノードを取得して、その子ノードをフェッチする際に、サイト マップ プロバイダーに最適化された検索メソッドを提供します。

public:
 virtual System::Web::SiteMapNode ^ GetParentNodeRelativeToNodeAndHintDownFromParent(System::Web::SiteMapNode ^ node, int walkupLevels, int relativeDepthFromWalkup);

public virtual System.Web.SiteMapNode GetParentNodeRelativeToNodeAndHintDownFromParent (System.Web.SiteMapNode node, int walkupLevels, int relativeDepthFromWalkup);

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

Public Overridable Function GetParentNodeRelativeToNodeAndHintDownFromParent (node As SiteMapNode, walkupLevels As Integer, relativeDepthFromWalkup As Integer) As SiteMapNode

パラメーター

node

SiteMapNode

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

walkupLevels

Int32

要求された先祖ノードを取得する際に走査する先祖ノードのレベル数。

relativeDepthFromWalkup

Int32

目的の先祖ノードから取得する子孫ノードのレベル数。

戻り値

SiteMapNode

node の先祖を表す SiteMapNode。現在または先祖の SiteMapNode が見つからなかった場合、または見つかったが現在のユーザーに返すことができない場合は null。

例外

ArgumentOutOfRangeException

walkupLevels または relativeDepthFromWalkup に指定された値が 0 未満です。

ArgumentNullException

node が nullです。

注釈

クラスの既定のSiteMapProvider実装では、 メソッドと HintNeighborhoodNodes メソッドを呼び出してHintAncestorNodes、 メソッドのGetParentNodeRelativeToNodeAndHintDownFromParent最適化されていない実装を提供します。ただし、サイト マップ プロバイダーは メソッドをGetParentNodeRelativeToNodeAndHintDownFromParentオーバーライドし、カスタム キャッシュ メカニズムを使用して先祖ノードを返し、他SiteMapNodeのオブジェクトの最適化された検索を実行する最適化された実装を提供できます。 メソッドは GetParentNodeRelativeToNodeAndHintDownFromParent 、 メソッドとよく似ています GetParentNodeRelativeToCurrentNodeAndHintDownFromParent 。

パラメーターは walkupLevels 、ターゲット ノードを取得するときに走査する親ノードと先祖ノードのレベルの数を指定するために使用されます。 要求されたレベルより少ないレベルが存在する場合は、 null が返されます。 パラメーターは downLevel 、取得するターゲット先祖ノードの子孫ノードのレベル数を指定するために使用されます。 必要に応じて、 プロパティと プロパティをSiteMapNode使用して、 メソッドによってGetParentNodeRelativeToNodeAndHintDownFromParent返される に先祖ノードとChildNodes子孫ノードをParentNodeリンクできます。 パラメーターで指定されたよりも先祖ノード レベルが少ない場合は、 upLevelnull が返されます。 使用可能な子孫ノード レベルの数が パラメーターで downLevel 指定された値より小さい状況を処理する方法を決定するのは、プロバイダーの実装者次第です。

こちらもご覧ください

• GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)