Search Results for

    Show / Hide Table of Contents

    Interface ITerm

    Represents a term used in a term store. A term can be used to represent an object which can then be used as a metadata to tag conent. Multiple terms can be organized in a hierarchical manner within a set.

    Inherited Members
    IDataModel<ITerm>.Requested
    IDataModel<ITerm>.HasValue(String)
    IDataModel<ITerm>.HasChanged(String)
    IDataModel<ITerm>.IsPropertyAvailable(Expression<Func<ITerm, Object>>)
    IDataModel<ITerm>.ArePropertiesAvailable(Expression<Func<ITerm, Object>>[])
    IDataModel<ITerm>.EnsureProperties(Expression<Func<ITerm, Object>>[])
    IDataModel<ITerm>.EnsurePropertiesAsync(Expression<Func<ITerm, Object>>[])
    IDataModel<ITerm>.ExecuteRequestAsync(ApiRequest)
    IDataModel<ITerm>.ExecuteRequest(ApiRequest)
    IDataModel<ITerm>.ExecuteRequestBatchAsync(ApiRequest)
    IDataModel<ITerm>.ExecuteRequestBatch(ApiRequest)
    IDataModel<ITerm>.ExecuteRequestBatchAsync(Batch, ApiRequest)
    IDataModel<ITerm>.ExecuteRequestBatch(Batch, ApiRequest)
    IDataModelParent.Parent
    IDataModelWithContext.PnPContext
    IDataModelGet<ITerm>.GetBatchAsync(Batch, Expression<Func<ITerm, Object>>[])
    IDataModelGet<ITerm>.GetAsync(Expression<Func<ITerm, Object>>[])
    IDataModelLoad<ITerm>.LoadBatchAsync(Batch, Expression<Func<ITerm, Object>>[])
    IDataModelLoad<ITerm>.LoadAsync(Expression<Func<ITerm, 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 ITerm : IDataModel<ITerm>, IDataModelParent, IDataModelWithContext, ISupportModules<ITerm>, IDataModelGet<ITerm>, IDataModelLoad<ITerm>, IDataModelUpdate, IDataModelDelete, IQueryableDataModel

    Properties

    CreatedDateTime

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

    Declaration
    DateTimeOffset CreatedDateTime { get; }
    Property Value
    DateTimeOffset

    Descriptions

    Name of the term set for each language.

    Declaration
    ITermLocalizedDescriptionCollection Descriptions { get; }
    Property Value
    ITermLocalizedDescriptionCollection

    Id

    The Unique ID of the term.

    Declaration
    string Id { get; }
    Property Value
    System.String

    Labels

    Name of the term set for each language.

    Declaration
    ITermLocalizedLabelCollection Labels { get; }
    Property Value
    ITermLocalizedLabelCollection

    LastModifiedDateTime

    Last date and time of term modification. Read-only.

    Declaration
    DateTimeOffset LastModifiedDateTime { get; }
    Property Value
    DateTimeOffset

    Properties

    Properties on this term set

    Declaration
    ITermPropertyCollection Properties { get; }
    Property Value
    ITermPropertyCollection

    Relations

    Collection of terms relations

    Declaration
    ITermRelationCollection Relations { get; }
    Property Value
    ITermRelationCollection

    Set

    The term set of this term

    Declaration
    ITermSet Set { get; }
    Property Value
    ITermSet

    Terms

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

    Declaration
    ITermCollection Terms { get; }
    Property Value
    ITermCollection

    Methods

    AddLabelAndDescription(String, String, Boolean, String)

    Adds a term label and optional description for a given language. Call update to persist this change.

    Declaration
    void AddLabelAndDescription(string label, string languageTag, bool isDefault = false, string description = null)
    Parameters
    System.String label

    Label for the term

    System.String languageTag

    Language tag for the label and description

    System.Boolean isDefault

    Will this be the default label?

    System.String description

    Optional description to set

    AddProperty(String, String)

    Adds a property to the term'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

    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>>)
    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer