Class SubSite

Inheritance
System.Object
BaseHierarchyModel
SubSite
TeamNoGroupSubSite
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public abstract class SubSite : BaseHierarchyModel, IProvisioningHierarchyDescendant

Constructors

SubSite()

Declaration
public SubSite()

Properties

Description

Defines the Description for the Site

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

ProvisioningId

Defines an optional ID in the sequence for use in tokens.

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

QuickLaunchEnabled

Defines if the Quick Launch is enabled or not

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

Sites

Defines the list of sub-sites, if any

Declaration
public SubSiteCollection Sites { get; }
Property Value
SubSiteCollection

Templates

Defines the list of Provisioning Templates to apply to the sub-site, if any

Declaration
public List<string> Templates { get; }
Property Value
List<System.String>

Theme

Defines the Theme to apply to the SiteCollection

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

Title

Title of the site

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

UseSamePermissionsAsParentSite

Defines whether to use the same permissions of the parent site or not

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

Methods

Equals(SubSite)

Compares SubSite object based on its properties

Declaration
public bool Equals(SubSite other)
Parameters
SubSite other

SubSite object
Returns
System.Boolean

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

Equals(Object)

Compares object with SubSite

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

Object that represents SubSite
Returns
System.Boolean

true if the current object is equal to the SubSite

EqualsInherited(SubSite)

Returns the HashCode of the members of any inherited type

Declaration
protected abstract bool EqualsInherited(SubSite other)
Parameters
SubSite other

Returns
System.Boolean

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

GetInheritedHashCode()

Returns the HashCode of the members of any inherited type

Declaration
protected abstract int GetInheritedHashCode()
Returns
System.Int32

Extension Methods