SiteMapProvider.HintAncestorNodes(SiteMapNode, Int32) Method

Definition

Предоставляет метод, который поставщики карт веб-узлов могут переопределить для проведения оптимизированного получения одного или нескольких уровней родительских и дочерних узлов, связанных с указанным объектом SiteMapNode.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)

Parameters

node
SiteMapNode

Объект SiteMapNode, действующий как опорная точка для объекта upLevel.The 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.

Exceptions

Значение upLevel меньше -1.upLevel is less than -1.

Параметр node равен null.node is null.

Remarks

Метод HintAncestorNodes по умолчанию проверяет только параметр upLevel, который имеет значение меньше-1, и параметр node, null.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. Если предпочтительно, родительский узел может быть связан с заданным SiteMapNode с помощью свойства ParentNode.If preferred, the parent node can be linked to the specified SiteMapNode using the ParentNode property.

Applies to

See also