Share via


SPRegionalSettings.CalendarType property

Gets or sets the calendar type that is used on the server.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Property CalendarType As Short
    Get
    Set
'Usage
Dim instance As SPRegionalSettings
Dim value As Short

value = instance.CalendarType

instance.CalendarType = value
public short CalendarType { get; set; }

Property value

Type: System.Int16
A 16-bit integer that specifies the type of calendar.

Remarks

The CalendarType property accepts the following integer values:

  • 0 — None

  • 1 — Gregorian

  • 3 — Japanese Emperor Era

  • 5 — Korean Tangun Era

  • 6 — Hijri

  • 7 — Buddhist

  • 8 — Hebrew Lunar

  • 9 — Gregorian Middle East French Calendar

  • 10 — Gregorian Arabic Calendar

  • 11 — Gregorian Transliterated English Calendar

  • 12 — Gregorian Transliterated French Calendar

  • 16 — Saka Era

If the property is set to any other value, the Gregorian calendar is used.

Examples

The following code example sets the calendar type of a Web site to Hijri and increases the number of days by 2.

Dim siteCollection As New SPSite("https://localhost")
Try
    Dim rootWebSite As SPWeb = siteCollection.RootWeb
    Dim regionalsettings As SPRegionalSettings = rootWebSite.RegionalSettings
    regionalsettings.CalendarType = 6
    regionalsettings.AdjustHijriDays = 2

    rootWebSite.Update()
    rootWebSite.Dispose()
Finally
    siteCollection.Dispose()
End Try

[C#]

using (SPSite oSiteCollection = new SPSite("https://localhost"))
{
    using(SPWeb oWebsiteRoot = oSiteCollection.RootWeb)
    {
        SPRegionalSettings oRegionalSettings = oWebsiteRoot.RegionalSettings; 
        oRegionalSettings.CalendarType = 6; 
        oRegionalSettings.AdjustHijriDays = 2; 

        oWebsiteRoot.Update(); 
    }
}

Note

Certain objects implement the IDisposable interface, and you must avoid retaining these objects in memory after they are no longer needed. For information about good coding practices, see Disposing Objects.

See also

Reference

SPRegionalSettings class

SPRegionalSettings members

Microsoft.SharePoint namespace