Class TermGroup

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

Constructors

TermGroup()

Constructor for TermGroup class

Declaration
public TermGroup()

TermGroup(Guid, String, List<TermSet>, Boolean, IEnumerable<User>, IEnumerable<User>)

Constructor for TermGroup class

Declaration
public TermGroup(Guid id, string name, List<TermSet> termSets, bool siteCollectionTermGroup = false, IEnumerable<User> contributors = null, IEnumerable<User> managers = null)
Parameters
Guid id

Id of the term group
System.String name

Name of the term group
List<TermSet> termSets

Termsets related to term group
System.Boolean siteCollectionTermGroup

Specify whether it is site collection term group or not
IEnumerable<User> contributors

TermGroup Contributors
IEnumerable<User> managers

TermGroup Managers

Properties

Contributors

List of TermGroup Contributors

Declaration
public UserCollection Contributors { get; }
Property Value
UserCollection

Description

The Description of the TermGroup

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

Id

The ID of the TermGroup

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

Managers

List of TermGroup Managers

Declaration
public UserCollection Managers { get; }
Property Value
UserCollection

Name

The Name of the TermGroup

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

SiteCollectionTermGroup

Is this a site collection term group

Declaration
public bool SiteCollectionTermGroup { get; set; }
Property Value
System.Boolean

TermSets

The collection of TermSet items in the TermGroup

Declaration
public TermSetCollection TermSets { get; }
Property Value
TermSetCollection

UpdateBehavior

If the TermGroup already exists on target, this attribute defines whether the TermGroup will be overwritten or skipped.

Declaration
public TermGroupUpdateBehavior UpdateBehavior { get; set; }
Property Value
TermGroupUpdateBehavior

Methods

Equals(TermGroup)

Compares TermGroup object based on Id, Name, Description and TermSets.

Declaration
public bool Equals(TermGroup other)
Parameters
TermGroup other

TermGroup object
Returns
System.Boolean

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

Equals(Object)

Compares object with TermGroup

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

Object that represents TermGroup
Returns
System.Boolean

true if the current object is equal to the TermGroup

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods