Class SiteSettings

Domain Object used in the Provisioning template that defines a Section of Settings for the current Site Collection

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

Constructors

SiteSettings()

Default Constructor

Declaration
public SiteSettings()

Properties

AllowCreateDeclarativeWorkflow

Defines whether creation of declarative workflows is allowed in the site collection

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

AllowDesigner

Defines whether a designer can be used on this site collection

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

AllowSaveDeclarativeWorkflowAsTemplate

Defines whether saving of declarative workflows is allowed in the site collection

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

AllowSavePublishDeclarativeWorkflow

Defines whether publishing of declarative workflows is allowed in the site collection

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

SearchBoxInNavBar

Define if the suitebar search box should show or not

Declaration
public SearchBoxInNavBar SearchBoxInNavBar { get; set; }
Property Value
SearchBoxInNavBar

SearchCenterUrl

Defines the Search Center URL

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

ShowPeoplePickerSuggestionsForGuestUsers

Defines whether to show people picker suggestions for guest users in this site collection, optional attribute.

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

SocialBarOnSitePagesDisabled

Defines whether social bar is disabled on Site Pages in this site collection

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

Methods

Equals(SiteSettings)

Compares SiteSettings with other web settings

Declaration
public bool Equals(SiteSettings other)
Parameters
SiteSettings other

SiteSettings object
Returns
System.Boolean

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

Equals(Object)

Compares web settings with other web settings

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

SiteSettings object
Returns
System.Boolean

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

GetHashCode()

Gets hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns hash code in integer

Extension Methods