PortalSiteMapProvider Members
SharePoint 2007
Provides PortalSiteMapNode objects that represent a merging of the Windows SharePoint Services 3.0SPNavigation store and dynamic site structure, including sites and pages.
The following tables list the members exposed by the PortalSiteMapProvider type.
| Name | Description | |
|---|---|---|
| PortalSiteMapProvider | Specifies the default constructor for the PortalSiteMapProvider class. |
(see also
Protected Fields
)
Top
| Name | Description | |
|---|---|---|
| EmptyCollection | A field that contains a read-only empty SiteMapNodeCollection object. |
| Name | Description | |
|---|---|---|
| currentSite | Field that contains a SPSite object that represents the current site. |
|
| currentWeb | Field that contains an SPWeb object that represents the current Web site. |
| 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 | Overridden. Gets a PortalSiteMapNode object that represents the item a site user is currently visiting. |
|
| CurrentSite | Gets or sets the SPSite object that is used by the T:Microsoft.SharePoint.Publishing.Navigation.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. |
|
| 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 | Boolean value that represents whether to flatten heading nodes. |
|
| GlobalNavSiteMapProvider | Gets a PortalSiteMapProvider object that has the NavigationType value equal to "Global". |
|
| IncludeAuthoredLinks | A Boolean value that represents whether to return link nodes. |
|
| IncludeHeadings | 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 (subwebs). |
|
| Name | (inherited from ProviderBase) |
|
| NavigationType | Gets or sets the type of navigation of this navigation provider. |
|
| ParentProvider | (inherited from SiteMapProvider) |
|
| RequireUniqueKeysForNodes | |
|
| ResourceKey | (inherited from SiteMapProvider) |
|
| RootNode | (inherited from SiteMapProvider) |
|
| RootProvider | (inherited from SiteMapProvider) |
|
| SecurityTrimmingEnabled | (inherited from SiteMapProvider) |
|
| TryGetRootNode | Returns the root node only if it is cached. |
|
| WebSiteMapProvider | Gets a PortalSiteMapNode object used to enumerate the Web sites in this collection. |
(see also
Protected Methods
)
Top
| Name | Description | |
|---|---|---|
|
| CreateAdditionalSiteMapNodes | Allows addition of PortalSiteMapNode object under any PortalWebSiteMapNode object. |
|
| CreateCustomSiteMapNode | Allows 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 | Overloaded. (inherited from Object) |
|
| FindSiteMapNode | Overloaded. |
|
| 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 | Overloaded. Overridden. |
|
| GetCurrentNodeAndHintAncestorNodes | (inherited from SiteMapProvider) |
|
| GetCurrentNodeAndHintNeighborhoodNodes | (inherited from SiteMapProvider) |
|
| GetHashCode | (inherited from Object) |
|
| GetParentNode | Overridden. Returns the parent of a specified PortalSiteMapNode object. |
|
| GetParentNodeRelativeToCurrentNodeAndHintDownFromParent | (inherited from SiteMapProvider) |
|
| GetParentNodeRelativeToNodeAndHintDownFromParent | (inherited from SiteMapProvider) |
|
| GetType | (inherited from Object) |
|
| HintAncestorNodes | (inherited from SiteMapProvider) |
|
| HintNeighborhoodNodes | (inherited from SiteMapProvider) |
|
| Initialize | Overridden. Initializes the PortalSiteMapProvider object using the specified setting. |
|
| IsAccessibleToUser | (inherited from SiteMapProvider) |
|
| ReferenceEquals | (inherited from Object) |
|
| ToString | (inherited from Object) |
| Name | Description | |
|---|---|---|
|
| AddNode | Overloaded. (inherited from SiteMapProvider) |
|
| Finalize | (inherited from Object) |
|
| GetPermissionCache | |
|
| GetRootNodeCore | Overridden. An override of the method on the SiteMapProvider class. |
|
| GetRootNodeCoreFromProvider | (inherited from SiteMapProvider) |
|
| MemberwiseClone | (inherited from Object) |
|
| RemoveNode | (inherited from SiteMapProvider) |
|
| ResolveSiteMapNode | (inherited from SiteMapProvider) |
