SiteMapProvider.GetParentNodeRelativeToNodeAndHintDownFromParent メソッド

.NET Framework クラス ライブラリ リファレンス

SiteMapProvider.GetParentNodeRelativeToNodeAndHintDownFromParent メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As SiteMapProvider
Dim node As SiteMapNode
Dim walkupLevels As Integer
Dim relativeDepthFromWalkup As Integer
Dim returnValue As SiteMapNode

returnValue = instance.GetParentNodeRelativeToNodeAndHintDownFromParent(node, walkupLevels,
 relativeDepthFromWalkup)

C#

public virtual SiteMapNode GetParentNodeRelativeToNodeAndHintDownFromParent
 (
    SiteMapNode node,
    int walkupLevels,
    int relativeDepthFromWalkup
)

C++

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

J#

public SiteMapNode GetParentNodeRelativeToNodeAndHintDownFromParent
 (
    SiteMapNode node, 
    int walkupLevels, 
    int relativeDepthFromWalkup
)

JScript

public function GetParentNodeRelativeToNodeAndHintDownFromParent
 (
    node : SiteMapNode, 
    walkupLevels : int, 
    relativeDepthFromWalkup : int
) : SiteMapNode

パラメータ

node

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

walkupLevels

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

relativeDepthFromWalkup

目的の先祖ノードで検索する子孫ノードのレベル数。

戻り値
node の先祖を表す SiteMapNode。現在または先祖の SiteMapNode が見つからなかった場合、または見つかったが現在のユーザーに返すことができない場合は null 参照 (Visual Basic では Nothing)。

例外

例外の種類	条件
ArgumentOutOfRangeException	walkupLevels または relativeDepthFromWalkup に指定された値が 0 未満です。
ArgumentNullException	node が null 参照 (Visual Basic では Nothing) です。

解説

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

walkupLevels パラメータを使用して、目的のノードを取得する際に走査する親と先祖のノードのレベル数を指定します。レベル数が要求より少ない場合は、null 参照 (Visual Basic では Nothing) が返されます。downLevel パラメータを使用して、目的の先祖ノードから何レベル下までの子孫ノードを取得するかを指定します。必要に応じて、ParentNode プロパティと ChildNodes プロパティを使用して、先祖ノードと子孫ノードを、GetParentNodeRelativeToNodeAndHintDownFromParent メソッドによって返される SiteMapNode に、リンクできます。先祖ノードのレベル数が upLevel パラメータの指定より少ない場合は、null 参照 (Visual Basic では Nothing) が返されます。使用可能な子孫ノードのレベル数が downLevel パラメータの指定より少ない場合の処理は、プロバイダの実装者が決定します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SiteMapProvider クラス
SiteMapProvider メンバ
System.Web 名前空間
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent