Share via


PublishingPage.IncludeInCurrentNavigation Property

Controls whether the PublishingPage object is included by PortalSitemapProviders that have NavigationType set to "Current".

Namespace:  Microsoft.SharePoint.Publishing
Assembly:  Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
Public Property IncludeInCurrentNavigation As Boolean
    Get
    Set
'Usage
Dim instance As PublishingPage
Dim value As Boolean

value = instance.IncludeInCurrentNavigation

instance.IncludeInCurrentNavigation = value
public bool IncludeInCurrentNavigation { get; set; }

Property Value

Type: System.Boolean
A Boolean representing whether this page is to be included.
This property defaults to True.
The value is True if this PublishingPage should be included in the current navigation, and it is False if the area should not be included.

Remarks

This property is superseded by IncludePagesInNavigation such that even, if this property is set True, if the parent Web site has the noted property set to False, this Web site does not appear in navigation.

Setting this property opens, modifies, or updates the parent PublishingWeb object. Setting the property could make other instances of the same PublishingWeb object stale. Performance may be better if you use the IncludeInNavigation or ExcludeFromNavigation methods when showing or hiding several children of the same parent.

See Also

Reference

PublishingPage Class

PublishingPage Members

Microsoft.SharePoint.Publishing Namespace

PortalSiteMapProvider

NavigationType