Syntaxe déclarative du contrôle serveur Web AdRotator
Mise à jour : novembre 2007
Affiche une bannière de publication sur une page Web Forms.
<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"
/>
Notes
Le contrôle AdRotator affiche une bannière de publication sur une page Web Forms. Il affiche l'image spécifiée par l'élément ImageUrl dans un contrôle d'ancrage. Au moment de l'exécution, le contrôle AdRotator utilise des contrôles <asp:HyperLink> et <asp:Image> pour restituer le contrôle sur la page Web Forms. L'image source est dimensionnée par le navigateur aux dimensions du contrôle AdRotator, indépendamment de sa taille réelle.
Si la propriété AdvertisementFile est définie, une publication est sélectionnée selon la valeur de l'élément <Impressions> dans le fichier. Ensuite, les arguments d'événement sont définis et l'événement AdCreated est déclenché. Si la propriété AdvertisementFile n'est pas définie, les arguments d'événement sont vides lorsque l'événement AdCreated est déclenché. Comme les arguments d'événement sont utilisés pour restituer le contrôle AdRotator, vous pouvez modifier les valeurs passées à l'événement à partir du fichier de publication, ou les définir à l'aide de valeurs que vous générez vous-même. Un scénario fréquent consiste à remplir les arguments d'événement avec les valeurs récupérées d'une base de données.
Lorsque vous créez un fichier de publication, prenez en compte les points suivants :
La syntaxe XML du fichier de publication doit être correctement formée.
Seul le premier élément <Advertisements> du fichier est analysé par le contrôle AdRotator. Tous les autres éléments <Advertisements> au sein du fichier sont ignorés.
Vous pouvez ajouter des éléments personnalisés à la description XML d'une publication. Ces valeurs sont passées à l'événement AdCreated dans la propriété de dictionnaire AdProperties.
Vous pouvez utiliser l'événement AdCreated pour sélectionner directement les publications dans votre code ou modifier le rendu d'une publication sélectionnée dans le fichier de publication. Si un fichier de publication est défini, les arguments de l'événement AdCreated ont déjà pour valeur la publicité sélectionnée lors de l'appel de l'événement. Que les valeurs soient déjà définies ou non, vous pouvez les modifier dans les propriétés ImageUrl, href et AlternateText pour modifier le rendu du contrôle AdRotator. Les éléments personnalisés ajoutés à la description XML de la publication sont disponibles dans la propriété de dictionnaire AdCreatedEventArgs.AdProperties.
Pour plus d'informations sur les propriétés et événements du contrôle AdRotator, consultez la documentation de AdRotator.
Format du fichier de publication
Le contrôle AdRotator utilise un fichier de publication XML distinct pour stocker les informations sur la publication, telles que l'emplacement de l'image à afficher et l'URL de la page vers laquelle le lien doit être créé. La propriété AdvertisementFile du contrôle AdRotator spécifie le chemin d'accès à ce fichier.
Lors de la création du fichier de publication, les balises <Advertisements> d'ouverture et de fermeture marquent respectivement le début et la fin du fichier. Les balises <Ad> d'ouverture et de fermeture délimitent chaque publication. Toutes les publications sont imbriquées entre les balises <Advertisements> d'ouverture et de fermeture. Si le fichier contient plusieurs balises <Advertisements>, seul le premier jeu de balises <Advertisements> du fichier sera analysé par le contrôle AdRotator. Toutes les autres balises <Advertisements> seront ignorées.
Les éléments de données de chaque publication sont imbriqués entre les balises <Ad> d'ouverture et de fermeture. Même si certains éléments de données sont prédéfinis (tels que ImageUrl et href), vous pouvez placer des éléments personnalisés entre les balises <Ad>. Ces éléments sont lus par le contrôle AdRotator quand il analyse le fichier. Les informations sont ensuite passées à l'événement AdCreated dans la propriété de dictionnaire AdProperties.
Le tableau suivant répertorie les éléments de données prédéfinis pour le fichier de publication XML.
Élément |
Description |
||
|---|---|---|---|
<ImageUrl> |
URL absolue ou relative vers un fichier image (facultatif). |
||
<href> |
URL d'une page à laquelle accéder si l'utilisateur clique sur la publication (facultatif).
|
||
<AlternateText> |
Texte affiché au lieu de l'image lorsque l'image spécifiée par la propriété ImageUrl n'est pas disponible (facultatif). Dans certains navigateurs, ce texte apparaît également comme un ToolTip pour la publication. |
||
<Keyword> |
Catégorie sur laquelle vous pouvez filtrer la publication (facultatif) : « ordinateurs », par exemple. |
||
<Impressions> |
Nombre qui indique l'importance de la publication dans la planification de rotation par rapport aux autres publications du fichier (facultatif). Plus le nombre est élevé, plus la publication est affichée. Le total de toutes les valeurs <Impressions> indiquées dans le fichier XML ne peut pas excéder 2 047 999 999. S'il dépasse ce nombre, le contrôle AdRotator lève une exception d'exécution. |
.gif "Remarque")
Remarque :Le code suivant montre le format du fichier de publication 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>
Exemple
L'exemple suivant montre comment déclarer un contrôle AdRotator dans un fichier .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>
L'exemple suivant montre comment créer un gestionnaire d'événements de l'événement AdCreated afin de substituer par programme la valeur de la propriété 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>
Le code suivant montre comment mettre en forme un fichier de publication 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>