SiteMapProvider.HintNeighborhoodNodes メソッド

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

SiteMapProvider.HintNeighborhoodNodes メソッド

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

サイト マップ プロバイダがオーバーライドして、指定したノードの近くで見つかったノードの最適化された取得を実行できるメソッドを提供します。

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

Visual Basic (宣言)

Public Overridable Sub HintNeighborhoodNodes
 ( _
    node As SiteMapNode, _
    upLevel As Integer, _
    downLevel As Integer _
)

Visual Basic (使用法)

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

instance.HintNeighborhoodNodes(node, upLevel, downLevel)

C#

public virtual void HintNeighborhoodNodes (
    SiteMapNode node,
    int upLevel,
    int downLevel
)

C++

public:
virtual void HintNeighborhoodNodes (
    SiteMapNode^ node, 
    int upLevel, 
    int downLevel
)

J#

public void HintNeighborhoodNodes (
    SiteMapNode node, 
    int upLevel, 
    int downLevel
)

JScript

public function HintNeighborhoodNodes (
    node : SiteMapNode, 
    upLevel : int, 
    downLevel : int
)

パラメータ

node

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

upLevel

フェッチする先祖 SiteMapNode 世代の数。0 は、先祖ノードが取得されないことを示します。-1 は、すべての先祖 (およびその node レベル下までの子孫ノード) が取得され、キャッシュされることを示します。

downLevel

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

例外

例外の種類	条件
ArgumentOutOfRangeException	upLevel または downLevel が -1 未満です。
ArgumentNullException	node が null 参照 (Visual Basic では Nothing) です。

解説

既定の HintNeighborhoodNodes メソッドがチェックするのは、upLevel パラメータと downLevel パラメータが -1 未満かどうか、および node パラメータが null 参照 (Visual Basic では Nothing) かどうかだけです。XmlSiteMapProvider オブジェクトはサイト マップ情報をメモリに格納するので、HintNeighborhoodNodes メソッドは使用されません。

サイト マップ プロバイダは、HintNeighborhoodNodes メソッドをオーバーライドして、指定した SiteMapNode の近くの SiteMapNode オブジェクトの最適化された取得を実行できます。upLevel パラメータを使用して、指定した SiteMapNode で親ノードと先祖ノードを走査するレベル数を指定します。downLevel パラメータを使用して、現在のノードから何レベル下までの子ノードを取得するかを指定します。必要に応じて、ParentNode プロパティと ChildNodes プロパティを使用して、先祖ノードと子孫ノードを、HintNeighborhoodNodes メソッドによって返される 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 名前空間
HintAncestorNodes