Interface ITermSet

Represents the set used in a term store. The set represents a unit which contains a collection of hierarchical terms. A group can contain multiple sets.

Inherited Members

IDataModel<ITermSet>.Requested

IDataModel<ITermSet>.HasValue(String)

IDataModel<ITermSet>.HasChanged(String)

IDataModel<ITermSet>.IsPropertyAvailable(Expression<Func<ITermSet, Object>>)

IDataModel<ITermSet>.ArePropertiesAvailable(Expression<Func<ITermSet, Object>>[])

IDataModel<ITermSet>.EnsureProperties(Expression<Func<ITermSet, Object>>[])

IDataModel<ITermSet>.EnsurePropertiesAsync(Expression<Func<ITermSet, Object>>[])

IDataModel<ITermSet>.ExecuteRequestAsync(ApiRequest)

IDataModel<ITermSet>.ExecuteRequest(ApiRequest)

IDataModel<ITermSet>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<ITermSet>.ExecuteRequestBatch(ApiRequest)

IDataModel<ITermSet>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<ITermSet>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IDataModelGet<ITermSet>.GetBatchAsync(Batch, Expression<Func<ITermSet, Object>>[])

IDataModelGet<ITermSet>.GetAsync(Expression<Func<ITermSet, Object>>[])

IDataModelLoad<ITermSet>.LoadBatchAsync(Batch, Expression<Func<ITermSet, Object>>[])

IDataModelLoad<ITermSet>.LoadAsync(Expression<Func<ITermSet, Object>>[])

IDataModelUpdate.UpdateBatchAsync()

IDataModelUpdate.UpdateBatchAsync(Batch)

IDataModelUpdate.UpdateAsync()

IDataModelUpdate.UpdateBatch()

IDataModelUpdate.UpdateBatch(Batch)

IDataModelUpdate.Update()

IDataModelDelete.DeleteBatchAsync()

IDataModelDelete.DeleteBatchAsync(Batch)

IDataModelDelete.DeleteAsync()

IDataModelDelete.DeleteBatch()

IDataModelDelete.DeleteBatch(Batch)

IDataModelDelete.Delete()

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface ITermSet : IDataModel<ITermSet>, IDataModelParent, IDataModelWithContext, ISupportModules<ITermSet>, IDataModelGet<ITermSet>, IDataModelLoad<ITermSet>, IDataModelUpdate, IDataModelDelete, IQueryableDataModel

Properties

CreatedDateTime

Date and time of term set creation. Read-only.

Declaration

DateTimeOffset CreatedDateTime { get; }

Property Value

DateTimeOffset

Description

Description giving details on the term set.

Declaration

string Description { get; set; }

Property Value

System.String

Group

The parent group for this termset

Declaration

ITermGroup Group { get; }

Property Value

ITermGroup

Id

The Unique ID of the term set.

Declaration

string Id { get; }

Property Value

System.String

LocalizedNames

Name of the term set for each language.

Declaration

ITermSetLocalizedNameCollection LocalizedNames { get; }

Property Value

ITermSetLocalizedNameCollection

Properties

Properties on this term set

Declaration

ITermSetPropertyCollection Properties { get; }

Property Value

ITermSetPropertyCollection

Relations

Collection of terms relations

Declaration

ITermRelationCollection Relations { get; }

Property Value

ITermRelationCollection

Terms

Collection of term in this term set Implements .
See Requesting model collections and IQueryable performance considerations to learn more.

Declaration

ITermCollection Terms { get; }

Property Value

ITermCollection

Methods

AddLocalizedName(String, String)

Adds a new localized termset name. Call update to persist this change.

Declaration

void AddLocalizedName(string name, string languageTag)

Parameters

System.String name Termset label

System.String languageTag Language the label is in

AddProperty(String, String)

Adds a property to the term set's property collection. Call update to persist this change.

Declaration

void AddProperty(string key, string value)

Parameters

System.String key Property key

System.String value Property value

AddPropertyAsync(String, String)

Adds a property to the term set's property collection. Call update to persist this change.

Declaration

Task AddPropertyAsync(string key, string value)

Parameters

System.String key Property key

System.String value Property value

Returns

Task

GetTermsByCustomProperty(String, String, Boolean)

Gets all terms with this property.

Declaration

IList<ITerm> GetTermsByCustomProperty(string key, string value, bool trimUnavailable = false)

Parameters

System.String key Property key

System.String value Property value

System.Boolean trimUnavailable Trim unavailable terms

Returns

PnP.Core.Model.SharePoint.IList<ITerm>

GetTermsByCustomPropertyAsync(String, String, Boolean)

Gets all terms with this property.

Declaration

Task<IList<ITerm>> GetTermsByCustomPropertyAsync(string key, string value, bool trimUnavailable = false)

Parameters

System.String key Property key

System.String value Property value

System.Boolean trimUnavailable Trim unavailable terms

Returns

Task<PnP.Core.Model.SharePoint.IList<ITerm>>

Extension Methods

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])

DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])

DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])

DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<String, String>>)