This documentation is archived and is not being maintained.

ListControl.DataTextFormatString Property

Gets or sets the formatting string used to control how data bound to the list control is displayed.

[Visual Basic]
Public Overridable Property DataTextFormatString As String
public virtual string DataTextFormatString {get; set;}
public: __property virtual String* get_DataTextFormatString();
public: __property virtual void set_DataTextFormatString(String*);
public function get DataTextFormatString() : String;
public function set DataTextFormatString(String);

Property Value

The formatting string for data bound to the control. The default value is String.Empty.


Use the DataTextFormatString property to provide a custom display format for the caption of the command buttons in the column.

The data format string consists of two parts, separated by a colon, in the form { A: Bxx }. For example, the formatting string {0:F2} would format the cell to display a fixed point number with two decimal places.

Note   The entire string must be enclosed in braces to indicate that it is a format string and not a literal string. Any text outside the braces is displayed as literal text.

The value before the colon (A in the general example) specifies the parameter index in a zero-based list of parameters.

Note   This value can only be set to 0 because there is only one value in each cell.

The character after the colon (B in the general example) specifies the format to display the value in. The following table lists the common formats.

Format character Description
C Displays numeric values in currency format.
D Displays numeric values in decimal format.
E Displays numeric values in scientific (exponential) format.
F Displays numeric values in fixed format.
G Displays numeric values in general format.
N Displays numeric values in number format.
X Displays numeric values in hexadecimal format.
Note   The format character is not case-sensitive, except for X, which displays the hexadecimal characters in the case specified.

The value after the format character (xx in the general example) specifies the number of significant digits or decimal places to display.

The following table contains examples of formatting strings and the results. It assumes standard English settings.

Numeric Value Format String Result
12345.6789 "{0:C}" $12,345.68
-12345.6789 "{0:C}" ($12,345.68)
12345 "{0:D}" 12345
12345 "{0:D8}" 00012345
12345.6789 "{0:E}" 1234568E+004
12345.6789 "{0:E10}" 1.2345678900E+004
12345.6789 "{0:F}" 12345.68
12345.6789 "{0:F0}" 12346
12345.6789 "{0:G}" 12345.6789
123456789 "{0:G7}" 1.234568E8
12345.6789 "{0:N}" 12,345.68
123456789 "{0:N4}" 123,456,789.0000
12345.6789 "Total: {0:C}" Total: $12345.68

For more information on formatting strings, see Formatting Overview.


Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

ListControl Class | ListControl Members | System.Web.UI.WebControls Namespace | Formatting Overview