Декларативный синтаксис серверного веб-элемента управления AdRotator
Обновлен: Ноябрь 2007
Отображает рекламный баннер на странице 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"
/>
Заметки
Элемент управления AdRotator обеспечивает отображение рекламного баннера на странице Web Forms. Он отображает изображение, заданное элементом ImageUrl, в элементе управления точки привязки. Во время выполнения для визуализации элемента управления AdRotator на странице Web Forms используются элементы управления <asp:HyperLink> и <asp:Image>. Размер исходного изображения приводится обозревателем в соответствие с размерами элемента управления AdRotator независимо от его фактического размера.
Если свойство AdvertisementFile установлено, объявление из файла выбирается исходя из значения свойства <Impressions>. После этого устанавливаются аргументы событий и инициируется событие AdCreated. Если свойство AdvertisementFile не установлено, событие AdCreated инициируется с пустыми аргументами. Аргументы события используются при отображении элемента управления AdRotator, поэтому значения, переданные событию из файла объявлений, можно изменить или задать для них значения самостоятельно. Обычный сценарий заключается в заполнении аргументов события значениями, извлекаемыми из базы данных.
При создании файла объявлений необходимо учитывать следующие моменты.
XML в файле объявлений должен быть правильно сформирован.
Элемент управления AdRotator анализирует только первый элемент управления <Advertisements> в файле. Все прочие элементы <Advertisements>, встречающиеся в файле, игнорируются.
К XML-описанию объявления можно добавлять пользовательские элементы. Эти значения передаются событию AdCreated в свойстве словаря AdProperties.
Событие AdCreated можно использовать для выбора объявлений непосредственно в коде или для изменения визуализации объявлений, выбранных из файла объявлений. Если задан файл объявлений, к моменту вызова события AdCreated аргументы для него уже будут установлены. Независимо от того, установлены ли уже значения, отрисовку элемента управления AdRotator можно изменить, присвоив свойствам ImageUrl, href и AlternateText другие значения. Пользовательские элементы, добавленные в XML-описание объявления, доступны в свойстве словаря AdCreatedEventArgs.AdProperties.
Подробные сведения о свойствах и событиях элемента управления AdRotator см. в документации AdRotator.
Формат файла объявлений
Элемент управления AdRotator использует отдельный XML-файл объявлений для сохранения рекламных сведений, например расположения отображаемого изображения и URL-адреса связанной страницы. Путь к этому файлу указывается свойством AdvertisementFile элемента управления AdRotator.
При создании файла объявлений начало и конец файла помечаются, соответственно, открывающими и закрывающими тегами <Advertisements>. Границы каждого рекламного объявления устанавливаются с помощью открывающих и закрывающих тегов <Ad>. Все рекламные объявления вложены между открывающих и закрывающих тегов <Advertisements>. Если файл содержит несколько тегов <Advertisements>, элемент управления AdRotator анализирует только первый набор тегов <Advertisements>. Все остальные теги <Advertisements> игнорируются.
Элементы данных для каждого объявления вкладываются между открывающим и закрывающим тегами <Ad>. Хотя некоторые элементы данных (например ImageUrl и href) предварительно определены, между тегами <Ad> можно размещать пользовательские элементы. Эти элементы считываются элементом управления AdRotator при анализе файла. Данная информация затем передается событию AdCreated в свойстве словаря AdProperties.
В следующей таблице перечислены элементы данных, предварительно определяемые для XML-файла объявления.
Элемент |
Описание |
---|---|
<ImageUrl> |
Абсолютный или относительный URL-адрес для файла изображения (необязательно). |
<href> |
URL-адрес страницы, на которую дается ссылка, если пользователь выбирает щелкает рекламное объявление (необязательно).
Примечание.
Если этот элемент не установлен, свойство HRef не воспроизводится на теге точки привязки.
|
<AlternateText> |
Текст, отображаемый вместо изображения в случае, если изображение, заданное свойством ImageUrl, недоступно (необязательно). В некоторых обозревателях этот текст отображается также как ToolTip для объявления. |
<Keyword> |
Категория объявления (например, "компьютеры"), по которой можно производить фильтрацию (необязательно). |
<Impressions> |
Число, указывающее значимость объявления в графике ротации относительно других объявлений в файле (необязательно). Чем больше это число, тем чаще отображается объявление. Сумма всех значений <Impressions> в XML-файле не может превышать 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>
Пример
Далее приводится пример объявления элемента управления AdRotator в 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>
В следующем примере показано, как создать обработчик событий 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>