SiteMapProvider.FindSiteMapNodeFromKey(String) Метод

Определение

Получает объект SiteMapNode на основе указанного ключа.Retrieves a SiteMapNode object based on a specified key.

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.A lookup key with which a SiteMapNode is created.

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

SiteMapNode

Объект SiteMapNode, представляющий страницу, определенную объектом key; в противном случае — значение null, если соответствующий объект SiteMapNode не найден или если фильтрация по ролям безопасности разрешена и объект SiteMapNode не может быть возвращен для текущего пользователя.A SiteMapNode that represents the page identified by key; otherwise, null, if no corresponding SiteMapNode is found or if security trimming is enabled and the SiteMapNode cannot be returned for the current user. Значение по умолчанию — null.The default is null.

Комментарии

Реализация SiteMapProvider возвращает null во всех случаях.The SiteMapProvider implementation returns null in all cases. Классы, производные от класса SiteMapProvider, могут переопределять метод FindSiteMapNodeFromKey для предоставления функций поиска на основе уникального ключа (вместо URL-адреса, который используется методом FindSiteMapNode).Classes that derive from the SiteMapProvider class can override the FindSiteMapNodeFromKey method to provide lookup functionality based on a unique key (instead of a URL, which is used by the FindSiteMapNode method). Реализуйте метод FindSiteMapNodeFromKey, если в реализации поставщика карт сайта используется свойство SiteMapNode.Key объекта SiteMapNode в качестве первичного идентификатора в структуре схемы узла.Implement the FindSiteMapNodeFromKey method if your site map provider implementation uses the SiteMapNode.Key property of a SiteMapNode object as a primary identifier in a site map structure.

Класс StaticSiteMapProvider предоставляет реализацию, которая обрабатывает Поиск узлов карт сайта, которые не определяют URL-адрес.The StaticSiteMapProvider class provides an implementation that handles searching for site map nodes that do not define a URL.

Класс XmlSiteMapProvider, который является поставщиком схемы узла по умолчанию для ASP.NET, использует URL-адрес SiteMapNode в качестве ключа в различных коллекциях, которые поддерживаются классами.The XmlSiteMapProvider class, which is the default site map provider for ASP.NET, uses the URL of a SiteMapNode as a key in the various collections that the classes maintain. Таким образом, если узел предоставляет URL-адрес, он должен быть уникальным в пределах области поставщика карт узла.Therefore, if a node provides a URL, it must be unique within the scope of the site map provider. Если URL-адрес не указан, для идентификации SiteMapNodeсоздается уникальный идентификатор.If no URL is provided, a unique identifier is generated to identify the SiteMapNode.

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

Дополнительно