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

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

walkupLevels
Int32

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

relativeDepthFromWalkup
Int32

ターゲットの先祖ノードから取得する子孫ノード レベルの数。

返品

SiteMapNode

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

例外

ArgumentOutOfRangeException

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

ArgumentNullException

node は nullです。

注釈

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

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

適用対象

こちらもご覧ください