This documentation is archived and is not being maintained.

AdCreatedEventArgs.ImageUrl Property

Gets or sets the URL of an image to display in the AdRotator control.

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

Property Value

The URL of an image to display in the AdRotator control. The default value is String.Empty.

Remarks

Use the ImageUrl property to specify the URL of an image to display for an advertisement in the AdRotator control. You can use a relative or an absolute URL. A relative URL relates the location of the image to the location of the Web page or user control without specifying a complete path on the server. The path is relative to the location of the Web page. This makes it easier to move the entire site to another directory on the server without updating the path to the image in code. An absolute URL provides the complete path, so moving the site to another directory requires updating the code.

A separate XML file contains the properties for the displayed advertisement. The AdRotator control automatically sets the ImageUrl property with the corresponding image URL entry in the XML file containing the advertisement information. This property may also be used to programmatically set the image URL.

Note   If you use an advertisement file and specify a relative URL for this property, the URL is relative to the directory that the advertisement file is located in. If you set this property directly with a relative URL, instead of using the advertisement file, the URL is relative to the directory of the page or user control that contains the AdRotator control.

Example

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

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

<html>
<head>

   <script runat="server">
   
       Sub AdCreated_Event(sender As Object, e As AdCreatedEventArgs) 
       
          e.ImageUrl = "images/newimage.jpg"   
       
       End Sub      

   </script>
 
</head>
 
<body>
 
   <form runat="server">
 
      <h3>AdCreatedEventArgs ImageUrl 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.ImageUrl = "images/newimage.jpg";   
       
       }      

   </script>
 
</head>
 
<body>
 
   <form runat="server">
 
      <h3>AdCreatedEventArgs ImageUrl 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 : Object, e : AdCreatedEventArgs)
       {

          e.ImageUrl = "images/newimage.jpg";   
       
       }      

   </script>
 
</head>
 
<body>
 
   <form runat="server">
 
      <h3>AdCreatedEventArgs ImageUrl 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 | AdvertisementFile | String.Empty

Show: