SPXmlContentMapProvider.FindSiteMapNodeFromKey Method
Retrieves a SiteMapNode object based on a specified key.
Namespace: Microsoft.SharePoint.Navigation
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
Public Overrides Function FindSiteMapNodeFromKey ( _
key As String _
) As SiteMapNode
'Usage
Dim instance As SPXmlContentMapProvider
Dim key As String
Dim returnValue As SiteMapNode
returnValue = instance.FindSiteMapNodeFromKey(key)
public override SiteMapNode FindSiteMapNodeFromKey(
string key
)
Parameters
key
Type: System.StringA lookup key with which a SiteMapNode is created.
Return Value
Type: System.Web.SiteMapNode
A SiteMapNode that represents the page identified by key. If no corresponding SiteMapNode is found, a a null reference (Nothing in Visual Basic) reference (Nothing in Visual Basic) is returned. The default is a a null reference (Nothing in Visual Basic) reference (Nothing in Visual Basic).
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | A required String value is a null reference (Nothing in Visual Basic). |
Remarks
Classes that derive from the SiteMapProvider class can override the FindSiteMapNodeFromKey method to provide lookup functionality based on a unique key. This method should be implemented when a site map provider uses the Key property as a primary identifier in a site map structure.
See Also
Reference
SPXmlContentMapProvider Members
Microsoft.SharePoint.Navigation Namespace
FindSiteMapNode()