SiteMapProvider.HintAncestorNodes メソッド

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

SiteMapProvider.HintAncestorNodes メソッド

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

サイト マップ プロバイダがオーバーライドして、指定した SiteMapNode オブジェクトの相対として 1 つ以上のレベルの親ノードと先祖ノードの最適化された取得を実行できるメソッドを提供します。

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

Visual Basic (宣言)

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

Visual Basic (使用法)

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

instance.HintAncestorNodes(node, upLevel)

C#

public virtual void HintAncestorNodes (
    SiteMapNode node,
    int upLevel
)

C++

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

J#

public void HintAncestorNodes (
    SiteMapNode node, 
    int upLevel
)

JScript

public function HintAncestorNodes (
    node : SiteMapNode, 
    upLevel : int
)

パラメータ

node

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

upLevel

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

例外

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

解説

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

サイト マップ プロバイダは、HintAncestorNodes メソッドをオーバーライドして、指定した SiteMapNode オブジェクトの親ノードと先祖ノードの最適化された取得を実行できます。

upLevel パラメータを使用して、指定した SiteMapNode で親ノードと先祖ノードを走査するレベル数を指定します。要求よりレベル数が少ない場合は、使用可能なすべての先祖ノードが指定したバインドと共に返されます。必要に応じて、ParentNode プロパティを使用して、指定した 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 名前空間
HintNeighborhoodNodes