SPRegionalSettings Class
The SPRegionalSettings class represents regional settings that are used on the server running Microsoft Windows SharePoint Services.
System.Object
Microsoft.SharePoint.SPRegionalSettings
Public Methods
The following table shows the public methods of the SPRegionalSettings class and a brief description of each.
| Name | Description |
|---|---|
| GetDefaultCollation | Returns the default collation used on the site based on the specified locale identifier (LCID). |
| GetDefaultTime24 | Returns a Boolean value that specifies whether the 24-hour time format is the default format for representing time on the site. |
| GetTimeZoneID | Returns the ID of the time zone used on the site based on the specified time zone settings. |
Public Properties
The following table shows the public properties of the SPRegionalSettings class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| AdjustHijriDays | Int16 | Gets or sets the number of days to extend or reduce the current month in Hijri calendars. |
| AM | String | Gets the string that is used to represent A.M. in Windows SharePoint Services based on the locale of the server. |
| CalendarType | Int16 | Gets or sets the calendar type used in Windows SharePoint Services based on the locale of the server. |
| Collation | Int16 | Gets or sets the collation used on the site. |
| CollationLCID | UInt32 | Gets the locale identifier (LCID) for the collation rules used on the site. |
| DateFormat | UInt32 | Gets the date format used in Windows SharePoint Services based on the locale of the server. |
| DateSeparator | String | Gets the separator used for dates in Windows SharePoint Services based on the locale of the server. |
| DecimalSeparator | String | Gets the separator used in Windows SharePoint Services for decimals based on the locale of the server. |
| DigitGrouping | String | Gets the separator used in grouping digits. |
| FirstDayOfWeek | UInt32 | Gets an unsigned integer that indicates the first day of the week used for calendar views in Windows SharePoint Services based on the locale of the server. |
| InstalledLanguages | Microsoft.SharePoint.SPLanguageCollection | Gets the collection of languages used in a server farm. |
| Locales | Microsoft.SharePoint.SPLocaleCollection | Gets the collection of locales used in a server farm. |
| NegativeSign | String | Gets the symbol used to represent a negative sign (-) based on the locale of the server. |
| NegNumberMode | UInt32 | Gets the negative number mode used for displaying negative numbers in calculated fields based on the locale of the server. |
| PM | String | Gets the string that is used to represent P.M. based on the locale of the server. |
| PositiveSign | String | Gets the symbol used to represent a positive sign (+) based on the locale of the server. |
| ServerLanguage | Microsoft.SharePoint.SPLanguage | Gets the language used on the virtual server. |
| ThousandSeparator | String | Gets the thousand separator used for numbers based on the locale of the server. |
| Time24 | Boolean | Gets or sets a Boolean value that specifies whether to use a 24-hour time format in representing the hours of the day. |
| TimeMarkerPosition | UInt32 | Gets a value that indicates whether A.M. and P.M. appear before or after the time string. |
| TimeSeparator | String | Gets the time separator used in representing time based on the locale of the server. |
| TimeZone | Microsoft.SharePoint.SPTimeZone | Gets the time zone used on the virtual server. |
| TimeZones | Microsoft.SharePoint.SPTimeZoneCollection | Gets the collection of time zones used in a server farm. |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.
Remarks
Use the RegionalSettings property of the SPWeb class to return an SPRegionalSettings object that represents the regional settings for a site.
Requirements
Namespace: Microsoft.SharePoint
Platforms: Microsoft Windows Server 2003
Assembly: Windows SharePoint Services (in Microsoft.SharePoint.dll)
Security: Code Access Security