SiteMapProvider.GetCurrentNodeAndHintAncestorNodes(Int32) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
現在要求されているページのノードを取得し、現在のページの親および先祖のサイト マップ ノードをフェッチする際、サイト マップ プロバイダーに最適化された検索メソッドを提供します。
public:
virtual System::Web::SiteMapNode ^ GetCurrentNodeAndHintAncestorNodes(int upLevel);public virtual System.Web.SiteMapNode GetCurrentNodeAndHintAncestorNodes (int upLevel);abstract member GetCurrentNodeAndHintAncestorNodes : int -> System.Web.SiteMapNode
override this.GetCurrentNodeAndHintAncestorNodes : int -> System.Web.SiteMapNodePublic Overridable Function GetCurrentNodeAndHintAncestorNodes (upLevel As Integer) As SiteMapNodeパラメーター
- upLevel
- Int32
取得する先祖のサイト マップ ノードの世代数。 値 -1 は、プロバイダーによってすべての先祖が取得され、キャッシュされることを示します。
戻り値
現在要求されているページを表す SiteMapNode。SiteMapNode が見つからなかった場合、または見つかったが現在のユーザーに返すことができない場合は null。
例外
upLevel が -1 未満です。
注釈
メソッドの既定の実装ではプロパティが GetCurrentNodeAndHintAncestorNodes 返 CurrentNode されます。ただし、サイト マップ プロバイダーはメソッドを GetCurrentNodeAndHintAncestorNodes オーバーライドし、カスタム キャッシュ メカニズムを使用して現在 SiteMapNodeのノード、および親の親ノードと先祖ノードを返す最適化された実装を提供できます。
この upLevel パラメーターは、取得する親ノードと先祖ノードのレベルの数を指定するために使用されます。 必要に応じて、親ノードと先祖ノードを、プロパティを SiteMapNode 使用して、メソッドによって GetCurrentNodeAndHintAncestorNodes 返されるオブジェクトに ParentNode リンクできます。
このクラスはXmlSiteMapProvider、ASP.NET の既定のサイト マップ プロバイダーであり、サイト マップ全体をメモリにキャッシュします。そのため、特定SiteMapNodeのオブジェクトに対してクエリをXmlSiteMapProvider実行するときにオーバーヘッドがほとんどまたはまったく発生しません。