Term members

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

The Term type exposes the following members.

Constructors

  Name Description
Public method Term Initializes a new instance of a Term object.

Top

Properties

  Name Description
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property CreatedDate Gets the DateTime at which this item was created. (Inherited from TaxonomyItem.)
Public property CustomProperties Gets the collection of effective CustomProperty instances for a Term object or TermSet object. (Inherited from TermSetItem.)
Public property CustomSortOrder Gets the custom sort order for children of the current item. (Inherited from TermSetItem.)
Public property Description Gets or sets the description of the current Term object.
Public property Id Gets the Id of the current TaxonomyItem. (Inherited from TaxonomyItem.)
Public property IsAvailableForTagging Gets whether the TaxonomyItem object should appear in the tagging UI. (Inherited from TermSetItem.)
Public property IsDeprecated Gets whether the current Term object has been deprecated.
Public property IsKeyword Gets whether the current Term object is a keyword in the KeywordTermSet object.
Public property IsPinned Gets a Boolean value that indicates if this is a pinned object.
Public property IsPinnedRoot Gets a Boolean value that indicates if this is a pinned object and the root of the pinned tree.
Public property IsReused Gets whether the current Term object is a reused Term.
Public property IsRoot Gets whether the current Term object is at the root of the TermSet object
Public property IsSourceTerm Gets whether the current Term is the source Term among reused terms
Public property Labels Gets a collection of Label objects for the current Term object.
Public property LastModifiedDate Gets the DateTime at which this item was most recently updated. (Inherited from TaxonomyItem.)
Public property LocalCustomProperties Gets the collection of local custom properties for this term.
Public property MergedTermIds Gets a read-only collection of Term Ids. Term objects identified by those Ids have been merged into the current Term.
Public property Name Gets or sets the name of the current TaxonomyItem object. (Inherited from TaxonomyItem.)
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property ObjectVersion Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property Owner Gets the name of the user who is responsible for the TaxonomyItem object. (Inherited from TermSetItem.)
Public property Parent Gets the parent Term object of the current Term.
Public property Path Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property PathOfTerm
Public property PinSourceTermSet Gets the TermSet object that contains the term to which this object is pinned.
Public property ReusedTerms Gets all of the instances of the current Term object that are reused in other TermSet objects.
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property SourceTerm Gets the source Term if the current Term is a reused term.
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property Terms Gets a collection of the child Term objects of this TaxonomyItem. (Inherited from TermSetItem.)
Public property TermsCount Gets the number of child Term objects.
Public property TermSet Gets the TermSet object for the current Term object.
Public property TermSets Gets the collection of all TermSet objects where the current Term object is located.
Public property TermStore Gets the TermStore object from which the current TaxonomyItem was retrieved. (Inherited from TaxonomyItem.)
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)

Top

Methods

  Name Description
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method Copy Creates and returns a sibling copy of the current Term object within the current TermSet object.
Public method CreateLabel Creates a new Label for this Term.
Public method CreateTerm Creates a new Term below this TaxonomyItem instance. (Inherited from TermSetItem.)
Public method CustomFromJson Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method DeleteAllCustomProperties Deletes all custom properties from this item. (Inherited from TermSetItem.)
Public method DeleteAllLocalCustomProperties Deletes all local custom properties.
Public method DeleteCustomProperty Deletes a specific custom property from this item. (Inherited from TermSetItem.)
Public method DeleteLocalCustomProperty Deletes a local custom property from the current object.
Public method DeleteObject Deletes the current TaxonomyItem object from the system. (Inherited from TaxonomyItem.)
Public method Deprecate Deprecates or enables the current Term object.
Public method FromJson Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method GetAllLabels Gets all of the Label objects for the provided lcid parameter.
Public method GetDefaultLabel Gets the default Label for this Term based on LCID.
Public method GetDescription Gets the description of the Term in the LCID.
Public method GetIsDescendantOf Indicates whether the current Term object is a descendent Term of the specified Term.
Public method GetPath Gets the path for the current Term in the specified lcid.
Public method GetTerms Gets a paged collection containing the child Term objects of this TermSetItem object. (Inherited from TermSetItem.)
Protected method InitNonPropertyFieldFromJson Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitOnePropertyFromJson (Overrides TermSetItem.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method Merge Merge the current Term object with the specified Term and return the combined Term.
Public method Move Moves the current Term object to be a child of a different Term.
Public method ReassignSourceTerm Reassigns the source term status to one of the other reused instances of this Term object.
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method Retrieve() Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method Retrieve([]) Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method ReuseTerm Creates a new reused Term object below this TaxonomyItem object based on a sourceTerm. (Inherited from TermSetItem.)
Public method ReuseTermWithPinning Creates a new Term object below a TaxonomyItem instance based on a sourceTerm and makes the Term pinned so that only the local custom properties, IsAvailableForTagging, and custom sort order for the TermSet can be changed in the TermSet object. (Inherited from TermSetItem.)
Public method SetCustomProperty Sets a custom property for the TermSetItem object. (Inherited from TermSetItem.)
Public method SetDescription Sets the LCID-specific description of this Term object.
Public method SetLocalCustomProperty Sets a new local custom property or updates the value of an existing local property.
Public method ToString (Inherited from Object.)
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)

Top

See also

Reference

Term class

Microsoft.SharePoint.Client.Taxonomy namespace