ParameterCollection.Add Method (String, TypeCode, String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Creates a Parameter object with the specified name, TypeCode, and default value, and appends it to the end of the collection.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public int Add(
	string name,
	TypeCode type,
	string value
)

Parameters

name
Type: System.String

The name of the parameter.

type
Type: System.TypeCode

The type of the parameter.

value
Type: System.String

The default value for the parameter.

Return Value

Type: System.Int32

The index value of the added item.

Use the Add(String, TypeCode, String) method to create and append a strongly typed Parameter object with a default value to the end of the collection. This implementation of the method creates the Parameter object using the name, type and value specified by the name, type and value parameters, respectively, and appends it to the collection.

The following code example demonstrates how the Add(String, TypeCode, String) method can be used to add new Parameter objects to a ParameterCollection collection by supplying the name, value, and type parameters. In this example, a Parameter object is added to an Update command of an Access data source control that provides the value of the current system time. The parameter is added with the TypeCode of DateTime.

<script runat="server">
private void UpdateRecords(Object source, EventArgs e)
{
  CheckBox cb;
  foreach(GridViewRow row in this.GridView1.Rows) {
    cb = (CheckBox) row.Cells[0].Controls[1];
    if(cb.Checked) {
      string oid = (string) row.Cells[1].Text;
      MyAccessDataSource.UpdateParameters.Add("date", TypeCode.DateTime, DateTime.Now.ToString());
      MyAccessDataSource.UpdateParameters.Add("orderid", oid);
      MyAccessDataSource.Update();
      MyAccessDataSource.UpdateParameters.Clear();
    }
  }
}
</script>

.NET Framework
Available since 2.0
Return to top
Show: