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

  • Article

Specifies navigation behavior and properties for a SP.Taxonomy.Term constructor (sp.taxonomy) object that is used to drive the navigation and friendly URLs for a website.

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

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

Members

The NavigationTerm object has the following members.

Methods

The NavigationTerm object has the following methods.

Method

Description

deleteObject

Deletes this SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object and its child objects from the associated SP.Taxonomy.TermStore object (sp.taxonomy) object.

getAllParentTerms

Returns the SP.Publishing.Navigation.NavigationTerm.parent property (sp.publishing) parent object and all of its parents. If there is no parent, then the collection will be empty.

getAsEditable

Returns an editable version of a SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object.

getAsResolvedByView

Constructs a SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object in editable mode that is bound to the specified SP.Taxonomy.Term constructor (sp.taxonomy) object.

getAsResolvedByWeb

Constructs an editable SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object that is bound to a specified SP.Taxonomy.Term constructor (sp.taxonomy) object.

getResolvedAssociatedFolderUrl

Returns the associatedFolderUrl property as a server-relative URL.

getResolvedTargetUrl

Returns a target page address as a server-relative URL from the SP.Publishing.Navigation.NavigationTerm.targetUrl property (sp.publishing) property.

getResolvedTargetUrlWithoutQuery

Returns a target page address as a server-relative URL that does not include a query string.

getTaxonomyTerm

Returns the associated SP.Taxonomy.Term constructor (sp.taxonomy) object if the SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object is in the editable mode.

getWebRelativeFriendlyUrl

Returns the friendly URL segments as a concatenated path.

getWithNewView

Returns a new SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object based on the SP.Publishing.Navigation.NavigationTermSetView object (sp.publishing) that is provided.

move

Moves the SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object to be a child of the specified NavigationTerm object or SP.Publishing.Navigation.NavigationTermSet object (sp.publishing) object.

Properties

The NavigationTerm object has the following properties.

Property

Description

associatedFolderUrl

Gets or sets the URL value that is used to associate some page URLs with this SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object to indicate the location of the properties in the site map provider hierarchy.

catalogTargetUrl

Gets the target URL that is used when rewriting URLs for catalog-friendly URLs that are based on this SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object.

categoryImageUrl

Gets or sets the specified URL of an image that optionally can be displayed by a template page.

excludedProviders

A collection of site map provider names that will exclude this navigation term from their results when SP.Publishing.Navigation.NavigationTermSetView.excludeTermsByProvider property (sp.publishing) is true. This collection includes the names corresponding to SP.Publishing.Navigation.NavigationTerm.excludeFromGlobalNavigation property (sp.publishing) and SP.Publishing.Navigation.NavigationTerm.excludeFromCurrentNavigation property (sp.publishing).

excludeFromCurrentNavigation

Gets or sets whether this navigation term and its child terms are hidden from the current navigation menu.

excludeFromGlobalNavigation

Gets or sets a value that indicates whether the navigation term and its child terms are hidden from the global navigation menu.

friendlyUrlSegment

Gets a custom friendly URL segment for the node that is represented by the SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object.

hoverText

Gets or sets a description that is typically displayed by a menu or by breadcrumb navigation controls when the mouse hovers over the navigation link.

isDeprecated

Indicates whether the SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object is deprecated.

isPinned

Indicates whether a SP.Taxonomy.Term constructor (sp.taxonomy) object is a pinned term.

isPinnedRoot

Indicates whether the underlying SP.Taxonomy.Term constructor (sp.taxonomy) object is the root of a subtree of pinned terms.

parent

Returns the parent SP.Publishing.Navigation.NavigationTerm object (sp.publishing) object.

simpleLinkUrl

Gets or sets the target URL if the navigation node represents a simple link.

targetUrl

Gets the URL of a publishing page that is used to render a friendly URL.

termSet

Gets the associated SP.Publishing.Navigation.NavigationTermSet object (sp.publishing) object that the SP.Publishing.Navigation.NavigationTerm object (sp.publishing) belongs to.

Constructor

The NavigationTerm object has the following constructor.

Constructor

Description

NavigationTerm

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