This documentation is archived and is not being maintained.

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)

'Declaration
Public Property Locale As CultureInfo
'Usage
Dim instance As DataTable
Dim value As CultureInfo

value = instance.Locale

instance.Locale = value
/** @property */
public CultureInfo get_Locale ()

/** @property */
public void set_Locale (CultureInfo value)

public function get Locale () : CultureInfo

public function set Locale (value : CultureInfo)

Not applicable.

Property Value

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.

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

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

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

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Show: