Export (0) Print
Expand All

ButtonColumn.DataTextFormatString Property

Gets or sets the string that specifies the display format for the caption in each button.

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public virtual string DataTextFormatString { get; set; }

Property Value

Type: System.String
The string that specifies the display format for the caption in each button. The default is an empty string ("").

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

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


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.


This value can be set only 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

Displays numeric values in


Currency format.


Decimal format.


Scientific (exponential) format.


Fixed format.


General format.


Number format.


Hexadecimal format.


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 value of this property is stored in view state.

For more information on formatting strings, see Formatting Types.

The following code example demonstrates how to use the DataTextFormatString property to display the caption of each button in the ButtonColumn object in currency format.

<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<html xmlns="http://www.w3.org/1999/xhtml" >
   <script language="c#" runat="server">

      ICollection CreateDataSource() 
         DataTable dt = new DataTable();
         DataRow dr;

         dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32)));
         dt.Columns.Add(new DataColumn("StringValue", typeof(string)));
         dt.Columns.Add(new DataColumn("CurrencyValue", typeof(double)));

         for (int i = 0; i < 9; i++) 
            dr = dt.NewRow();

            dr[0] = i;
            dr[1] = "Item " + i.ToString();
            dr[2] = 1.23 * (i + 1);


         DataView dv = new DataView(dt);
         return dv;

      void Page_Load(Object sender, EventArgs e) 
         if (!IsPostBack) 
            // Load this data only once.
            ItemsGrid.DataSource= CreateDataSource();

      void Grid_CartCommand(Object sender, DataGridCommandEventArgs e) 

         // e.Item is the table row where the command is raised.
         // For bound columns, the value is stored in the Text property of the TableCell.
         Label1.Text = "You selected: " + e.Item.Cells[0].Text + ".";        



<head runat="server">
    <title>ButtonColumn Example</title>

   <form id="form1" runat="server">

      <h3>ButtonColumn Example</h3>

      <b>Product List</b>

      <asp:DataGrid id="ItemsGrid"

         <HeaderStyle BackColor="#00aaaa">



                 CommandName="AddToCart" /> 



      <br /><br />

      <asp:Label id="Label1" runat="server"/>



.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

© 2014 Microsoft