206 lines
14 KiB
XML
206 lines
14 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="AdCreatedEventArgs" FullName="System.Web.UI.WebControls.AdCreatedEventArgs">
|
|
<TypeSignature Language="C#" Maintainer="auto" Value="public class AdCreatedEventArgs : EventArgs" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
|
<Base>
|
|
<BaseTypeName>System.EventArgs</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="E:System.Web.UI.WebControls.AdRotator.AdCreated" /> event is raised when the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control displays an advertisement on the page.</para>
|
|
<para>For a list of initial property values for an instance of <see cref="T:System.Web.UI.WebControls.AdCreatedEventArgs" />, see the <see cref="M:System.Web.UI.WebControls.AdCreatedEventArgs.#ctor(System.Collections.IDictionary)" /> constructor.</para>
|
|
<para>For more information about handling events, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides data for the <see cref="E:System.Web.UI.WebControls.AdRotator.AdCreated" /> event of the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control. This class cannot be inherited.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public AdCreatedEventArgs (System.Collections.IDictionary adProperties);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="adProperties" Type="System.Collections.IDictionary" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.WebControls.AdCreatedEventArgs" /> class.</para>
|
|
<para>The following table shows initial property values for an instance of <see cref="T:System.Web.UI.WebControls.AdCreatedEventArgs" />.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Property </para>
|
|
</term>
|
|
<description>
|
|
<para>Initial value </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.AdProperties" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>The value of the <paramref name="adProperties" /> parameter if the <paramref name="adProperties" /> parameter is not null; otherwise, an empty <see cref="T:System.Collections.IDictionary" />. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.AlternateText" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>If the <paramref name="adProperties" /> parameter is not null, the value in the <paramref name="adProperties" /> parameter that represents the alternate text; otherwise, <see cref="F:System.String.Empty" />. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.ImageUrl" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>If the <paramref name="adProperties" /> parameter is not null, the value in the <paramref name="adProperties" /> parameter that represents the URL of the image to display; otherwise, <see cref="F:System.String.Empty" />. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.NavigateUrl" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>If the <paramref name="adProperties" /> parameter is not null, the value in the <paramref name="adProperties" /> parameter that represents the URL to navigate to; otherwise, <see cref="F:System.String.Empty" />. </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.AdCreatedEventArgs" /> class.</para>
|
|
</summary>
|
|
<param name="adProperties">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.IDictionary" /> containing the advertisement properties from the XML file. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="AdProperties">
|
|
<MemberSignature Language="C#" Value="public System.Collections.IDictionary AdProperties { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.IDictionary</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>a <see cref="T:System.Collections.IDictionary" /></value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.AdProperties" /> property to get a <see cref="T:System.Collections.IDictionary" /> object that contains the advertisement properties for the currently displayed advertisement. The keys and values of the <see cref="T:System.Collections.IDictionary" /> object are of type <see cref="T:System.String" />.</para>
|
|
<para>The <see cref="T:System.Web.UI.WebControls.AdRotator" /> control randomly selects an advertisement each time the control is displayed on the Web page. The attributes for the selected advertisement are extracted from the advertisement XML file and stored in a <see cref="T:System.Collections.IDictionary" /> object. When the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control creates a new instance of the <see cref="T:System.Web.UI.WebControls.AdCreatedEventArgs" /> class, the <see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.AdProperties" /> property gets initialized with the <see cref="T:System.Collections.IDictionary" /> object.</para>
|
|
<para>Custom attributes about an advertisement, such as an advertisement caption, can also be included in the advertisement XML file. Use this property in the <see cref="M:System.Web.UI.WebControls.AdRotator.OnAdCreated(System.Web.UI.WebControls.AdCreatedEventArgs)" /> event handler to get the custom attributes.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a <see cref="T:System.Collections.IDictionary" /> object that contains all the advertisement properties for the currently displayed advertisement.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="AlternateText">
|
|
<MemberSignature Language="C#" Value="public string AlternateText { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.AlternateText" /> property to specify the text to display if the image specified in the <see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.ImageUrl" /> property is not available. In browsers that support the ToolTips feature, this text also appears as a ToolTip for the advertisement.</para>
|
|
<para>A separate XML file contains the properties for the displayed advertisement. The <see cref="T:System.Web.UI.WebControls.AdRotator" /> control automatically sets the <see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.AlternateText" /> property with the corresponding alternate text entry in the XML file. This property can also be used to programmatically set the alternate text.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the alternate text displayed in the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control when the advertisement image is unavailable. Browsers that support the ToolTips feature display this text as a ToolTip for the advertisement.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ImageUrl">
|
|
<MemberSignature Language="C#" Value="public string ImageUrl { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.ImageUrl" /> property to specify the URL of an image to display for an advertisement in the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control. You can use a relative or an absolute URL. A relative URL relates the location of the image to the location of the Web page or user control without specifying a complete path on the server. The path is relative to the location of the Web page. This makes it easier to move the entire site to another directory on the server without updating the path to the image in code. An absolute URL provides the complete path, so moving the site to another directory requires updating the code.</para>
|
|
<para>A separate XML file contains the properties for the displayed advertisement. The <see cref="T:System.Web.UI.WebControls.AdRotator" /> control automatically sets the <see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.ImageUrl" /> property with the corresponding image URL entry in the XML file containing the advertisement information. This property can also be used to programmatically set the image URL.</para>
|
|
<block subset="none" type="note">
|
|
<para>If you use an advertisement file and specify a relative URL for this property, the URL is relative to the directory that the advertisement file is located in. If you set this property directly with a relative URL, instead of using the advertisement file, the URL is relative to the directory of the page or user control that contains the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the URL of an image to display in the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="NavigateUrl">
|
|
<MemberSignature Language="C#" Value="public string NavigateUrl { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.NavigateUrl" /> property to specify the Web page to display when the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control is clicked. A common use for this property is to redirect the navigation, when the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control is clicked, to a page that can count the number of times the user clicked the advertisement before proceeding to the destination URL.</para>
|
|
<para>A separate XML file contains the properties for the displayed advertisement. The <see cref="T:System.Web.UI.WebControls.AdRotator" /> control automatically sets the <see cref="P:System.Web.UI.WebControls.AdCreatedEventArgs.NavigateUrl" /> property with the corresponding navigation URL entry in the XML file. This property can also be used to programmatically set the navigation URL.</para>
|
|
<block subset="none" type="note">
|
|
<para>If you use an advertisement file and specify a relative URL for this property, the URL is relative to the directory that the advertisement file is located in. If you set this property directly with a relative URL, instead of using the advertisement file, the URL is relative to the directory of the page or user control that contains the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the Web page to display when the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control is clicked.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |