This documentation is archived and is not being maintained.

AdCreatedEventArgs.AlternateText Property

Gets or sets the alternate text displayed in the AdRotator control when the advertisement image is unavailable. Browsers that support the ToolTips feature display this text as a ToolTip for the advertisement.

[Visual Basic]
Public Property AlternateText As String
[C#]
public string AlternateText {get; set;}
[C++]
public: __property String* get_AlternateText();
public: __property void set_AlternateText(String*);
[JScript]
public function get AlternateText() : String;
public function set AlternateText(String);

Property Value

The text displayed in place of the advertisement image if the image is unavailable. The default value is String.Empty.

Remarks

Use the AlternateText property to specify the text to display if the image specified in the ImageUrl property is not available. In browsers that support the ToolTips feature, this text also displays as a ToolTip for the advertisement.

A separate XML file contains the properties for the displayed advertisement. The AdRotator control automatically sets the AlternateText property with the corresponding alternate text entry in the XML file. This property may also be used to programmatically set the alternate text.

Example

[Visual Basic, C#, JScript] The following example demonstrates how to programmatically set the AlternateText property.

[Visual Basic] 
<%@ Page Language="VB" AutoEventWireup="True" %>

<html>
<head>

   <script runat="server">
   
       Sub AdCreated_Event(sender As Object, e As AdCreatedEventArgs) 
       
          e.AlternateText = "New Alternate Text Value"   
       
       End Sub      

   </script>
 
</head>
 
<body>
 
   <form runat="server">
 
      <h3>AdCreatedEventArgs AlternateText Example</h3>
 
      <asp:AdRotator id="AdRotator1" runat="server"
           AdvertisementFile = "Ads.xml"
           Target="_newwwindow"
           OnAdCreated="AdCreated_Event"/>
 
   </form>
 
</body>
</html>

[C#] 
<%@ Page Language="C#" AutoEventWireup="True" %>

<html>
<head>

   <script runat="server">
   
       void AdCreated_Event(Object sender, AdCreatedEventArgs e) 
       {

          e.AlternateText = "New Alternate Text Value";   
       
       }      

   </script>
 
</head>
 
<body>
 
   <form runat="server">
 
      <h3>AdCreatedEventArgs AlternateText Example</h3>
 
      <asp:AdRotator id="AdRotator1" runat="server"
           AdvertisementFile = "Ads.xml"
           Target="_newwwindow"
           OnAdCreated="AdCreated_Event"/>
 
   </form>
 
</body>
</html>

[JScript] 
<%@ Page Language="JScript" AutoEventWireup="True" %>

<html>
<head>

   <script runat="server">
   
       function AdCreated_Event(sender, e : AdCreatedEventArgs) 
       {

          e.AlternateText = "New Alternate Text Value";   
       
       }      

   </script>
 
</head>
 
<body>
 
   <form runat="server">
 
      <h3>AdCreatedEventArgs AlternateText Example</h3>
 
      <asp:AdRotator id="AdRotator1" runat="server"
           AdvertisementFile = "Ads.xml"
           Target="_newwwindow"
           OnAdCreated="AdCreated_Event"/>
 
   </form>
 
</body>
</html>

[Visual Basic, C#, JScript] The following example demonstrates how to format the XML file that contains the advertisement information. For additional information on the XML file, see the AdvertisementFile property of the AdRotator class.

<Advertisements>
 
 <Ad>
 <ImageUrl>image1.jpg</ImageUrl>
 <NavigateUrl>http://www.microsoft.com</NavigateUrl>
 <AlternateText>Microsoft Main Site</AlternateText>
 <Impressions>80</Impressions>
 <Keyword>Topic1</Keyword>
 <Caption>This is the caption for Ad#1</Caption> 
 </Ad>
 
 <Ad>
 <ImageUrl>image2.jpg</ImageUrl>
 <NavigateUrl>http://www.wingtiptoys.com</NavigateUrl>
 <AlternateText>Wing Tip Toys</AlternateText>
 <Impressions>80</Impressions>
 <Keyword>Topic2</Keyword>
 <Caption>This is the caption for Ad#2</Caption> 
 </Ad>
 
</Advertisements>

[C++] No example is available for C++. To view a Visual Basic, C#, or JScript example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

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

See Also

AdCreatedEventArgs Class | AdCreatedEventArgs Members | System.Web.UI.WebControls Namespace | AdRotator | ImageUrl | AdvertisementFile | String.Empty

Show: