SiteMapProvider.FindSiteMapNodeFromKey(String) Метод

Определение

Получает объект SiteMapNode на основе указанного ключа.

public:
 virtual System::Web::SiteMapNode ^ FindSiteMapNodeFromKey(System::String ^ key);
public virtual System.Web.SiteMapNode FindSiteMapNodeFromKey (string key);
abstract member FindSiteMapNodeFromKey : string -> System.Web.SiteMapNode
override this.FindSiteMapNodeFromKey : string -> System.Web.SiteMapNode
Public Overridable Function FindSiteMapNodeFromKey (key As String) As SiteMapNode

Параметры

key
String

Ключ соответствия, с помощью которого создан объект SiteMapNode.

Возвращаемое значение

SiteMapNode

Объект SiteMapNode, представляющий страницу, определенную объектом key; в противном случае — значение null, если соответствующий объект SiteMapNode не найден или если фильтрация по ролям безопасности разрешена и объект SiteMapNode не может быть возвращен для текущего пользователя. Значение по умолчанию — null.

Комментарии

Реализация SiteMapProvider возвращается null во всех случаях. Классы, производные от SiteMapProvider класса, могут переопределять FindSiteMapNodeFromKey метод для предоставления функций поиска на основе уникального ключа (вместо URL-адреса, используемого FindSiteMapNode методом). Реализуйте метод, FindSiteMapNodeFromKey если реализация поставщика карты сайта использует SiteMapNode.Key свойство объекта в качестве основного SiteMapNode идентификатора в структуре карты сайта.

Класс StaticSiteMapProvider предоставляет реализацию, которая обрабатывает поиск узлов карты сайта, которые не определяют URL-адрес.

КлассXmlSiteMapProvider, который является поставщиком карты сайта по умолчанию для ASP.NET, использует URL-адрес SiteMapNode ключа в различных коллекциях, которые поддерживаются классами. Таким образом, если узел предоставляет URL-адрес, он должен быть уникальным в пределах области поставщика карты сайта. Если URL-адрес не указан, создается уникальный идентификатор для идентификации SiteMapNode.

Применяется к

См. также раздел