SiteMapProvider.GetCurrentNodeAndHintNeighborhoodNodes メソッド

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

SiteMapProvider.GetCurrentNodeAndHintNeighborhoodNodes メソッド

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

現在要求されているページのノードを検索し、現在のノードの近くのサイト マップ ノードをフェッチする際に、最適化された検索メソッドをサイト マップ プロバイダに提供します。

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

Visual Basic (宣言)

Public Overridable Function
 GetCurrentNodeAndHintNeighborhoodNodes ( _
    upLevel As Integer, _
    downLevel As Integer _
) As SiteMapNode

Visual Basic (使用法)

Dim instance As SiteMapProvider
Dim upLevel As Integer
Dim downLevel As Integer
Dim returnValue As SiteMapNode

returnValue = instance.GetCurrentNodeAndHintNeighborhoodNodes(upLevel, downLevel)

C#

public virtual SiteMapNode GetCurrentNodeAndHintNeighborhoodNodes
 (
    int upLevel,
    int downLevel
)

C++

public:
virtual SiteMapNode^ GetCurrentNodeAndHintNeighborhoodNodes (
    int upLevel, 
    int downLevel
)

J#

public SiteMapNode GetCurrentNodeAndHintNeighborhoodNodes (
    int upLevel, 
    int downLevel
)

JScript

public function GetCurrentNodeAndHintNeighborhoodNodes
 (
    upLevel : int, 
    downLevel : int
) : SiteMapNode

パラメータ

upLevel

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

downLevel

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

戻り値
現在要求されているページを表す SiteMapNode。SiteMapNode が見つからなかった場合、または見つかったが現在のユーザーに返すことができない場合は null 参照 (Visual Basic では Nothing)。

例外

例外の種類	条件
ArgumentOutOfRangeException	upLevel または downLevel が -1 未満です。

解説

GetCurrentNodeAndHintNeighborhoodNodes メソッドの既定の実装は CurrentNode プロパティを返します。ただし、サイト マップ プロバイダは GetCurrentNodeAndHintNeighborhoodNodes メソッドをオーバーライドして、カスタム キャッシュ機構を使用する最適化された実装を提供し、現在の SiteMapNode オブジェクト、および現在の SiteMapNode の近くの SiteMapNode オブジェクトを返すことができます。

upLevel パラメータを使用して、取得してキャッシュする親と先祖と直下の子のノードのレベル数を指定します。downLevel パラメータを使用して、現在の SiteMapNode から何レベル下までの子孫ノードを取得するかを指定します。必要に応じて、先祖ノードと子孫ノードを、返された SiteMapNode にリンクできます。

ParentNode プロパティと ChildNodes プロパティを使用する GetCurrentNodeAndHintNeighborhoodNodes メソッド。先祖ノードまたは子ノードのレベルが upLevel または downLevel の指定より少ない場合、使用できるノードのみが取得されます。

XmlSiteMapProvider クラスは、ASP.NET の既定のサイト マップ プロバイダで、サイト マップ全体をメモリにキャッシュします。これにより、XmlSiteMapProvider に対して特定の SiteMapNode オブジェクトを照会する際のオーバーヘッドがほとんどまたはまったくなくなります。

プラットフォーム

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 名前空間
GetCurrentNodeAndHintAncestorNodes