SiteMapProvider.GetCurrentNodeAndHintAncestorNodes メソッド

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

SiteMapProvider.GetCurrentNodeAndHintAncestorNodes メソッド

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

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

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

Visual Basic (宣言)

Public Overridable Function
 GetCurrentNodeAndHintAncestorNodes ( _
    upLevel As Integer _
) As SiteMapNode

Visual Basic (使用法)

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

returnValue = instance.GetCurrentNodeAndHintAncestorNodes(upLevel)

C#

public virtual SiteMapNode GetCurrentNodeAndHintAncestorNodes
 (
    int upLevel
)

C++

public:
virtual SiteMapNode^ GetCurrentNodeAndHintAncestorNodes (
    int upLevel
)

J#

public SiteMapNode GetCurrentNodeAndHintAncestorNodes (
    int upLevel
)

JScript

public function GetCurrentNodeAndHintAncestorNodes
 (
    upLevel : int
) : SiteMapNode

パラメータ

upLevel

取得する先祖のサイト マップ ノードの世代数。値 -1 は、プロバイダによってすべての先祖が取得され、キャッシュされることを示します。

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

例外

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

解説

GetCurrentNodeAndHintAncestorNodes メソッドの既定の実装は CurrentNode プロパティを返します。ただし、サイト マップ プロバイダは GetCurrentNodeAndHintAncestorNodes メソッドをオーバーライドして、カスタム キャッシュ機構を使用する最適化された実装を提供し、現在の SiteMapNode、さらに親の親ノードと先祖ノードを返すことができます。

upLevel パラメータを使用して、取得する親と先祖のノードのレベル数を指定します。必要に応じて、ParentNode プロパティを使用して、親ノードと先祖ノードを、GetCurrentNodeAndHintAncestorNodes メソッドによって返される SiteMapNode オブジェクトにリンクできます。

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