This documentation is archived and is not being maintained.

ImageField.AlternateText Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the alternate text displayed for an image in the ImageField object.

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

public virtual string AlternateText { get; set; }
/** @property */
public String get_AlternateText ()

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

public function get AlternateText () : String

public function set AlternateText (value : String)

Property Value

The alternate text for an image displayed in the ImageField object. The default is an empty string (""), which indicates that this property is not set.

Use the AlternateText property to specify the alternate text for the images displayed in an ImageField object. The alternate text is displayed when an image cannot be loaded or is unavailable. Browsers that support the ToolTips feature also display this text as a ToolTip.


When this property is set, all images displayed in an ImageField object share the same alternate text. As an alternative, you can bind the alternate text to a field in a data source by setting the DataAlternateTextField property instead of this property. This allows you to have different alternate text for each image displayed. If both the AlternateText and DataAlternateTextField properties are set, the DataAlternateTextField property takes precedence.

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 AlternateText property to specify the alternate text for all images displayed in an ImageField object.

<%@ Page language="C#" %>

    <form runat="server">
      <h3>ImageField Example</h3>
      <asp:gridview id="EmployeesGrid"

          <asp:imagefield dataimageurlfield="PhotoPath"
            alternatetext="Employee Photo"
            nulldisplaytext="No image on file."
          <asp:boundfield datafield="FirstName"
            headertext="First Name"/>
          <asp:boundfield datafield="LastName"
            headertext="Last Name"/>
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="EmployeeSource"
        selectcommand="Select [EmployeeID], [LastName], [FirstName], [PhotoPath] From [Employees]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 

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