PortalSiteMapProvider members
SharePoint 2013
Provides PortalSiteMapNode objects that represent a merging of the Microsoft SharePoint Foundation 2010SPNavigation store and dynamic site structure, including sites and pages.
The PortalSiteMapProvider type exposes the following members.
| Name | Description | |
|---|---|---|
|
PortalSiteMapProvider | Specifies the default constructor for the PortalSiteMapProvider class. |
| Name | Description | |
|---|---|---|
|
CombinedNavSiteMapProvider | Gets the PortalSiteMapProvider object that is attached to the global navigation or top navigation menu by default. |
|
|
CurrentNavSiteMapProvider | Gets the PortalSiteMapProvider object that is attached by default to the current navigation or Quick Launch. |
|
|
CurrentNavSiteMapProviderNoEncode | Gets the PortalSiteMapProvider object that is attached to the breadcrumb navigation by default. |
|
|
CurrentNode | Gets a PortalSiteMapNode object that represents the item a site user is currently visiting. (Overrides SiteMapProvider.CurrentNode.) |
|
|
CurrentSite | Gets or sets the SPSite object that is used by the PortalSiteMapProvider object. |
|
|
CurrentWeb | Gets or sets the SPWeb object that the PortalSiteMapProvider object uses as a security context. |
|
|
Description | (Inherited from ProviderBase.) |
|
|
DynamicChildLimit | Gets or sets the maximum number of dynamic child items to show at each level. Dynamic child items are subsites (that is, any SPWeb objects) and pages. |
|
EditLinksAlternateAction | |
|
|
EnableAudienceTargeting | Gets or sets whether to respect audience targeting settings when returning navigation nodes. |
|
|
EnableLocalization | (Inherited from SiteMapProvider.) |
|
|
EncodeOutput | Gets or sets whether to HTML-encode the Title property of each PortalSiteMapNode object. |
|
|
FlattenHeadings | Gets a Boolean value that represents whether to flatten heading nodes. |
|
|
GlobalNavSiteMapProvider | Gets a PortalSiteMapProvider object that has the NavigationType value equal to "Global". |
|
|
IncludeAuthoredLinks | Gets a Boolean value that represents whether to return link nodes. |
|
|
IncludeHeadings | Gets a Boolean value that represents whether to return heading nodes. |
|
|
IncludePages | Gets or sets the method used to determine whether pages are returned by this provider. |
|
|
IncludeSubSites | Gets or sets the method used to determine whether this provider returns subsites. |
|
|
IsEditable | |
|
|
MaximumSupportedNodeDepth | |
|
|
Name | (Inherited from ProviderBase.) |
|
|
NavigationType | Gets or sets the type of navigation of this navigation provider. |
|
|
ParentProvider | (Inherited from SiteMapProvider.) |
|
|
RequireUniqueKeysForNodes | Gets or sets a value that indicates if nodes require unique keys. |
|
|
ResourceKey | (Inherited from SiteMapProvider.) |
|
|
RootNode | (Inherited from SiteMapProvider.) |
|
|
RootProvider | (Inherited from SiteMapProvider.) |
|
|
SecurityTrimmingEnabled | (Inherited from SiteMapProvider.) |
|
|
TryGetCurrentNode | Gets a PortalSiteMapNode object that represents the item that a site user is currently visiting. |
|
|
TryGetRootNode | Gets the root node only if it is cached. |
|
|
Version | Gets or sets the version of the PortalSiteMapProvider object. |
|
|
WebSiteMapProvider | Gets a PortalSiteMapNode object used to enumerate the Web sites in this collection. |
| Name | Description | |
|---|---|---|
|
AddNode(SiteMapNode) | (Inherited from SiteMapProvider.) |
|
|
AddNode(SiteMapNode, SiteMapNode) | (Inherited from SiteMapProvider.) |
|
|
CreateAdditionalSiteMapNodes | Enables the addition of PortalSiteMapNode objects under any PortalWebSiteMapNode object. |
|
|
CreateCustomSiteMapNode | Enables custom handling of any SPNavigationNode objects marked as Custom. |
|
|
CreateErrorPortalSiteMapNode | This member is reserved for internal use and is not intended to be used directly from your code. |
|
|
CreateErrorSiteMapNodeCollection | This member is reserved for internal use and is not intended to be used directly from your code. |
|
|
Equals | (Inherited from Object.) |
|
|
Finalize | (Inherited from Object.) |
|
|
FindSiteMapNode(HttpContext) | (Inherited from SiteMapProvider.) |
|
|
FindSiteMapNode(String) | Returns the PortalSiteMapNode object for a specified URL and context. (Overrides SiteMapProvider.FindSiteMapNode(String).) |
|
|
FindSiteMapNode(String, SPWeb) | Returns the PortalSiteMapNode for the given URL. |
|
|
FindSiteMapNodeFromKey | (Inherited from SiteMapProvider.) |
|
|
GetCachedList | Gets a PortalListSiteMapNode object that represents a specified SPList object. |
|
|
GetCachedListItemsByQuery | Gets a collection of PortalListItemSiteMapNode objects that represent the list items returned by a specified query. |
|
|
GetCachedSiteDataQuery | Returns the cached result of a SiteDataQuery object. |
|
|
GetChildNodes(SiteMapNode) | Returns a security-trimmed collection of child nodes from a specified parent node. (Overrides SiteMapProvider.GetChildNodes(SiteMapNode).) |
|
|
GetChildNodes(PortalSiteMapNode, NodeTypes) | Returns a security-trimmed collection of child nodes of a specified node type from a specified parent. |
|
|
GetChildNodes(PortalSiteMapNode, NodeTypes, NodeTypes) | Returns a security-trimmed collection of child nodes for a specified parent node, specified node types to include, and specified node types to include if hidden. |
|
|
GetChildNodes(PortalSiteMapNode, NodeTypes, NodeTypes, NodeOrder, Boolean) | This member is reserved for internal use and is not intended to be used directly from your code. |
|
|
GetChildNodes(PortalSiteMapNode, NodeTypes, NodeTypes, OrderingMethod, AutomaticSortingMethod, Boolean, Int32) | Returns a sorted, security-trimmed collection of child nodes for a specified parent node, types of nodes to include, types of hidden nodes to include, and sorting options. |
|
|
GetCurrentNodeAndHintAncestorNodes | (Inherited from SiteMapProvider.) |
|
|
GetCurrentNodeAndHintNeighborhoodNodes | (Inherited from SiteMapProvider.) |
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetMenuState | |
|
|
GetParentNode | Returns the parent of a specified PortalSiteMapNode object. (Overrides SiteMapProvider.GetParentNode(SiteMapNode).) |
|
|
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent | (Inherited from SiteMapProvider.) |
|
|
GetParentNodeRelativeToNodeAndHintDownFromParent | (Inherited from SiteMapProvider.) |
|
|
GetPermissionCache | Returns a Dictionary of the permission GUIDs and associated permissions represented as a Boolean value. |
|
|
GetRootNodeCore | Represents an override of the method on the SiteMapProvider class. (Overrides SiteMapProvider.GetRootNodeCore().) |
|
|
GetType | (Inherited from Object.) |
|
|
HintAncestorNodes | (Inherited from SiteMapProvider.) |
|
|
HintNeighborhoodNodes | (Inherited from SiteMapProvider.) |
|
|
Initialize | Initializes the PortalSiteMapProvider object using the specified setting. (Overrides SiteMapProvider.Initialize(String, NameValueCollection).) |
|
|
IsAccessibleToUser | (Inherited from SiteMapProvider.) |
|
|
MemberwiseClone | (Inherited from Object.) |
|
|
RemoveNode | (Inherited from SiteMapProvider.) |
|
|
ResolveSiteMapNode | (Inherited from SiteMapProvider.) |
|
|
SaveUpdatedMenuState | |
|
|
ToString | (Inherited from Object.) |
| Name | Description | |
|---|---|---|
|
currentSite | Specifies the field that contains a SPSite object that represents the current site. |
|
|
currentWeb | Specifies the field that contains an SPWeb object that represents the current Web site. |
|
EmptyCollection | Specifies the field that contains a read-only empty SiteMapNodeCollection object. |
