SP.Publishing.Navigation.NavigationTermSetView object (sp.publishing)

Represents contextual information that affects the calculation of certain properties for the SP.Publishing.Navigation.NavigationTerm object (sp.publishing) objects in a SP.Publishing.Navigation.NavigationTermSet object (sp.publishing) object.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.Publishing.Navigation.NavigationTermSetView()

Members

The NavigationTermSetView object has the following members.

Methods

The NavigationTermSetView object has the following methods.

Method

Description

createEmptyInstance

Creates and returns a new instance of the SP.Publishing.Navigation.NavigationTermSetView object (sp.publishing) class. The SP.Publishing.Navigation.NavigationTermSetView.webId property (sp.publishing) property will be assigned the empty GUID, the string-typed properties will be assigned as empty strings, and the Boolean-typed properties will be initialized to false.

getCopy

Returns an editable copy of the current SP.Publishing.Navigation.NavigationTermSetView object (sp.publishing) object.

newObject

Properties

The NavigationTermSetView object has the following properties.

Property

Description

excludeDeprecatedTerms

Gets or sets a value that indicates whether SP.Publishing.Navigation.NavigationTerm object (sp.publishing) objects are trimmed if the underlying term is deprecated.

excludeTermsByPermissions

Gets or sets a value that indicates whether SP.Publishing.Navigation.NavigationTerm object (sp.publishing) objects are trimmed if the current user does not have permission to view the target page for the friendly URL of the NavigationTerm object.

excludeTermsByProvider

Gets or sets a value that indicates whether SP.Publishing.Navigation.NavigationTerm object (sp.publishing) objects are trimmed if the provider indicated by the SP.Publishing.Navigation.NavigationTermSetView.siteMapProviderName property (sp.publishing) property is one of the providers in the excluded providers collection.

serverRelativeSiteUrl

Gets a server-relative URL for the SPSite object that uses the navigation term set.

serverRelativeWebUrl

Gets a server-relative URL for the SP.Web object (sp.js) object that uses the navigation term set.

siteMapProviderName

The name of a SiteMapProvider instance that identifies the navigation menu to be used when applying the SP.Publishing.Navigation.NavigationTermSetView.excludeTermsByProvider property (sp.publishing) property.

webId

Gets the GUID identifier for the SP.Web object (sp.js) object that uses the navigation term set.

webTitle

Gets the title of the SP.Web object (sp.js) object that uses the navigation term set.

Constructor

The NavigationTermSetView object has the following constructor.

Constructor

Description

NavigationTermSetView

Initializes a new instance of the SP.Publishing.Navigation.NavigationTermSetView object.