216 lines
15 KiB
XML
216 lines
15 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<Type Name="CookieParameter" FullName="System.Web.UI.WebControls.CookieParameter">
|
||
|
|
<TypeSignature Language="C#" Value="public class CookieParameter : System.Web.UI.WebControls.Parameter" />
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyName>System.Web</AssemblyName>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Base>
|
||
|
|
<BaseTypeName>System.Web.UI.WebControls.Parameter</BaseTypeName>
|
||
|
|
</Base>
|
||
|
|
<Interfaces />
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.ComponentModel.DefaultProperty("CookieName")</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>You can use the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> class to bind the value of a client-side HTTP cookie passed as part of an HTTP request to a parameter used by ASP.NET data source controls. </para>
|
||
|
|
<para>The <see cref="T:System.Web.UI.WebControls.CookieParameter" /> class provides the <see cref="P:System.Web.UI.WebControls.CookieParameter.CookieName" /> property, which identifies the name of the <see cref="T:System.Web.HttpCookie" /> object to bind to, in addition to those inherited from the <see cref="T:System.Web.UI.WebControls.Parameter" /> class. The <see cref="T:System.Web.UI.WebControls.CookieParameter" /> class attempts to bind to the named cookie every time the <see cref="M:System.Web.UI.WebControls.CookieParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method is called.</para>
|
||
|
|
<block subset="none" type="note">
|
||
|
|
<para>Controls that bind data to the parameter might throw an exception if a <see cref="T:System.Web.UI.WebControls.CookieParameter" /> object is specified, but no corresponding cookie is passed with the HTTP request. Similarly, they might display no data if the cookie is passed with null. Set the <see cref="P:System.Web.UI.WebControls.Parameter.DefaultValue" /> property to avoid these situations where appropriate.</para>
|
||
|
|
</block>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Binds the value of a client-side HTTP cookie to a parameter object. The parameter can be used in a parameterized query or command to select, filter, or update data.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<Members>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="public CookieParameter ();" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>A <see cref="T:System.Web.UI.WebControls.CookieParameter" /> object created with the <see cref="M:System.Web.UI.WebControls.CookieParameter.#ctor" /> constructor is initialized with default values for all its properties. The <see cref="P:System.Web.UI.WebControls.CookieParameter.CookieName" /> property is initialized to <see cref="F:System.String.Empty" />. Additionally, the <see cref="P:System.Web.UI.WebControls.Parameter.Name" /> property is initialized to <see cref="F:System.String.Empty" />, the <see cref="P:System.Web.UI.WebControls.Parameter.Type" /> property is initialized to <see cref="F:System.TypeCode.Object" />, the <see cref="P:System.Web.UI.WebControls.Parameter.Direction" /> property is initialized to <see cref="F:System.Data.ParameterDirection.Input" />, and the <see cref="P:System.Web.UI.WebControls.Parameter.DefaultValue" /> property is initialized to null.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new unnamed instance of the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> class.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="protected CookieParameter (System.Web.UI.WebControls.CookieParameter original);" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="original" Type="System.Web.UI.WebControls.CookieParameter" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="M:System.Web.UI.WebControls.CookieParameter.#ctor(System.Web.UI.WebControls.CookieParameter)" /> constructor is a protected copy constructor used to clone a <see cref="T:System.Web.UI.WebControls.CookieParameter" /> instance. The property values of the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> object, including <see cref="P:System.Web.UI.WebControls.CookieParameter.CookieName" />, <see cref="P:System.Web.UI.WebControls.Parameter.Name" />, and <see cref="P:System.Web.UI.WebControls.Parameter.Type" />, are all transferred to the new instance.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> class with the values of the instance specified by the <paramref name="original" /> parameter.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="original">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.CookieParameter" /> from which the current instance is initialized. </param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="public CookieParameter (string name, string cookieName);" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="name" Type="System.String" />
|
||
|
|
<Parameter Name="cookieName" Type="System.String" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>A <see cref="T:System.Web.UI.WebControls.CookieParameter" /> object created with the <see cref="M:System.Web.UI.WebControls.CookieParameter.#ctor(System.String,System.String)" /> constructor is initialized with the specified parameter name and string that identifies the cookie that the parameter binds to. Other properties, including <see cref="P:System.Web.UI.WebControls.Parameter.Type" /> and <see cref="P:System.Web.UI.WebControls.Parameter.Direction" />, are initialized with default values.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new named instance of the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> class, using the specified string to identify which HTTP cookie to bind to.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="name">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the parameter. </param>
|
||
|
|
<param name="cookieName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the HTTP cookie that the parameter object is bound to. The default is <see cref="F:System.String.Empty" />. </param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="public CookieParameter (string name, TypeCode type, string cookieName);" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="name" Type="System.String" />
|
||
|
|
<Parameter Name="type" Type="System.TypeCode" />
|
||
|
|
<Parameter Name="cookieName" Type="System.String" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>A <see cref="T:System.Web.UI.WebControls.CookieParameter" /> object created with the <see cref="M:System.Web.UI.WebControls.CookieParameter.#ctor(System.String,System.TypeCode,System.String)" /> constructor is initialized with the specified parameter name, <see cref="P:System.Web.UI.WebControls.Parameter.Type" />, and string that identifies the cookie that the parameter binds to. Only the <see cref="P:System.Web.UI.WebControls.Parameter.Direction" /> and <see cref="P:System.Web.UI.WebControls.Parameter.ConvertEmptyStringToNull" /> properties are initialized with default values.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new named and strongly typed instance of the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> class, using the specified string to identify which HTTP cookie to bind to.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="name">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the parameter. </param>
|
||
|
|
<param name="type">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type that the parameter represents. The default is <see cref="F:System.TypeCode.Object" />. </param>
|
||
|
|
<param name="cookieName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the HTTP cookie that the parameter object is bound to. The default is <see cref="F:System.String.Empty" />. </param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Clone">
|
||
|
|
<MemberSignature Language="C#" Value="protected override System.Web.UI.WebControls.Parameter Clone ();" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Web.UI.WebControls.Parameter</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="M:System.Web.UI.WebControls.CookieParameter.Clone" /> method calls the <see cref="M:System.Web.UI.WebControls.CookieParameter.#ctor(System.Web.UI.WebControls.CookieParameter)" /> copy constructor to initialize a new instance of the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> class with the values of the current instance.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Returns a duplicate of the current <see cref="T:System.Web.UI.WebControls.CookieParameter" /> instance.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>A <see cref="T:System.Web.UI.WebControls.CookieParameter" /> that is an exact duplicate of the current one.</para>
|
||
|
|
</returns>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="CookieName">
|
||
|
|
<MemberSignature Language="C#" Value="public string CookieName { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.String</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="P:System.Web.UI.WebControls.CookieParameter.CookieName" /> property identifies an HTTP cookie, which is represented by an <see cref="T:System.Web.HttpCookie" /> object and is available through the current <see cref="T:System.Web.HttpRequest" /> object. If the HTTP cookie is not available in the current <see cref="T:System.Web.HttpRequest" /> object, the <see cref="M:System.Web.UI.WebControls.CookieParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method binds the parameter to the value of the <see cref="P:System.Web.UI.WebControls.Parameter.DefaultValue" /> property, if it is set. If the <see cref="P:System.Web.UI.WebControls.Parameter.DefaultValue" /> property is not set, the <see cref="M:System.Web.UI.WebControls.CookieParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method fails to bind the parameter to a value.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets the name of the HTTP cookie that the parameter binds to.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Evaluate">
|
||
|
|
<MemberSignature Language="C#" Value="protected override object Evaluate (System.Web.HttpContext ctx, System.Web.UI.Control control);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Object</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="ctx" Type="System.Web.HttpContext" />
|
||
|
|
<Parameter Name="control" Type="System.Web.UI.Control" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<param name="ctx">To be added.</param>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <paramref name="context" /> parameter is used by the <see cref="M:System.Web.UI.WebControls.CookieParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method to retrieve the cookies collection and the value of the cookie that the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> object binds to. The <paramref name="control" /> parameter is ignored.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Updates and returns the value of the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> object.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>An object that represents the updated and current value of the parameter. If the context or the request is null, the <see cref="M:System.Web.UI.WebControls.CookieParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method returns null.</para>
|
||
|
|
</returns>
|
||
|
|
<param name="control">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Control" /> that is associated with the Web Forms page where the <see cref="T:System.Web.UI.WebControls.CookieParameter" /> is used. </param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
</Members>
|
||
|
|
</Type>
|