TermSet TermSet TermSet Class

Definition

Represents a hierarchical or flat set of Term objects known as a "TermSet".

public ref class TermSet sealed : Microsoft::SharePoint::Taxonomy::TermSetItem
[Microsoft.SharePoint.Client.ClientCallableType(ClientLibraryTargets=Microsoft.SharePoint.Client.ClientLibraryTargets.NonRESTful, FactoryType=typeof(Microsoft.SharePoint.Taxonomy.Internal.TaxonomyClientObjectFactory), ObjectIdentityPropertyName="CanonicalId", ServerTypeId="E26FEB13-2940-4db9-A52B-12B160113A80")]
public sealed class TermSet : Microsoft.SharePoint.Taxonomy.TermSetItem
Public NotInheritable Class TermSet
Inherits TermSetItem
Inheritance
Attributes
Microsoft.SharePoint.Client.ClientCallableTypeAttribute

Remarks

The TermSet object contains one or more child Term objects, and the root level of the hierarchy can be accessed through the Terms property. Get Child Term objects with search methods such as GetTerms(String, Boolean).Permissions for editing the TermSet object and its child Term objects are defined on the parent Group object of the current TermSet.

The TermSet object also provides properties to get and set values of the TermSet, such as name and description and a way to delete TermSet objects. Additionally, the TermSet object provides methods for checking changes on the TermSet.

The TermSet object derives from the TermSetItem base object, which provides additional behavior such as the ability to create child Term objects.

Properties

Contact Contact Contact

Gets and sets the contact for the current TermSet object.

CreatedDate CreatedDate CreatedDate

Gets the DateTime at which this item was created.

(Inherited from TaxonomyItem)
CustomProperties CustomProperties CustomProperties

Gets the collection of effective CustomProperty instances for a Term or TermSet.

(Inherited from TermSetItem)
CustomSortOrder CustomSortOrder CustomSortOrder

Gets or sets the custom sort order of the current Term object.

Description Description Description

Gets and sets the description for the current TermSet object.

Group Group Group

Gets the parent Group object of the current TermSet object.

Id Id Id

Gets the Id of the current T:Microsoft.SharePoint.Taxonomy.TaxonomyItem.

(Inherited from TaxonomyItem)
IsAvailableForTagging IsAvailableForTagging IsAvailableForTagging

Gets or sets whether the TermSet object should appear in the tagging user interface.

IsOpenForTermCreation IsOpenForTermCreation IsOpenForTermCreation

Indicates whether the TermSet can be updated by all users, or alternatively just by the specified constributors for the Group object.

LastModifiedDate LastModifiedDate LastModifiedDate

Gets the DateTime at which this item was most recently updated.

(Inherited from TaxonomyItem)
Name Name Name

Gets and sets the name for the current TermSet object.

Owner Owner Owner

Gets or sets the user who is responsible for the current TermSet.

Stakeholders Stakeholders Stakeholders

Gets the collection of stakeholders for the current TermSet object.

Terms Terms Terms

Gets a collection of child Term objects at the root of the TermSet object.

TermStore TermStore TermStore

Gets the TermStore object from which the current Microsoft.SharePoint.TaxonomyItem was retrieved.

(Inherited from TaxonomyItem)

Methods

AddStakeholder(String) AddStakeholder(String) AddStakeholder(String)

Adds a stakeholder to the TermSet object.

Copy() Copy() Copy()

Creates a copy of the TermSet object under the current parent Group object.

CreateTerm(String, Int32) CreateTerm(String, Int32) CreateTerm(String, Int32)

Creates a new Term below this TaxonomyItem instance.The name is the default Label for the LCID specified.

(Inherited from TermSetItem)
CreateTerm(String, Int32, Guid) CreateTerm(String, Int32, Guid) CreateTerm(String, Int32, Guid)

Creates a new Term object below this Microsoft.SharePoint.TaxonomyItem object.The name is the default Label for the specified LCID.

(Inherited from TermSetItem)
Delete() Delete() Delete()

Deletes the current TermSet from the current Group object.

DeleteAllCustomProperties() DeleteAllCustomProperties() DeleteAllCustomProperties()

Deletes all custom properties from the TermSet.

DeleteCustomProperty(String) DeleteCustomProperty(String) DeleteCustomProperty(String)

Deletes a custom property from the TermSet object.

DeleteStakeholder(String) DeleteStakeholder(String) DeleteStakeholder(String)

Deletes a stakeholder from the TermSet object.

DoesUserHavePermissions(TaxonomyRights) DoesUserHavePermissions(TaxonomyRights) DoesUserHavePermissions(TaxonomyRights)

Verifies whether the current user has the permissions specified.

(Inherited from TermSetItem)
Export() Export() Export()

This method is not implemented.

GetAllTerms() GetAllTerms() GetAllTerms()

Returns a collection containing a flat list of all Term objects in the TermSet object.

GetChanges(DateTime) GetChanges(DateTime) GetChanges(DateTime)

Gets a collection of ChangedItem objects that represent changes to the current TermSet since a specified time.

GetChanges(DateTime, ChangedItemType) GetChanges(DateTime, ChangedItemType) GetChanges(DateTime, ChangedItemType)

Gets a collection of ChangedItem objects that represent changes to the current TermSet object since a specified time, restricted by item type.

GetChanges(DateTime, ChangedItemType, ChangedOperationType) GetChanges(DateTime, ChangedItemType, ChangedOperationType) GetChanges(DateTime, ChangedItemType, ChangedOperationType)

Gets a collection of ChangedItem objects that represent changes to the current TermSet since a specified time, restricted by item type and operation type.

GetTerm(Guid) GetTerm(Guid) GetTerm(Guid)

Gets a Term from the current TermSet based on its ID.

GetTerms(Int32) GetTerms(Int32) GetTerms(Int32)

Gets a paged collection containing the child Term objects of this Microsoft.SharePoint.TermSetItem object

(Inherited from TermSetItem)
GetTerms(String, Boolean) GetTerms(String, Boolean) GetTerms(String, Boolean)

Gets a collection of all Term objects from the current TermSet that have a Label object that matches the string provided in any LCID.

GetTerms(String, Boolean, StringMatchOption, Int32, Boolean) GetTerms(String, Boolean, StringMatchOption, Int32, Boolean) GetTerms(String, Boolean, StringMatchOption, Int32, Boolean)

Gets a collection of all Term objects from the current TermSet object with a Label matchingthe string provided in any LCID, with an option to only search default labels.

GetTerms(String, Int32, Boolean) GetTerms(String, Int32, Boolean) GetTerms(String, Int32, Boolean)

Gets a collection of all Term objects from the current TermSet object with a Label in the specified LCID matching the string provided.

GetTerms(String, Int32, Boolean, StringMatchOption, Int32, Boolean) GetTerms(String, Int32, Boolean, StringMatchOption, Int32, Boolean) GetTerms(String, Int32, Boolean, StringMatchOption, Int32, Boolean)

Gets a collection of all Term objects from the current TermSet with a Label in the provided LCID matching the string provided, with an option to only search default labels.

GetTermsWithCustomProperty(String, Boolean) GetTermsWithCustomProperty(String, Boolean) GetTermsWithCustomProperty(String, Boolean)

Gets a collection of Term objects with a property that has the provided property name.

GetTermsWithCustomProperty(String, Int32, Boolean) GetTermsWithCustomProperty(String, Int32, Boolean) GetTermsWithCustomProperty(String, Int32, Boolean)

Gets a collection of Term objects with a property with the provided property name.

GetTermsWithCustomProperty(String, String, Boolean) GetTermsWithCustomProperty(String, String, Boolean) GetTermsWithCustomProperty(String, String, Boolean)

Gets a collection of Term objects with a custom property with the provided property name and the provided property value.

GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean) GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean) GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean)

Gets a collection of Term objects with a custom property starting with or matching the provided property name and the provided property value.

GetTermsWithCustomProperty(String, String, StringMatchOption, Int32, Boolean) GetTermsWithCustomProperty(String, String, StringMatchOption, Int32, Boolean) GetTermsWithCustomProperty(String, String, StringMatchOption, Int32, Boolean)

Gets a collection of Term objects with a custom property starting with or matching the provided property name and the provided property value.

Move(Group) Move(Group) Move(Group)

Moves the current TermSet into a different Group object,

ReuseTerm(Term, Boolean) ReuseTerm(Term, Boolean) ReuseTerm(Term, Boolean)

Creates a new reused Term object below this TaxonomyItem object based on a sourceTerm.

(Inherited from TermSetItem)
ReuseTermWithPinning(Term) ReuseTermWithPinning(Term) ReuseTermWithPinning(Term)

Creates a new Term 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)
SetCustomProperty(String, String) SetCustomProperty(String, String) SetCustomProperty(String, String)

Adds a new custom property with the name if no property exists or updates the value of an existing property.

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to