Share via


PublishingWeb.IncludeInGlobalNavigation Property

Controls whether this Web site is included by PortalSiteMapProvider objects that have NavigationType set to "Global".

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

Syntax

'Declaration
Public Property IncludeInGlobalNavigation As Boolean
    Get
    Set
'Usage
Dim instance As PublishingWeb
Dim value As Boolean

value = instance.IncludeInGlobalNavigation

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

Property Value

Type: System.Boolean
A Boolean value that represents whether this Web site is included.
This property defaults to True. It is set to True if the PublishingWeb object should be included; otherwise, it is set to False.

Remarks

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

Setting this property opens, modifies, or updates the parent PublishingWeb object. This action can make other instances of the same PublishingWeb stale. When showing or hiding several children of the same parent, using IncludeInNavigation or PublishingWebExcludeFromNavigation(Boolean, Guid) may perform better.

To save changes after setting this property, call the Update method.

See Also

Reference

PublishingWeb Class

PublishingWeb Members

Microsoft.SharePoint.Publishing Namespace

PortalSiteMapProvider

NavigationType