SPRegionalSettings.Locales property

Gets the collection of locales used in a server farm.

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

Syntax

'Declaration
Public ReadOnly Property Locales As SPLocaleCollection
    Get
'Usage
Dim instance As SPRegionalSettings
Dim value As SPLocaleCollection

value = instance.Locales

public SPLocaleCollection Locales { get; }

Property value

Type: Microsoft.SharePoint.SPLocaleCollection
An SPLocaleCollection object that represents the locales.

Examples

The following code example displays all the locales that are represented on the root Web site.

Dim siteCollection As New SPSite("https://localhost")
Try
    Dim rootWebSite As SPWeb = siteCollection.RootWeb
    Dim regionalsettings As SPRegionalSettings = rootWebSite.RegionalSettings
    Dim locales As SPLocaleCollection = regionalsettings.Locales

    Dim local As SPLocale
    For Each local In  locales
        Console.WriteLine(local.DisplayName)
    Next local

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

using (SPSite oSiteCollection = new SPSite("https://localhost"))
{
    using (SPWeb oWebsiteRoot = oSiteCollection.RootWeb)
    {
        SPRegionalSettings oRegionalSettings = oWebsiteRoot.RegionalSettings;
        SPLocaleCollection collLocalesAvailable = oRegionalSettings.Locales;

        foreach (SPLocale oLocaleAvailable in collLocalesAvailable)
        {
            Console.WriteLine(oLocaleAvailable.DisplayName);
        }
    }
}

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