Class Term

Inheritance
System.Object
BaseModel
Term
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class Term : BaseModel, IProvisioningTemplateDescendant

Constructors

Term()

Constructor for Term class

Declaration
public Term()

Term(Guid, String, Nullable<Int32>, List<Term>, List<TermLabel>, Dictionary<String, String>, Dictionary<String, String>)

Constructor for Term class

Declaration
public Term(Guid id, string name, int? language, List<Term> terms, List<TermLabel> labels, Dictionary<string, string> properties, Dictionary<string, string> localProperties)
Parameters
Guid id

Id of the term
System.String name

Name of the term
System.Nullable<System.Int32> language

Language of the term
List<Term> terms

Terms
List<TermLabel> labels

Labels of the term
Dictionary<System.String, System.String> properties

Properties of the term
Dictionary<System.String, System.String> localProperties

LocalProperties of the term

Properties

CustomSortOrder

Gets or sets the order of the term

Declaration
public int CustomSortOrder { get; set; }
Property Value
System.Int32

Description

Gets or sets the term description

Declaration
public String Description { get; set; }
Property Value
String

Id

Gets or sets the term id

Declaration
public Guid Id { get; set; }
Property Value
Guid

IsAvailableForTagging

Gets or sets the IsAvailableForTagging flag for the term

Declaration
public Boolean IsAvailableForTagging { get; set; }
Property Value
Boolean

IsDeprecated

Gets or sets the IsDeprecated flag for the term

Declaration
public Boolean IsDeprecated { get; set; }
Property Value
Boolean

IsReused

Gets or sets the IsReused flag for the term

Declaration
public Boolean IsReused { get; set; }
Property Value
Boolean

IsSourceTerm

Gets or sets the IsSourceTerm flag for the term

Declaration
public Boolean IsSourceTerm { get; set; }
Property Value
Boolean

Labels

Gets or sets term labels

Declaration
public TermLabelCollection Labels { get; }
Property Value
TermLabelCollection

Language

Gets or sets Language of the term

Declaration
public int? Language { get; set; }
Property Value
System.Nullable<System.Int32>

LocalProperties

Gets or sets local properties for the term

Declaration
public Dictionary<string, string> LocalProperties { get; }
Property Value
Dictionary<System.String, System.String>

Name

Gets or sets the term name

Declaration
public string Name { get; set; }
Property Value
System.String

Owner

Gets or sets the term owner

Declaration
public String Owner { get; set; }
Property Value
String

Properties

Gets or sets the properties of the term

Declaration
public Dictionary<string, string> Properties { get; }
Property Value
Dictionary<System.String, System.String>

SourceTermId

Gets or sets the term source id

Declaration
public Guid SourceTermId { get; set; }
Property Value
Guid

Terms

Gets or sets terms

Declaration
public TermCollection Terms { get; }
Property Value
TermCollection

Methods

Equals(Term)

Compares Term object based on Id, Name, Description, Language, Owner, IsAvailableForTagging, IsReused, IsSourceTerm, SourceTermId, IsDeprecated, CustomSortOrder, Labels, Terms, Properties and LocalProperties.

Declaration
public bool Equals(Term other)
Parameters
Term other

Term object
Returns
System.Boolean

true if the Term object is equal to the current object; otherwise, false.

Equals(Object)

Compares object with Term

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Object that represents Term
Returns
System.Boolean

true if the current object is equal to the Term

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods