.NET Framework Class Library
DataTable..::.Locale Property

Gets or sets the locale information used to compare strings within the table.

Namespace:  System.Data
Assembly:  System.Data (in System.Data.dll)
Syntax

Visual Basic (Declaration)
Public Property Locale As CultureInfo
Visual Basic (Usage)
Dim instance As DataTable
Dim value As CultureInfo

value = instance.Locale

instance.Locale = value
C#
public CultureInfo Locale { get; set; }
Visual C++
public:
property CultureInfo^ Locale {
    CultureInfo^ get ();
    void set (CultureInfo^ value);
}
JScript
public function get Locale () : CultureInfo
public function set Locale (value : CultureInfo)

Property Value

Type: System.Globalization..::.CultureInfo
A CultureInfo that contains data about the user's machine locale. The default is the DataSet object's CultureInfo (returned by the Locale property) to which the DataTable belongs; if the table doesn't belong to a DataSet, the default is the current system CultureInfo.
Remarks

A CultureInfo represents the software preferences of a particular culture or community.

When used for string comparisons, the CultureInfo affects sorting, comparisons, and filtering.

NoteNote:

In columns that contain expressions, the InvariantCulture is used. The CurrentCulture is ignored.

Examples

The following example sets the CultureInfo through the Locale and prints the ISO language name.

Visual Basic
Private Sub ChangeCultureInfo(table As DataTable)
   ' Print the LCID  of the present CultureInfo.
   Console.WriteLine(table.Locale.LCID)

   ' Create a new CultureInfo for the United Kingdom.
   Dim myCultureInfo As CultureInfo = New CultureInfo("en-gb")
   table.Locale = myCultureInfo

   ' Print the new LCID.
   Console.WriteLine(table.Locale.LCID) 
End Sub
C#
private void ChangeCultureInfo(DataTable table)
{
    // Print the LCID  of the present CultureInfo.
    Console.WriteLine(table.Locale.LCID);

    // Create a new CultureInfo for the United Kingdom.
    CultureInfo myCultureInfo = new CultureInfo("en-gb");
    table.Locale = myCultureInfo;

    // Print the new LCID.
    Console.WriteLine(table.Locale.LCID); 
}
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

Other Resources

Tags :


Page view tracker