通过

AdRotator Web 服务器控件声明性语法

  • 项目

更新：2007 年 11 月

在 Web 窗体页上显示公布标志。

<asp:AdRotator
    AccessKey="string"
    AdvertisementFile="uri"
    AlternateTextField="string"
    BackColor="color name|#dddddd"
    BorderColor="color name|#dddddd"
    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
        Inset|Outset"
    BorderWidth="size"
    CssClass="string"
    DataMember="string"
    DataSource="string"
    DataSourceID="string"
    Enabled="True|False"
    EnableTheming="True|False"
    EnableViewState="True|False"
    ForeColor="color name|#dddddd"
    Height="size"
    ID="string"
    ImageUrlField="string"
    KeywordFilter="string"
    hrefField="string"
    OnAdCreated="AdCreated event handler"
    OnDataBinding="DataBinding event handler"
    OnDataBound="DataBound event handler"
    OnDisposed="Disposed event handler"
    OnInit="Init event handler"
    OnLoad="Load event handler"
    OnPreRender="PreRender event handler"
    OnUnload="Unload event handler"
    runat="server"
    SkinID="string"
    Style="string"
    TabIndex="integer"
    Target="string|_blank|_parent|_search|_self|_top"
    ToolTip="string"
    Visible="True|False"
    Width="size"
/>

备注

AdRotator 控件在 Web 窗体页上显示公布标志。它显示由定位点控件内的 ImageUrl 元素指定的图像。在运行时，AdRotator 控件使用 <asp:HyperLink> 和 <asp:Image> 控件在 Web 窗体页上呈现该控件。浏览器将源图像的大小调整为 AdRotator 控件的尺寸，而无论其实际大小如何。

如果设置了 AdvertisementFile 属性，则根据 <Impressions> 元素的值从文件中选择一个公布。然后设置事件参数并引发 AdCreated 事件。如果未设置 AdvertisementFile 属性，则引发 AdCreated 事件时事件参数为空。事件参数用于呈现 AdRotator 控件，以便您可以修改从公布文件传递给该事件的值，或用您自己生成的值来设置这些值。通常情况下，使用从数据库中检索到的值来填充事件参数。

创建公布文件时，请考虑以下几点：

  • 公布文件中的 XML 必须格式良好。

  • AdRotator 控件只分析文件中的第一个 <Advertisements> 元素。该文件中的所有其他 <Advertisements> 元素均被忽略。

  • 可以向公布的 XML 说明中添加自定义元素。这些值被传递给 AdProperties 词典属性中的 AdCreated 事件。

可使用 AdCreated 事件直接在代码中选择公布或修改从公布文件中选定的公布的呈现方式。如果设置了公布文件，则在调用该事件时，AdCreated 事件的参数即已经设置为选定的公布。无论值是否已经设置，您都可以修改 ImageUrl、href 和 AlternateText 属性中的值，以修改 AdRotator 控件的呈现方式。添加到公布的 XML 说明中的自定义元素可用于 AdCreatedEventArgs.AdProperties 词典属性。

有关 AdRotator 控件的属性和事件的详细信息，请参见 AdRotator 文档。

广告文件格式

AdRotator 控件使用单独的 XML 公布文件存储公布信息，如要显示的图像的位置以及要链接到的页的 URL。AdRotator 控件的 AdvertisementFile 属性指定此文件的路径。

创建公布文件时，开始和结束 <Advertisements> 标记分别标记该文件的开头和结尾。开始和结束 <Ad> 标记划定每个公布的界线。所有公布都嵌套在开始和结束 <Advertisements> 标记之间。如果该文件包含多个 <Advertisements> 标记，则 AdRotator 控件只分析该文件中的第一组 <Advertisements> 标记。所有其他 <Advertisements> 标记都将被忽略。

每个公布的数据元素都嵌套在开始和结束 <Ad> 标记之间。尽管某些数据元素是预定义的（例如 ImageUrl 和 href），但是您可以将自定义元素放置在 <Ad> 标记之间。AdRotator 控件在分析该文件时将读取这些元素。然后将该信息传递给 AdProperties 词典属性中的 AdCreated 事件。

下表列出为 XML 公布文件预定义的数据元素。

元素

说明

<ImageUrl>

图像文件的绝对或相对 URL（可选）。

<href>

当用户单击公布时要链接到的页的 URL（可选）。

说明：

如果未设置此元素，则定位点标记上将不会呈现 HRef 属性。

<AlternateText>

当由 ImageUrl 属性指定的图像不可用时替换该图像的文本显示（可选）。

在某些浏览器中，该文本也显示为公布的 ToolTip。

<Keyword>

可用作筛选依据的公布类别（如“computers”）（可选）。

<Impressions>

指示公布在轮换安排中相对于文件中其他公布的重要性的数字（可选）。

数字越大，显示该公布的频率越高。XML 文件中所有 <Impressions> 值的总和不能超过 2,047,999,999。否则，AdRotator 控件将引发运行时异常。

以下内容显示 XML 公布文件的格式。

<Advertisements>
   <Ad>
      <ImageUrl>
         URL of image to display for Advertisement #1
      </ImageUrl>
      <href>
         URL of page to link to for Advertisement #1
      </href>
      <AlternateText>
         Text to show as a ToolTip for Advertisement #1
      </AlternateText>
      <Keyword>
         Keyword used to filter for Advertisement #1
      </Keyword>
      <Impressions>
         Relative importance of Advertisement #1
      </Impressions>
      <CustomInformation>
         Custom Data about Advertisement #1
      </CustomInformation>
   </Ad>
</Advertisements>

示例

下面的示例演示如何在 .aspx 文件中声明 AdRotator 控件。

<html>
 
   <head>
   </head>
 
<body>
   <form runat="server">
 
      <h3>AdRotator Example</h3>
 
      <asp:AdRotator id="AdRotator1"
           Target="_self"
           AdvertisementFile="Ads.xml"
           runat="server"/>
 
   </form>
</body>
 
</html>

下面的示例演示如何为 AdCreated 事件创建事件处理程序来以编程方式重写 href 属性的值。

<%@ Page Language="VB" AutoEventWireup="True" %>

<html>
<head>

   <script runat="server">
   
      Sub AdCreated_Event(sender As Object, e As AdCreatedEventArgs) 

         e.href = "https://www.microsoft.com"   
       
      End Sub      

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

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

<html>
<head>

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

         e.href = "https://www.microsoft.com";   
       
      }      

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

下面的示例说明如何格式化 XML 公布文件。

<Advertisements>
 
   <Ad>
      <ImageUrl>image1.jpg</ImageUrl>
      <href>https://www.microsoft.com</href>
      <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>
      <href>http://www.wingtiptoys.com</href>
      <AlternateText>Wing Tip Toys</AlternateText>
      <Impressions>80</Impressions>
      <Keyword>Topic2</Keyword>
      <Caption>This is the caption for Ad#2</Caption> 
   </Ad>
 
</Advertisements>

请参见

参考

AdRotator

其他资源

Web 服务器控件语法