AdRotator (Control de servidor Web)

Muestra una pancarta de anuncio en una página de formularios Web Forms.

<asp:AdRotator
     id="Value"
     AdvertisementFile="AdvertisementFile"
     KeyWordFilter="KeyWord"
     Target="Target"
     OnAdCreated="OnAdCreatedMethod"
     runat="server"/>

Formato de archivos de anuncio

El control AdRotator utiliza un archivo de anuncios XML independiente para almacenar la información sobre los anuncios, como la ubicación de la imagen que se va a mostrar y la dirección URL de la página a la que se va a vincular. La propiedad AdvertisementFile del control AdRotator especifica la ruta de acceso a este archivo.

Al crear el archivo de anuncios, las etiquetas <Advertisements> de apertura y de cierre marcan el inicio y el final del archivo, respectivamente. Las etiquetas <Ad> de apertura y de cierre delimitan cada anuncio. Todos los anuncios se anidan entre las etiquetas <Advertisements> de apertura y de cierre. Si el archivo contiene varias etiquetas <Advertisements>, el control AdRotator sólo analizará el primer conjunto de etiquetas <Advertisements> del archivo. Se omitirán todas las demás etiquetas <Advertisements>.

Los elementos de datos de cada anuncio se anidan entre las etiquetas <Ad> de apertura y de cierre. Si bien algunos elementos de datos se definen previamente (como ImageUrl y NavigateURL), se pueden colocar elementos personalizados entre las etiquetas <Ad>. El control AdRotator leerá esos elementos cuando analice el archivo. A continuación, se pasa esta información al evento AdCreated en la propiedad de diccionario AdProperties.

En la siguiente tabla se recogen los elementos de datos previamente definidos para el archivo de anuncios XML.

Elemento Descripción
<ImageUrl> Dirección URL absoluta o relativa de un archivo de imagen (opcional).
<NavigateURL> Dirección URL de una página a la que se va a vincular si el usuario hace clic en el anuncio (opcional).
Nota   Si no se configura este elemento, no se procesa la propiedad HRef en la etiqueta delimitadora.
<AlternateText> Texto que se muestra en lugar de la imagen cuando no está disponible la imagen especificada por la propiedad ImageUrl (opcional).

En algunos exploradores, este texto se muestra como una información sobre herramientas del anuncio

<Keyword> Categoría del anuncio (por ejemplo, "equipos") por la que se puede filtrar (opcional).
<Impressions> Número que indica la importancia del anuncio en la programación de la rotación en relación con los otros anuncios del archivo (opcional).

Cuanto mayor es el número, mayor será la frecuencia con la que aparecerá dicho anuncio. El total de todos los valores de Impressions en el archivo XML no puede ser superior a 2.047.999.999. Si lo es, AdRotator inicia una excepción de tiempo de ejecución.

En el siguiente ejemplo se muestra el formato del archivo de anuncios XML.

<Advertisements>
   <Ad>
      <ImageUrl> 
         URL of image to display for Advertisement #1
      </ImageUrl>
      <NavigateURL> 
         URL of page to link to for Advertisement #1
      </NavigateURL>
      <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>

Comentarios

El control AdRotator muestra una pancarta de anuncio en una página de formularios Web Forms. Muestra la imagen especificada por el elemento ImageUrl en un control delimitador. En tiempo de ejecución, el control AdRotator utiliza los controles <asp:HyperLink> y <asp:Image> para procesar el control en la página de formularios Web Forms. El explorador ajusta el tamaño de la imagen a las dimensiones del control AdRotator, independientemente de su tamaño real.

Si está establecida la propiedad AdvertisementFile, se selecciona un anuncio basándose en el valor de la propiedad Impressions del archivo. A continuación, se establecen los argumentos de evento y se inicia el evento AdCreated. Si no está establecida la propiedad AdvertisementFile, los argumentos de evento están vacíos cuando se inicia el evento AdCreated. Los argumentos de evento se utilizan para procesar el control AdRotator, de modo que se pueden modificar los valores pasados al evento desde el archivo de anuncios, o se pueden configurar con valores generados por el usuario. Una situación común consiste en rellenar los argumentos de evento con valores recuperados de una base de datos.

Cuando cree un archivo de anuncios, tenga en cuenta los siguientes extremos:

  • La sintaxis de los datos XML en el archivo de anuncios debe ser correcta.
  • El control AdRotator sólo analiza el primer elemento <Advertisements> del archivo. Se omiten todos los demás elementos <Advertisements> del archivo.
  • Se pueden agregar elementos personalizados a la descripción XML de un anuncio. Se pasan estos valores al evento AdCreated en la propiedad de diccionario AdProperties.

Se puede usar el evento AdCreated para seleccionar directamente los anuncios en el código o modificar el procesamiento de un anuncio seleccionado en el archivo de anuncios. Si se ha configurado un archivo de anuncios, los argumentos para el evento AdCreated ya están establecidos en el anuncio seleccionado cuando se llama al evento. Independientemente de que estén o no establecidos los valores, éstos pueden modificarse en las propiedades ImageUrl, NavigateURL y AlternateText con el fin de modificar el procesamiento del control AdRotator. Los elementos personalizados agregados a la descripción XML del anuncio están disponibles en la propiedad de diccionario AdCreatedEventArgs.AdProperties.

Para obtener más información sobre los eventos y propiedades del control AdRotator, vea la documentación referente a AdRotator (Clase).

Ejemplo

En el ejemplo siguiente se muestra cómo declarar un control AdRotator en un archivo .aspx.

<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>

En el siguiente ejemplo se muestra cómo crear un controlador de eventos para el evento AdCreated con el fin de reemplazar mediante programación el valor de la propiedad NavigateURL.

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

<html>
<head>

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

         e.NavigateURL = "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>
[C#]
<%@ Page Language="C#" AutoEventWireup="True" %>

<html>
<head>

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

         e.NavigateURL = "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>

En el siguiente ejemplo se muestra cómo aplicar formato a un archivo de anuncios XML.

<Advertisements>
 
   <Ad>
      <ImageUrl>image1.jpg</ImageUrl>
      <NavigateURL>https://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>

Vea también

Controles de servidor Web | AdRotator (Clase)