This documentation is archived and is not being maintained.

HyperLinkColumn.Text Property

Gets or sets the text caption to display for the hyperlinks in the column.

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

[LocalizableAttribute(true)] 
public virtual string Text { get; set; }
/** @property */
public String get_Text ()

/** @property */
public void set_Text (String value)

public function get Text () : String

public function set Text (value : String)

Property Value

The text caption for the hyperlinks in the column. The default value is String.Empty.

Use the Text property to specify the text caption to display for the hyperlinks in the column.

NoteNote

When this property is set, all hyperlinks in the column share the same text caption.

To provide a separate text caption for each hyperlink in the column, use the DataTextField property.

NoteNote

The DataTextField and Text properties cannot both be set at the same time. If both properties are set, the DataTextField property takes precedence.

Caution noteCaution

Text is not HTML encoded before it is displayed in the HyperLinkColumn. This makes it possible to embed script within HTML tags in the text. If the values for this column come from user input, be sure to validate the values to reduce security vulnerabilities.

The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and ASP.NET Globalization and Localization.

The following example demonstrates how to use the Text property to specify the text caption for hyperlinks in the HyperLinkColumn. Notice that all hyperlinks in the column have the same text caption.

NoteNote

The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see ASP.NET Web Page Code Model.

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

<html>

<head>

   <script runat="server">

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

         dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32)));
         dt.Columns.Add(new DataColumn("PriceValue", typeof(Double)));
       
         for (int i = 0; i < 3; i++) 
         {
            dr = dt.NewRow();

            dr[0] = i;
            dr[1] = (Double)i * 1.23;

            dt.Rows.Add(dr);
         }

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

      void Page_Load(Object sender, EventArgs e) 
      {
         MyDataGrid.DataSource = CreateDataSource();
         MyDataGrid.DataBind();
      }

   </script>

</head>

<body>

   <form runat="server">

      <h3>HyperLinkColumn Example<h3>

      <asp:DataGrid id="MyDataGrid" 
           BorderColor="black"
           BorderWidth="1"
           GridLines="Both"
           AutoGenerateColumns="false"
           runat="server">

         <HeaderStyle BackColor="#aaaadd"/>

         <Columns>

            <asp:HyperLinkColumn
                 HeaderText="Select an Item"
                 NavigateUrl="detailspage.aspx"
                 Text="Click Me"
                 Target="_blank"/>
           
         </Columns>

      </asp:DataGrid>

   </form>

</body>
</html>


The following corresponding example is a sample Web Forms page to link to when a hyperlink in the previous example is clicked.

<%@ Page Language="C#" %>
<html>
<head>
 
</head>
<body>
 
   <h3>Details page for DataGrid</h3>
 
   Welcome to the new page.
 
</body>
</html>


Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0
Show: