832 lines
44 KiB
XML
832 lines
44 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="ParameterCollection" FullName="System.Web.UI.WebControls.ParameterCollection">
|
|
<TypeSignature Language="C#" Value="public class ParameterCollection : System.Web.UI.StateManagedCollection" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Web.UI.StateManagedCollection</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Editor("System.Web.UI.Design.WebControls.ParameterCollectionEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> class represents a collection of <see cref="T:System.Web.UI.WebControls.Parameter" /> objects used in advanced data-binding scenarios with data source controls. The <see cref="T:System.Web.UI.WebControls.Parameter" /> objects are used to bind the values contained by local <see cref="T:System.Web.UI.Page" /> variables, HTTP cookies, session variables, and other controls' values to data source controls when retrieving, updating, deleting, and inserting data. </para>
|
|
<para>Use the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> class to programmatically manage a set of <see cref="T:System.Web.UI.WebControls.Parameter" /> objects. You can add, insert, and remove <see cref="T:System.Web.UI.WebControls.Parameter" /> objects using the appropriate methods of the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> class. To programmatically retrieve <see cref="T:System.Web.UI.WebControls.Parameter" /> objects from a collection, use one of following methods: </para>
|
|
<list type="bullet">
|
|
<item>
|
|
<para>Use the indexer to get a single <see cref="T:System.Web.UI.WebControls.Parameter" /> object from the collection, by name or using array notation.</para>
|
|
</item>
|
|
<item>
|
|
<para>Use the <see cref="M:System.Collections.IEnumerable.GetEnumerator" /> method to create a <see cref="T:System.Collections.IEnumerator" />-implemented object, which can then be used to get items from the collection.</para>
|
|
</item>
|
|
</list>
|
|
<para>The <see cref="P:System.Web.UI.StateManagedCollection.Count" /> property specifies the total number of items in the collection, and is used to determine the upper bound of the collection. You can add and remove items from the collection by using the <see cref="Overload:System.Web.UI.WebControls.ParameterCollection.Add" />, <see cref="M:System.Web.UI.WebControls.ParameterCollection.Insert(System.Int32,System.Web.UI.WebControls.Parameter)" />, <see cref="M:System.Web.UI.WebControls.ParameterCollection.Remove(System.Web.UI.WebControls.Parameter)" />, and <see cref="M:System.Web.UI.WebControls.ParameterCollection.RemoveAt(System.Int32)" /> methods.</para>
|
|
<para>Depending on the implementation and the semantics of a particular data source control, the order in which the parameters are stored in the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection might be important. For example, when using the <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> control as an ODBC data source, the order of the <see cref="T:System.Web.UI.WebControls.Parameter" /> objects in the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection must be the same as the order of the parameters in the parameterized SQL queries you use. However, when using the <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> control with Microsoft SQL Server, the order of the <see cref="T:System.Web.UI.WebControls.Parameter" /> objects are not important.</para>
|
|
<block subset="none" type="note">
|
|
<para>When you use data source controls, values are inserted into command parameters without validation, which is a potential security threat. Use an event in the data source control to validate parameter values before the command is executed. For more information, see <format type="text/html"><a href="772c7312-211a-4eb3-8d6e-eec0aa1dcc07">Script Exploits Overview</a></format>.</para>
|
|
</block>
|
|
<para>The following table lists the different parameter classes and how they are used.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Parameter Class</para>
|
|
</term>
|
|
<description>
|
|
<para>Description </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.Parameter" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>The base parameter class. Use it to bind to a local variable or any static string using the <see cref="P:System.Web.UI.WebControls.Parameter.DefaultValue" /> property.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.ControlParameter" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>A parameter that can be used to bind to a control's property or method return value. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.CookieParameter" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>A parameter that can be used to bind to the value of a cookie. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.FormParameter" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>A parameter that can be used to bind to an attribute of the current Web Forms page. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.QueryStringParameter" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>A parameter that can be used to bind to a value passed to a Web Forms page on a query string.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.SessionParameter" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>A parameter that can be used to bind to the value of a session variable. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.ProfileParameter" />
|
|
</para>
|
|
</term>
|
|
<description>
|
|
<para>A parameter that can be used to bind to the value of an ASP.NET Profile property.</para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents a collection of <see cref="T:System.Web.UI.WebControls.Parameter" /> and <see cref="T:System.Web.UI.WebControls.Parameter" />-derived objects that are used by data source controls in advanced data-binding scenarios.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ParameterCollection ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes the class for use by an inherited class instance. This constructor can be called only by an inherited class.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Add">
|
|
<MemberSignature Language="C#" Value="public int Add (System.Web.UI.WebControls.Parameter param);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="param" Type="System.Web.UI.WebControls.Parameter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="param">To be added.</param>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="M:System.Web.UI.WebControls.ParameterCollection.Add(System.Web.UI.WebControls.Parameter)" /> method to append a <see cref="T:System.Web.UI.WebControls.Parameter" /> object to the end of the collection. This implementation of the method takes the <see cref="T:System.Web.UI.WebControls.Parameter" /> object specified by the <paramref name="param" /> parameter and appends it to the collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Appends the specified <see cref="T:System.Web.UI.WebControls.Parameter" /> object to the end of the collection.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The index value of the added item.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Add">
|
|
<MemberSignature Language="C#" Value="public int Add (string name, string value);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="M:System.Web.UI.WebControls.ParameterCollection.Add(System.String,System.String)" /> method to create and append a <see cref="T:System.Web.UI.WebControls.Parameter" /> object with a default value to the end of the collection. This implementation of the method creates the <see cref="T:System.Web.UI.WebControls.Parameter" /> object using the name and default value specified by the <paramref name="name" /> and <paramref name="value" /> parameters, respectively, and appends it to the collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a <see cref="T:System.Web.UI.WebControls.Parameter" /> object with the specified name and default value, and appends it to the end of the collection.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The index value of the added item.</para>
|
|
</returns>
|
|
<param name="name">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the parameter. </param>
|
|
<param name="value">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A string that serves as a default value for the parameter. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Add">
|
|
<MemberSignature Language="C#" Value="public int Add (string name, TypeCode type, string value);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="type" Type="System.TypeCode" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="M:System.Web.UI.WebControls.ParameterCollection.Add(System.String,System.TypeCode,System.String)" /> method to create and append a strongly typed <see cref="T:System.Web.UI.WebControls.Parameter" /> object with a default value to the end of the collection. This implementation of the method creates the <see cref="T:System.Web.UI.WebControls.Parameter" /> object using the name, type and value specified by the <paramref name="name" />, <paramref name="type" /> and <paramref name="value" /> parameters, respectively, and appends it to the collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a <see cref="T:System.Web.UI.WebControls.Parameter" /> object with the specified name, <see cref="T:System.TypeCode" />, and default value, and appends it to the end of the collection.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The index value of the added item.</para>
|
|
</returns>
|
|
<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 of the parameter.</param>
|
|
<param name="value">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The default value for the parameter.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Contains">
|
|
<MemberSignature Language="C#" Value="public bool Contains (System.Web.UI.WebControls.Parameter param);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="param" Type="System.Web.UI.WebControls.Parameter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="param">To be added.</param>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use this method to determine whether a specified <see cref="T:System.Web.UI.WebControls.Parameter" /> object is in the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Determines whether the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection contains a specific value</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if the object is found in the <see cref="T:System.Web.UI.WebControls.ParameterCollection" />; otherwise, false. If null is passed for the <paramref name="value" /> parameter, false is returned.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CopyTo">
|
|
<MemberSignature Language="C#" Value="public void CopyTo (System.Web.UI.WebControls.Parameter[] paramArray, int index);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="paramArray" Type="System.Web.UI.WebControls.Parameter[]" />
|
|
<Parameter Name="index" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="paramArray">To be added.</param>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Copies a specified index of a parameter array to the parameter collection.</para>
|
|
</summary>
|
|
<param name="index">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The integer index of the <paramref name="parameterArray" /> item that is to be copied. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CreateKnownType">
|
|
<MemberSignature Language="C#" Value="protected override object CreateKnownType (int idx);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="idx" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="idx">To be added.</param>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.WebControls.ParameterCollection.CreateKnownType(System.Int32)" /> method creates an instance of a <see cref="T:System.Web.UI.WebControls.Parameter" /> object according to the index of the <see cref="T:System.Type" /> returned by the <see cref="M:System.Web.UI.WebControls.ParameterCollection.GetKnownTypes" /> method. The index values correspond to types shown in the following table.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Index </para>
|
|
</term>
|
|
<description>
|
|
<para>Parameter type </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>0 </para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.ControlParameter" /> </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>1 </para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.CookieParameter" /> </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>2 </para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.FormParameter" /> </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>3 </para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.Parameter" /> </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>4 </para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.QueryStringParameter" /> </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>5 </para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.SessionParameter" /> </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>6</para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<see cref="T:System.Web.UI.WebControls.ProfileParameter" />
|
|
</para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates an instance of a default <see cref="T:System.Web.UI.WebControls.Parameter" /> object.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A default instance of a <see cref="T:System.Web.UI.WebControls.Parameter" />.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="GetKnownTypes">
|
|
<MemberSignature Language="C#" Value="protected override Type[] GetKnownTypes ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Type[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets an array of <see cref="T:System.Web.UI.WebControls.Parameter" /> types that the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection can contain.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An ordered array of <see cref="T:System.Type" /> objects that identify the types of <see cref="T:System.Web.UI.WebControls.Parameter" /> objects that the collection can contain.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="GetValues">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Specialized.IOrderedDictionary GetValues (System.Web.HttpContext context, System.Web.UI.Control control);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Specialized.IOrderedDictionary</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="context" Type="System.Web.HttpContext" />
|
|
<Parameter Name="control" Type="System.Web.UI.Control" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <paramref name="control" /> parameter is used by <see cref="T:System.Web.UI.WebControls.Parameter" /> objects contained in the collection to retrieve the <see cref="T:System.Web.UI.Page" /> and current <see cref="T:System.Web.HttpRequest" /> object that the <see cref="T:System.Web.UI.WebControls.Parameter" /> object binds to.</para>
|
|
<para>Because the <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> object must have uniquely named entries but the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection does not require or guarantee unique <see cref="T:System.Web.UI.WebControls.Parameter" /> object names, the implementation of this method appends a number to the end of each <see cref="P:System.Web.UI.WebControls.Parameter.Name" /> property to ensure uniqueness in the returned collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets an ordered collection of <see cref="T:System.Web.UI.WebControls.Parameter" /> object names and their corresponding values currently contained by the collection.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> of name/value pairs.</para>
|
|
</returns>
|
|
<param name="context">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The current <see cref="T:System.Web.HttpRequest" /> that the <see cref="T:System.Web.UI.WebControls.Parameter" /> binds to.</param>
|
|
<param name="control">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> instance that is passed to each parameter's <see cref="M:System.Web.UI.WebControls.ControlParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="IndexOf">
|
|
<MemberSignature Language="C#" Value="public int IndexOf (System.Web.UI.WebControls.Parameter param);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="param" Type="System.Web.UI.WebControls.Parameter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="param">To be added.</param>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use this method to determine the index of a parameter in the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Determines the index of a specified <see cref="T:System.Web.UI.WebControls.Parameter" /> object in the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The index of <paramref name="parameter" />, if it is found in the collection; otherwise, -1.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Insert">
|
|
<MemberSignature Language="C#" Value="public void Insert (int idx, System.Web.UI.WebControls.Parameter param);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="idx" Type="System.Int32" />
|
|
<Parameter Name="param" Type="System.Web.UI.WebControls.Parameter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="idx">To be added.</param>
|
|
<param name="param">To be added.</param>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Inserts the specified <see cref="T:System.Web.UI.WebControls.Parameter" /> object into the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection at the specified index.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Item">
|
|
<MemberSignature Language="C#" Value="public System.Web.UI.WebControls.Parameter this[int idx] { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.UI.WebControls.Parameter</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="idx" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="idx">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Item">
|
|
<MemberSignature Language="C#" Value="public System.Web.UI.WebControls.Parameter this[string name] { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.UI.WebControls.Parameter</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="name">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnClearComplete">
|
|
<MemberSignature Language="C#" Value="protected override void OnClearComplete ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</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.ParameterCollection.OnClearComplete" /> method is called to perform additional processing after the <see cref="M:System.Web.UI.StateManagedCollection.Clear" /> method completes. It calls the <see cref="M:System.Web.UI.WebControls.ParameterCollection.OnParametersChanged(System.EventArgs)" /> method.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Performs additional custom processes after clearing the contents of the collection.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnInsert">
|
|
<MemberSignature Language="C#" Value="protected override void OnInsert (int idx, object value);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="idx" Type="System.Int32" />
|
|
<Parameter Name="value" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="idx">To be added.</param>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.WebControls.ParameterCollection.OnInsert(System.Int32,System.Object)" /> method is called to perform additional processing before the <see cref="M:System.Web.UI.WebControls.ParameterCollection.Insert(System.Int32,System.Web.UI.WebControls.Parameter)" /> method is called.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs before the <see cref="M:System.Web.UI.WebControls.ParameterCollection.Insert(System.Int32,System.Web.UI.WebControls.Parameter)" /> method is called.</para>
|
|
</summary>
|
|
<param name="value">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.Parameter" /> that is inserted into the <see cref="T:System.Web.UI.WebControls.ParameterCollection" />. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnInsertComplete">
|
|
<MemberSignature Language="C#" Value="protected override void OnInsertComplete (int idx, object value);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="idx" Type="System.Int32" />
|
|
<Parameter Name="value" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="idx">To be added.</param>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.WebControls.ParameterCollection.OnInsertComplete(System.Int32,System.Object)" /> method is called to perform additional processing after the <see cref="M:System.Web.UI.WebControls.ParameterCollection.Insert(System.Int32,System.Web.UI.WebControls.Parameter)" /> method completes. It calls the <see cref="M:System.Web.UI.WebControls.ParameterCollection.OnParametersChanged(System.EventArgs)" /> method.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs after the <see cref="M:System.Web.UI.WebControls.ParameterCollection.Insert(System.Int32,System.Web.UI.WebControls.Parameter)" /> method completes.</para>
|
|
</summary>
|
|
<param name="value">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.Parameter" /> that was inserted into the <see cref="T:System.Web.UI.WebControls.ParameterCollection" />. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnParametersChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnParametersChanged (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Web.UI.WebControls.ParameterCollection.ParametersChanged" /> event.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnRemoveComplete">
|
|
<MemberSignature Language="C#" Value="protected override void OnRemoveComplete (int index, object value);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="index" Type="System.Int32" />
|
|
<Parameter Name="value" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.WebControls.ParameterCollection.OnRemoveComplete(System.Int32,System.Object)" /> method is called to perform additional processing after the <see cref="M:System.Web.UI.WebControls.ParameterCollection.Remove(System.Web.UI.WebControls.Parameter)" /> method completes. It calls the <see cref="M:System.Web.UI.WebControls.ParameterCollection.OnParametersChanged(System.EventArgs)" /> method.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs after the <see cref="M:System.Web.UI.WebControls.ParameterCollection.Remove(System.Web.UI.WebControls.Parameter)" /> method completes.</para>
|
|
</summary>
|
|
<param name="index">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The index in the collection that the <see cref="T:System.Web.UI.WebControls.Parameter" /> was removed from. </param>
|
|
<param name="value">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.Parameter" /> that was removed from the <see cref="T:System.Web.UI.WebControls.ParameterCollection" />. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnValidate">
|
|
<MemberSignature Language="C#" Value="protected override void OnValidate (object o);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="o" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.WebControls.ParameterCollection.OnValidate(System.Object)" /> method determines whether the object specified in the <paramref name="o" /> parameter is a <see cref="T:System.Web.UI.WebControls.Parameter" /> instance. If not, it throws an <see cref="T:System.ArgumentException" /> exception.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Performs additional custom processes when validating a value.</para>
|
|
</summary>
|
|
<param name="o">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The object being validated. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ParametersChanged">
|
|
<MemberSignature Language="C#" Value="public event EventHandler ParametersChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection is contained by a data source control, the <see cref="E:System.Web.UI.WebControls.ParameterCollection.ParametersChanged" /> event raises the data source control's DataSourceChanged event, causing any data-bound controls to rebind.</para>
|
|
<para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para>
|
|
<para>The <see cref="M:System.Web.UI.WebControls.Parameter.OnParameterChanged" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs when one or more <see cref="T:System.Web.UI.WebControls.Parameter" /> objects contained by the collection changes state.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Remove">
|
|
<MemberSignature Language="C#" Value="public void Remove (System.Web.UI.WebControls.Parameter param);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="param" Type="System.Web.UI.WebControls.Parameter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="param">To be added.</param>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use this method to remove the specified <see cref="T:System.Web.UI.WebControls.Parameter" /> object from a <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Removes the specified <see cref="T:System.Web.UI.WebControls.Parameter" /> object from the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RemoveAt">
|
|
<MemberSignature Language="C#" Value="public void RemoveAt (int idx);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="idx" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="idx">To be added.</param>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="M:System.Web.UI.WebControls.ParameterCollection.RemoveAt(System.Int32)" /> method to remove the <see cref="T:System.Web.UI.WebControls.Parameter" /> object at the specified index from the collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Removes the <see cref="T:System.Web.UI.WebControls.Parameter" /> object at the specified index from the <see cref="T:System.Web.UI.WebControls.ParameterCollection" /> collection.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="SetDirtyObject">
|
|
<MemberSignature Language="C#" Value="protected override void SetDirtyObject (object o);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="o" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.WebControls.ParameterCollection.SetDirtyObject(System.Object)" /> method is a helper function that is used to mark a <see cref="T:System.Web.UI.WebControls.Parameter" /> object as having changed since the last load or save from view state.</para>
|
|
<block subset="none" type="note">
|
|
<para>This method is used only by control developers.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Marks the specified <see cref="T:System.Web.UI.WebControls.Parameter" /> object as having changed since the last load or save from view state.</para>
|
|
</summary>
|
|
<param name="o">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.Parameter" /> to mark as having changed since the last load or save from view state. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="UpdateValues">
|
|
<MemberSignature Language="C#" Value="public void UpdateValues (System.Web.HttpContext context, System.Web.UI.Control control);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="context" Type="System.Web.HttpContext" />
|
|
<Parameter Name="control" Type="System.Web.UI.Control" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <paramref name="control" /> parameter is used by <see cref="T:System.Web.UI.WebControls.Parameter" /> objects contained in the collection to retrieve the <see cref="T:System.Web.UI.Page" /> and current <see cref="T:System.Web.HttpRequest" /> object that the <see cref="T:System.Web.UI.WebControls.Parameter" /> object binds to.</para>
|
|
<para>If the current value for the <see cref="T:System.Web.UI.WebControls.Parameter" /> object is different from the value cached in view state, the <see cref="M:System.Web.UI.WebControls.Parameter.OnParameterChanged" /> method is called.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Iterates through the <see cref="T:System.Web.UI.WebControls.Parameter" /> objects contained by the collection, and calls the Evaluate method on each one.</para>
|
|
</summary>
|
|
<param name="context">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The current <see cref="T:System.Web.HttpRequest" /> that the <see cref="T:System.Web.UI.WebControls.Parameter" /> binds to.</param>
|
|
<param name="control">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> instance that is passed to each parameter's <see cref="M:System.Web.UI.WebControls.ControlParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |