DataTable.Locale DataTable.Locale DataTable.Locale DataTable.Locale Property

Definition

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

public:
 property System::Globalization::CultureInfo ^ Locale { System::Globalization::CultureInfo ^ get(); void set(System::Globalization::CultureInfo ^ value); };
[System.Data.DataSysDescription("DataTableLocaleDescr")]
public System.Globalization.CultureInfo Locale { get; set; }
member this.Locale : System.Globalization.CultureInfo with get, set
Public Property Locale As CultureInfo
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.

Examples

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

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); 
}
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

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.

Note

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

Applies to

See Also