Class RegionalSettings

Defines the Regional Settings for a site

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

Constructors

RegionalSettings()

Constructor for RegionalSettings class

Declaration
public RegionalSettings()

Properties

AdjustHijriDays

The number of days to extend or reduce the current month in Hijri calendars

Declaration
public Int32 AdjustHijriDays { get; set; }
Property Value
Int32

AlternateCalendarType

The Alternate Calendar type that is used on the server

Declaration
public CalendarType AlternateCalendarType { get; set; }
Property Value
Microsoft.SharePoint.Client.CalendarType

CalendarType

The Calendar Type that is used on the server

Declaration
public CalendarType CalendarType { get; set; }
Property Value
Microsoft.SharePoint.Client.CalendarType

Collation

The Collation that is used on the site

Declaration
public Int32 Collation { get; set; }
Property Value
Int32

FirstDayOfWeek

The First Day of the Week used in calendars on the server

Declaration
public DayOfWeek FirstDayOfWeek { get; set; }
Property Value
DayOfWeek

FirstWeekOfYear

The First Week of the Year used in calendars on the server

Declaration
public Int32 FirstWeekOfYear { get; set; }
Property Value
Int32

LocaleId

The Locale Identifier in use on the server

Declaration
public Int32 LocaleId { get; set; }
Property Value
Int32

ShowWeeks

Defines whether to display the week number in day or week views of a calendar

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

Time24

Defines whether to use a 24-hour time format in representing the hours of the day

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

TimeZone

The Time Zone that is used on the server

Declaration
public Int32 TimeZone { get; set; }
Property Value
Int32

WorkDayEndHour

The the default hour at which the work day ends on the calendar that is in use on the server

Declaration
public WorkHour WorkDayEndHour { get; set; }
Property Value
WorkHour

WorkDays

The work days of Web site calendars

Declaration
public Int32 WorkDays { get; set; }
Property Value
Int32

WorkDayStartHour

The the default hour at which the work day starts on the calendar that is in use on the server

Declaration
public WorkHour WorkDayStartHour { get; set; }
Property Value
WorkHour

Methods

Equals(RegionalSettings)

Compares RegionalSettings object object based on AdjustHijriDays, AlternateCalendarType, CalendarType, Collation, FirstDayOfWeek, FirstWeekOfYear, LocaleId, ShowWeeks, Time24, TimeZone, WorkDayEndHour, WorkDays and WorkDayStartHour properties.

Declaration
public bool Equals(RegionalSettings other)
Parameters
RegionalSettings other

RegionalSettings object
Returns
System.Boolean

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

Equals(Object)

Compares object with RegionalSettings

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

Object that represents RegionalSettings
Returns
System.Boolean

true if the current object is equal to the RegionalSettings

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods