This documentation is archived and is not being maintained.

ImageField::AlternateText Property

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 property String^ AlternateText {
	String^ get ();
	void set (String^ value);
}

Property Value

Type: System::String
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.

NoteNote

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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

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

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