FormatSpecifier Property (Column)

Gets or sets the format that will be used to display data, in the column's cells.

Syntax

Visual Basic
C#

'Declaration
 
<CategoryAttribute("Appearance")>
<DescriptionAttribute("The format that will be used to display data, in the column's cells.")>
<TypeConverterAttribute("Xceed.Grid.Design.FormatSpecifierConverter,Xceed.Grid.v4.3.Design,Version=4.3.20076.12375,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")>
<AmbientValueAttribute("")>
<LocalizableAttribute(True)>
<ApplyToDesignerAttribute(False)>
Public Property FormatSpecifier As String

'Usage
 
Dim instance As Column
Dim value As String
 
instance.FormatSpecifier = value
 
value = instance.FormatSpecifier

[Category("Appearance")]
[Description("The format that will be used to display data, in the column's cells.")]
[TypeConverter("Xceed.Grid.Design.FormatSpecifierConverter,Xceed.Grid.v4.3.Design,Version=4.3.20076.12375,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")]
[AmbientValue("")]
[Localizable(true)]
[ApplyToDesigner(false)]
public string FormatSpecifier {get; set;}

Property Value

A string representing the format that will be used to display data.

Remarks

The list of values that can be passed to the FormatSpecifier property can be found in the "Format Specifiers and Format Providers" topic of the .NET Framework.

To reset the value of the FormatSpecifier property to its default value, DefaultFormatSpecifier, the ResetFormatSpecifier method must be called or the FormatSpecifier property set to a null reference (Nothing in Visual Basic).

Example

The following examples demonstrate how to set the FormatSpecifier property.

VisualBasic

' Short date grid.Columns( "Date1" ).FormatSpecifier = "d" ' Long date grid.Columns( "Date2" ).FormatSpecifier = "D" ' Currency grid.Columns( "Amount" ).FormatSpecifier = "c"

// Short date grid.Columns[ "Date1" ].FormatSpecifier = "d"; // Long date grid.Columns[ "Date2" ].FormatSpecifier = "D"; // Currency grid.Columns[ "Amount" ].FormatSpecifier = "c";

Requirements

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

Reference

Column Class
Column Members