SiteMapProvider.HintAncestorNodes(SiteMapNode, Int32) メソッド

定義

サイト マップ プロバイダーがオーバーライドして、指定した SiteMapNode オブジェクトの相対として 1 つ以上のレベルの親ノードと先祖ノードの最適化された取得を実行できるメソッドを提供します。Provides a method that site map providers can override to perform an optimized retrieval of one or more levels of parent and ancestor nodes, relative to the specified SiteMapNode object.

public:
 virtual void HintAncestorNodes(System::Web::SiteMapNode ^ node, int upLevel);
public virtual void HintAncestorNodes (System.Web.SiteMapNode node, int upLevel);
abstract member HintAncestorNodes : System.Web.SiteMapNode * int -> unit
override this.HintAncestorNodes : System.Web.SiteMapNode * int -> unit
Public Overridable Sub HintAncestorNodes (node As SiteMapNode, upLevel As Integer)

パラメーター

node
SiteMapNode

upLevel の参照ポイントとして動作する SiteMapNodeThe SiteMapNode that acts as a reference point for upLevel.

upLevel
Int32

フェッチする先祖 SiteMapNode 世代の数。The number of ancestor SiteMapNode generations to fetch. 0 は、先祖ノードが取得されないことを示します。-1 は、すべての先祖が取得され、キャッシュされることを示します。0 indicates no ancestor nodes are retrieved and -1 indicates that all ancestors might be retrieved and cached.

例外

upLevel が -1 未満です。upLevel is less than -1.

nodenull です。node is null.

注釈

既定の HintAncestorNodes メソッドは、-1 未満の upLevel パラメーターと nullnode パラメーターのみをチェックします。The default HintAncestorNodes method only checks for an upLevel parameter that is less than -1 and a node parameter that is null. XmlSiteMapProvider クラスは、サイトマップ情報をメモリにキャッシュするため、HintAncestorNodes メソッドは使用されません。Because the XmlSiteMapProvider class caches site map information in memory, the HintAncestorNodes method is not used.

サイトマッププロバイダーは、HintAncestorNodes メソッドをオーバーライドして、指定した SiteMapNode オブジェクトの親ノードと先祖ノードの最適化された取得を実行できます。Site map providers can override the HintAncestorNodes method to perform an optimized retrieval of parent and ancestor nodes of the specified SiteMapNode object.

upLevel パラメーターを使用して、指定した SiteMapNodeから走査する親ノードと先祖ノードのレベル数を指定します。The upLevel parameter is used to specify how many levels of parent and ancestor nodes to traverse from the specified SiteMapNode. 要求された数よりも低いレベルが存在する場合、使用可能なすべての祖先ノードが、指定されたバインド内で返されます。If fewer levels exist than are requested, all available ancestor nodes are returned within the specified bound. 優先する場合は、ParentNode プロパティを使用して、指定した SiteMapNode に親ノードをリンクできます。If preferred, the parent node can be linked to the specified SiteMapNode using the ParentNode property.

適用対象

こちらもご覧ください