KeywordFilter Property

Sets or returns a category keyword that you can use to filter advertisements from an advertisement file. The default is empty.

public string KeywordFilter {
   get,
   set
}

Remarks

If no match for the KeywordFilter property exists in the XML advertisement file, the browser renders a blank image and generates a trace warning.

Example

The following example demonstrates how to use the KeyWordFilter property to set the preference from a collection of images in the file referred by the AdvertisementFile property.

Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
  
' It's taken from <keyword> of xml file to filter the image.
' Allows only Travel sites to be displayed in the rotator.
Adrotator1.AdvertisementFile="ads3.xml"
Adrotator1.KeywordFilter = "TravelSites"
Adrotator1.Visible = True

End Sub

// ads3.xml file
<?xml version="1.0" ?>
<Advertisements>
    <Ad>
        <ImageUrl>msaui.gif</ImageUrl>
        <NavigateURL>https://www.microsoft.com</NavigateURL>
        <AlternateText>Home Page</AlternateText>
        <Keyword>HomeSites</Keyword>
        <Impressions>80</Impressions>
    </Ad>
    <Ad>
        <ImageUrl>msaui2.gif</ImageUrl>
        <NavigateURL>http://www.margiestravel.com/</NavigateURL>
        <AlternateText>Travel page</AlternateText>
        <Keyword>TravelSites</Keyword>
        <Impressions>80</Impressions>
    </Ad>
</Advertisements>

 [C#]

// ASPX file
public void Page_Load(Object source, EventArgs e)
{
   // It's taken from <keyword> of xml file to filter the image.
   // Allows only Travel sites to be displayed in the rotator.
   Adrotator1.AdvertisementFile="ads3.xml";
   Adrotator1.KeywordFilter = "TravelSites";
   Adrotator1.Visible = true;
}
// ads3.xml file
<?xml version="1.0" ?>
<Advertisements>
    <Ad>
        <ImageUrl>msaui.gif</ImageUrl>
        <NavigateURL>https://www.microsoft.com</NavigateURL>
        <AlternateText>Home Page</AlternateText>
        <Keyword>HomeSites</Keyword>
        <Impressions>80</Impressions>
    </Ad>
    <Ad>
        <ImageUrl>msaui2.gif</ImageUrl>
        <NavigateURL>http://www.margiestravel.com/</NavigateURL>
        <AlternateText>Travel page</AlternateText>
        <Keyword>TravelSites</Keyword>
        <Impressions>80</Impressions>
    </Ad>
</Advertisements>

See Also

AdRotator Class (Web Forms)

Applies to: AdRotator Class