SP.Taxonomy.Term object (sp.taxonomy)

  • Article

Represents a Term or a Keyword in a managed metadata hierarchy.

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

var object = new SP.Taxonomy.Term()

Members

The Term object has the following members.

Constructor

The Term object has the following constructor.

Constructor

Description

Term

Initializes a new instance of the SP.Taxonomy.Term object (sp.taxonomy) object.

Methods

The Term object has the following methods.

Method

Description

copy

Creates and returns a sibling copy of the current Term object within the current TermSet object.

createLabel

Creates a new Label for this Term.

deleteAllLocalCustomProperties

Deletes all local custom properties.

deleteLocalCustomProperty

Deletes a local custom property from the current object.

deprecate

Deprecates or enables the current Term object.

getAllLabels

Gets all of the Label objects for the provided lcid parameter.

getDefaultLabel

Gets the default Label for this Term based on the LCID.

getDescription

Gets the description of the Term in the LCID.

getIsDescendantOf

Indicates whether the current Term object is a descendent Term of the specified Term.

getPath

Gets the path for the current Term in the specified lcid.

getTerms

Returns all Term instances that are descendants of the current Term with a Label in the provided LCID matching the string provided. It only checks default Labels if defaultLabelOnly is true.

merge

Merges the current Term object with the specified Term and returns the combined Term.

move

Moves the current Term object to be a child of a different Term.

reassignSourceTerm

Reassigns the source term status to one of the other reused instances of this Term object.

setDescription

Sets the LCID-specific description of this Term object.

setLocalCustomProperty

Sets a new local custom property or updates the value of an existing local property.

Properties

The Term object has the following properties.

Property

Description

description

Gets or sets the description of the current Term object.

isDeprecated

Gets whether the current Term object has been deprecated.

isKeyword

Gets whether the current Term object is a keyword in the keyword term set.

isPinned

Gets a Boolean value that indicates if this is a pinned object.

isPinnedRoot

Gets a Boolean value that indicates if this is a pinned object and the root of the pinned tree.

isReused

Gets whether the current Term object is a reused Term.

isRoot

Gets whether the current Term object is at the root of the TermSet object

isSourceTerm

Gets whether the current Term is the source Term among reused terms.

labels

Gets a collection of Label objects for the current Term object.

localCustomProperties

Gets the collection of local custom properties for this term.

mergedTermIds

Gets a read-only collection of Term Ids. Term objects identified by those Ids have been merged into the current Term.

parent

Gets the parent Term object of the current Term.

pathOfTerm

Gets the path for this Term in the TermStore default language.

pinSourceTermSet

Gets the TermSet object that contains the term to which this object is pinned.

reusedTerms

Gets all of the instances of the current Term object that are reused in other TermSet objects.

sourceTerm

Gets the source Term if the current Term is a reused term.

termsCount

Gets the number of child Term objects.

termSet

Gets the TermSet object for the current Term object.

termSets

Gets the collection of all TermSet objects where the current Term object is located.