Class WebSettings

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

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

Constructors

WebSettings()

Default Constructor

Declaration
public WebSettings()

WebSettings(Boolean, String, String)

Constructor

Declaration
public WebSettings(Boolean noCrawl, String requestAccessEmail, String welcomePage)
Parameters
Boolean noCrawl

Based on boolean values sets crawl to the site or subsite
String requestAccessEmail

E-mail address for request access
String welcomePage

Welcome page for site or subsite

WebSettings(Boolean, String, String, String, String, String, String)

Constructor

Declaration
public WebSettings(Boolean noCrawl, String requestAccessEmail, String welcomePage, String title, String description, String siteLogo, String alternateCSS)
Parameters
Boolean noCrawl

Based on boolean values sets crawl to the site or subsite
String requestAccessEmail

E-mail address for request access
String welcomePage

Welcome page for site or subsite
String title

Title of site or subsite
String description

Description of site or subsite
String siteLogo

Logo of site or subsite
String alternateCSS

Alternate css file location of site or subsite

Properties

AlternateCSS

The AlternateCSS of the Site, optional attribute.

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

AlternateUICultures

Defines the list of Alternate UI Cultures for the current web

Declaration
public AlternateUICultureCollection AlternateUICultures { get; set; }
Property Value
AlternateUICultureCollection

CommentsOnSitePagesDisabled

Defines whether the comments on site pages are disabled or not

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

CustomMasterPageUrl

The Custom MasterPage Url of the Site, optional attribute.

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

Description

The Description of the Site, optional attribute.

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

DisableAppViews

Defines whether disable PowerApps for the current web

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

DisableFlows

Defines whether disable flows for the current web

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

ExcludeFromOfflineClient

Defines whether to exclude the web from offline client

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

HorizontalQuickLaunch

Defines whether to enable the Horizontal QuickLaunch for the current web

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

HubSiteUrl

The Hub Site Url of the Site, optional attribute.

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

IsMultilingual

Defines whether to enable Multilingual capabilities for the current web

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

MasterPageUrl

The MasterPage Url of the Site, optional attribute.

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

MembersCanShare

Defines whether members can share content from the current web

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

NoCrawl

Defines whether the site has to be crawled or not

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

OverwriteTranslationsOnChange

Defines whether to OverwriteTranslationsOnChange on change for the current web

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

QuickLaunchEnabled

Enables or disables the QuickLaunch for the site

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

RequestAccessEmail

The email address to which any access request will be sent

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

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

SearchScope

Defines the SearchScope for the site

Declaration
public SearchScopes SearchScope { get; set; }
Property Value
SearchScopes

SiteLogoThumbnail

The SiteLogoThumbnail of the Site, optional attribute.

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

Title

The Title of the Site, optional attribute.

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

WelcomePage

Defines the Welcome Page (Home Page) of the site to which the Provisioning Template is applied.

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

Methods

Equals(WebSettings)

Compares web settings with other web settings

Declaration
public bool Equals(WebSettings other)
Parameters
WebSettings other

WebSettings object
Returns
System.Boolean

true if the WebSettings 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

WebSettings 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