This documentation is archived and is not being maintained.

DataGridTextBoxColumn.Format Property

Gets or sets the character(s) that specify how text is formatted.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public string Format { get; set; }

Property Value

Type: System.String
The character or characters that specify how text is formatted.

The Format property specifies how values are displayed in the column. For example, set the property to "c" to specify that the values will be formatted as the local currency. The CultureInfo for the computer is used to determine the actual currency format. The values are automatically unformatted to the native type when data is changed.

For more information about formatting characters, see Formatting Types and Custom Date and Time Format Strings.

The format you apply should be appropriate to the data type. For example, if the data is numeric in nature use one of the numeric format strings.

You can change the CultureInfo for a DataGridTextBoxColumn by setting the FormatInfo property to a new CultureInfo instance constructed with an appropriate culture ID.

To set the CultureInfo for the application, set the CurrentCulture property of the Application object to a new CultureInfo instance constructed with an appropriate culture ID.

The following example creates a new CultureInfo object and assigns it to the FormatInfo property of a DataGridTextBoxColumn object. The example also sets the Format property to "c" to specify that the column should display values as currency.

private void ChangeColumnCultureInfo(){
   /* Create a new CultureInfo object using the 
   the locale ID for Italy. */
   System.Globalization.CultureInfo ItalyCultureInfo= 
   new CultureInfo(0x0410);

   /* Cast a column that holds numeric values to the   
   DataGridTextBoxColumn type, and set the FormatInfo
   property to the new CultureInfo object. */
   DataGridTextBoxColumn myGridTextBoxColumn = 
   (DataGridTextBoxColumn) myDataGrid.TableStyles["Orders"].
   myGridTextBoxColumn.FormatInfo = ItalyCultureInfo;
   myGridTextBoxColumn.Format = "c";

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.