.NET Framework Class Library ParameterCollection Class Represents a collection of Parameter and Parameter-derived objects that are used by data source controls in advanced data-binding scenarios.
Inheritance Hierarchy
Namespace:
System.Web.UI.WebControls
Assembly:
System.Web (in System.Web.dll)
Syntax
Public Class ParameterCollection _
Inherits StateManagedCollection
public class ParameterCollection : StateManagedCollection
public ref class ParameterCollection : public StateManagedCollection
type ParameterCollection =
class
inherit StateManagedCollection
end
The ParameterCollection type exposes the following members.
Constructors
|
| Name | Description |
|---|
.gif) | ParameterCollection | Initializes the class for use by an inherited class instance. This constructor can be called only by an inherited class. |
Top
Properties
Methods
|
| Name | Description |
|---|
| Add(Parameter) | Appends the specified Parameter object to the end of the collection. | | Add(String, String) | Creates a Parameter object with the specified name and default value, and appends it to the end of the collection. | | Add(String, DbType, String) | Creates a Parameter object with the specified name, database type, and default value, and adds it to the end of the collection. | | Add(String, TypeCode, String) | Creates a Parameter object with the specified name, TypeCode, and default value, and appends it to the end of the collection. | | Clear | Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.) | | Contains | Determines whether the ParameterCollection collection contains a specific value | | CopyTo(Array, Int32) | Copies the elements of the StateManagedCollection collection to an array, starting at a particular array index. (Inherited from StateManagedCollection.) | | CopyTo(array<Parameter>[]()[], Int32) | Copies a specified index of a parameter array to the parameter collection. | .gif) | CreateKnownType | Creates an instance of a default Parameter object. (Overrides StateManagedCollection..::.CreateKnownType(Int32).) | | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | | GetEnumerator | Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.) | | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | | GetKnownTypes | Gets an array of Parameter types that the ParameterCollection collection can contain. (Overrides StateManagedCollection..::.GetKnownTypes()()().) | | GetType | Gets the Type of the current instance. (Inherited from Object.) | | GetValues | Gets an ordered collection of Parameter object names and their corresponding values currently contained by the collection. | | IndexOf | Determines the index of a specified Parameter object in the ParameterCollection collection. | | Insert | Inserts the specified Parameter object into the ParameterCollection collection at the specified index. | | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | | OnClear | When overridden in a derived class, performs additional work before the Clear method removes all items from the collection. (Inherited from StateManagedCollection.) | | OnClearComplete | Performs additional custom processes after clearing the contents of the collection. (Overrides StateManagedCollection..::.OnClearComplete()()().) | | OnInsert | Occurs before the Insert method is called. (Overrides StateManagedCollection..::.OnInsert(Int32, Object).) | | OnInsertComplete | Occurs after the Insert method completes. (Overrides StateManagedCollection..::.OnInsertComplete(Int32, Object).) | | OnParametersChanged | Raises the ParametersChanged event. | | OnRemove | When overridden in a derived class, performs additional work before the Remove(Object) or RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection.) | | OnRemoveComplete | Occurs after the Remove method completes. (Overrides StateManagedCollection..::.OnRemoveComplete(Int32, Object).) | | OnValidate | Performs additional custom processes when validating a value. (Overrides StateManagedCollection..::.OnValidate(Object).) | | Remove | Removes the specified Parameter object from the ParameterCollection collection. | | RemoveAt | Removes the Parameter object at the specified index from the ParameterCollection collection. | | SetDirty | Forces the entire StateManagedCollection collection to be serialized into view state. (Inherited from StateManagedCollection.) | | SetDirtyObject | Marks the specified Parameter object as having changed since the last load or save from view state. (Overrides StateManagedCollection..::.SetDirtyObject(Object).) | | ToString | Returns a string that represents the current object. (Inherited from Object.) | | UpdateValues | Iterates through the Parameter objects contained by the collection, and calls the Evaluate method on each one. |
Top
Events
Explicit Interface Implementations
Remarks
The ParameterCollection class represents a collection of Parameter objects used in advanced data-binding scenarios with data source controls. The Parameter objects are used to bind the values contained by local Page variables, HTTP cookies, session variables, and other controls' values to data source controls when retrieving, updating, deleting, and inserting data. Use the ParameterCollection class to programmatically manage a set of Parameter objects. You can add, insert, and remove Parameter objects using the appropriate methods of the ParameterCollection class. To programmatically retrieve Parameter objects from a collection, use one of following methods: The 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 Add, Insert, Remove, and RemoveAt methods. Depending on the implementation and the semantics of a particular data source control, the order in which the parameters are stored in the ParameterCollection collection might be important. For example, when using the SqlDataSource control as an ODBC data source, the order of the Parameter objects in the ParameterCollection collection must be the same as the order of the parameters in the parameterized SQL queries you use. However, when using the SqlDataSource control with Microsoft SQL Server, the order of the Parameter objects are not important. .gif) Security Note |
|---|
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 Script Exploits Overview. |
The following table lists the different parameter classes and how they are used. Parameter Class | Description |
|---|
Parameter | The base parameter class. Use it to bind to a local variable or any static string using the DefaultValue property. | ControlParameter | A parameter that can be used to bind to a control's property or method return value. | CookieParameter | A parameter that can be used to bind to the value of a cookie. | FormParameter | A parameter that can be used to bind to an attribute of the current Web Forms page. | QueryStringParameter | A parameter that can be used to bind to a value passed to a Web Forms page on a query string. | SessionParameter | A parameter that can be used to bind to the value of a session variable. | ProfileParameter | A parameter that can be used to bind to the value of an ASP.NET Profile property. |
Examples
The following code example demonstrates how to use an AccessDataSource control and a FormParameter to display information from a Microsoft Access database in a GridView control. The FormParameter object is added to the SelectParameters collection using the Add method. | Security Note |
|---|
This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview. |
<%@Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Private Sub Page_Load(sender As Object, e As EventArgs)
' You can add a FormParameter to the AccessDataSource control's
' SelectParameters collection programmatically.
AccessDataSource1.SelectParameters.Clear()
' Security Note: The AccessDataSource uses a FormParameter,
' Security Note: which does not perform validation of input from the client.
' Security Note: To validate the value of the FormParameter,
' Security Note: handle the Selecting event.
Dim formParam As New FormParameter("lastname","LastNameBox")
formParam.Type=TypeCode.String
AccessDataSource1.SelectParameters.Add(formParam)
End Sub ' Page_Load
</script>
<html >
<head runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<asp:accessdatasource
id="AccessDataSource1"
runat="server"
datasourcemode="DataSet"
datafile="Northwind.mdb"
selectcommand="SELECT OrderID,CustomerID,OrderDate,RequiredDate,ShippedDate
FROM Orders WHERE EmployeeID =
(SELECT EmployeeID FROM Employees WHERE LastName = @lastname)">
</asp:accessdatasource>
<br />Enter the name "Davolio" or "King" in the text box and click the button.
<br />
<asp:textbox
id="LastNameBox"
runat="server" />
<br />
<asp:button
id="Button1"
runat="server"
text="Get Records" />
<br />
<asp:gridview
id="GridView1"
runat="server"
allowsorting="True"
datasourceid="AccessDataSource1">
</asp:gridview>
</form>
</body>
</html>
<%@Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
void Page_Load(Object sender, EventArgs e){
// You can add a FormParameter to the AccessDataSource control's
// SelectParameters collection programmatically.
AccessDataSource1.SelectParameters.Clear();
// Security Note: The AccessDataSource uses a FormParameter,
// Security Note: which does not perform validation of input from the client.
// Security Note: To validate the value of the FormParameter,
// Security Note: handle the Selecting event.
FormParameter formParam = new FormParameter("lastname","LastNameBox");
formParam.Type=TypeCode.String;
AccessDataSource1.SelectParameters.Add(formParam);
}
</script>
<html >
<head runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<asp:accessdatasource
id="AccessDataSource1"
runat="server"
datasourcemode="DataSet"
datafile="Northwind.mdb"
selectcommand="SELECT OrderID,CustomerID,OrderDate,RequiredDate,ShippedDate
FROM Orders WHERE EmployeeID =
(SELECT EmployeeID FROM Employees WHERE LastName = @lastname)">
</asp:accessdatasource>
<br />Enter the name "Davolio" or "King" in the text box and click the button.
<br />
<asp:textbox
id="LastNameBox"
runat="server" />
<br />
<asp:button
id="Button1"
runat="server"
text="Get Records" />
<br />
<asp:gridview
id="GridView1"
runat="server"
allowsorting="True"
datasourceid="AccessDataSource1">
</asp:gridview>
</form>
</body>
</html>
Version Information
.NET FrameworkSupported in: 4, 3.5, 3.0, 2.0
Platforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role not supported), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
|
Bibliothèque de classes .NET Framework ParameterCollection, classe Représente une collection d'objets dérivés de Parameter et Parameter qui sont utilisés par les contrôles de source de données dans les scénarios de liaison de données avancés.
Hiérarchie d'héritage
Espace de noms :
System.Web.UI.WebControls
Assembly :
System.Web (dans System.Web.dll)
Syntaxe
Public Class ParameterCollection _
Inherits StateManagedCollection
public class ParameterCollection : StateManagedCollection
public ref class ParameterCollection : public StateManagedCollection
type ParameterCollection =
class
inherit StateManagedCollection
end
Le type ParameterCollection expose les membres suivants.
Constructeurs
|
| Nom | Description |
|---|
| ParameterCollection | Initialise la classe pour qu'elle soit utilisée par une instance de la classe héritée. Ce constructeur peut être appelé uniquement par une classe héritée. |
Début
Propriétés
Méthodes
|
| Nom | Description |
|---|
| Add(Parameter) | Ajoute l'objet Parameter spécifié à la fin de la collection. | | Add(String, String) | Crée un objet Parameter avec le nom spécifié et la valeur par défaut et l'ajoute à la fin de la collection. | | Add(String, DbType, String) | Crée un objet Parameter avec le nom, le type de base de données et la valeur par défaut spécifiés, puis l'ajoute à la fin de la collection. | | Add(String, TypeCode, String) | Crée un objet Parameter avec le nom spécifié, TypeCode et la valeur par défaut et l'ajoute à la fin de la collection. | | Clear | Supprime tous les éléments de la collection StateManagedCollection. (Hérité de StateManagedCollection.) | | Contains | Détermine si la collection ParameterCollection contient une valeur spécifique. | | CopyTo(Array, Int32) | Copie les éléments de la collection StateManagedCollection dans un tableau, en commençant au niveau d'un index de tableau particulier. (Hérité de StateManagedCollection.) | | CopyTo(array<Parameter>[]()[], Int32) | Copie l'index spécifié d'un tableau de paramètres dans la collection de paramètres. | | CreateKnownType | Crée une instance d'un objet Parameter par défaut. (Substitue StateManagedCollection..::.CreateKnownType(Int32).) | | Equals(Object) | Détermine si l'Object spécifié est égal à l'Object en cours. (Hérité de Object.) | | Finalize | Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de netto***ge avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.) | | GetEnumerator | Retourne un itérateur qui itère au sein de la collection StateManagedCollection. (Hérité de StateManagedCollection.) | | GetHashCode | Sert de fonction de hachage pour un type particulier. (Hérité de Object.) | | GetKnownTypes | Obtient un tableau des types Parameter que la collection ParameterCollection peut contenir. (Substitue StateManagedCollection..::.GetKnownTypes()()().) | | GetType | Obtient le Type de l'instance actuelle. (Hérité de Object.) | | GetValues | Obtient une collection triée de noms d'objets Parameter et leurs valeurs correspondantes actuellement contenus dans la collection. | | IndexOf | Détermine l'index d'un objet Parameter spécifié dans la collection ParameterCollection. | | Insert | Insère l'objet Parameter spécifié dans la collection ParameterCollection à l'index spécifié. | | MemberwiseClone | Crée une copie superficielle de l'objet Object actif. (Hérité de Object.) | | OnClear | En cas de substitution dans une classe dérivée, exécute une tâche supplémentaire avant que la méthode Clear supprime tous les éléments de la collection. (Hérité de StateManagedCollection.) | | OnClearComplete | Exécute des processus personnalisés supplémentaires après l'effacement du contenu de la collection. (Substitue StateManagedCollection..::.OnClearComplete()()().) | | OnInsert | Se produit avant que la méthode Insert soit appelée. (Substitue StateManagedCollection..::.OnInsert(Int32, Object).) | | OnInsertComplete | Se produit après que la méthode Insert est terminée. (Substitue StateManagedCollection..::.OnInsertComplete(Int32, Object).) | | OnParametersChanged | Déclenche l'événement ParametersChanged. | | OnRemove | En cas de substitution dans une classe dérivée, exécute toute tâche supplémentaire avant que la méthode Remove(Object) ou RemoveAt(Int32) supprime l'élément spécifié de la collection. (Hérité de StateManagedCollection.) | | OnRemoveComplete | Se produit après que la méthode Remove est terminée. (Substitue StateManagedCollection..::.OnRemoveComplete(Int32, Object).) | | OnValidate | Exécute des processus personnalisés supplémentaires lors de la validation d'une valeur. (Substitue StateManagedCollection..::.OnValidate(Object).) | | Remove | Supprime de la collection ParameterCollection l'objet Parameter spécifié. | | RemoveAt | Supprime de la collection ParameterCollection l'objet Parameter à l'index spécifié. | | SetDirty | Force la sérialisation de l'intégralité de la collection StateManagedCollection dans l'état d'affichage. (Hérité de StateManagedCollection.) | | SetDirtyObject | Marque l'objet Parameter spécifié comme modifié depuis son dernier chargement ou enregistrement à partir de l'état d'affichage. (Substitue StateManagedCollection..::.SetDirtyObject(Object).) | | ToString | Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.) | | UpdateValues | Itère au sein des objets Parameter contenus dans la collection et appelle la méthode Evaluate sur chacun des objets. |
Début
Événements
Implémentations d'interface explicite
Notes
La classe ParameterCollection représente une collection d'objets Parameter utilisée dans les scénarios de liaison de données avancés avec les contrôles de source de données. Les objets Parameter sont utilisés pour lier les valeurs contenues dans les variables Page locales, les cookies HTTP, les variables de session et d'autres valeurs de contrôles aux contrôles de source de données lors de la récupération, de la mise à jour, de la suppression et de l'insertion de données. Utilisez la classe ParameterCollection pour gérer par programme un ensemble d'objets Parameter. Vous pouvez ajouter, insérer et supprimer des objets Parameter à l'aide des méthodes appropriées de la classe ParameterCollection. Pour récupérer par programme des objets Parameter à partir d'une collection, utilisez l'une des méthodes suivantes : Utilisez l'indexeur pour obtenir un seul objet Parameter de la collection, par nom ou à l'aide d'une notation de tableau. Utilisez la méthode GetEnumerator pour créer un objet implémentant System.Collections..::.IEnumerator, pouvant ensuite être utilisé pour obtenir des éléments de la collection.
La propriété Count spécifie le nombre total d'éléments dans la collection et est utilisée pour déterminer la limite supérieure de la collection. Vous pouvez ajouter des éléments dans la collection ou en supprimer à l'aide des méthodes Add, Insert, Remove et RemoveAt. En fonction de l'implémentation et de la sémantique d'un contrôle de source de données particulier, il est possible que l'ordre dans lequel les paramètres sont stockés dans la collection ParameterCollection soit important. Par exemple, lors de l'utilisation du contrôle SqlDataSource comme source de données ODBC, l'ordre des objets Parameter dans la collection ParameterCollection doit être le même que l'ordre des paramètres dans les requêtes SQL paramétrées que vous utilisez. Toutefois, lors de l'utilisation du contrôle SqlDataSource avec Microsoft SQL Server, l'ordre des objets Parameter n'est pas important. | Note de sécurité |
|---|
Lorsque vous utilisez des contrôles de source de données, les valeurs sont insérées dans des paramètres de commande sans validation, ce qui constitue une menace potentielle pour la sécurité. Utilisez un événement dans le contrôle de source de données pour valider les valeurs de paramètre avant l'exécution de la commande. Pour plus d'informations, consultez Vue d'ensemble des attaques de script. |
Le tableau suivant répertorie les différentes classes Parameter et comment elles sont utilisées. Classe Parameter | Description |
|---|
Parameter | Classe Parameter de base. Utilisez-la pour créer une liaison avec une variable locale ou toute chaîne statique à l'aide de la propriété DefaultValue. | ControlParameter | Paramètre qui peut être utilisé pour créer une liaison avec une valeur de retour de méthode ou de propriété d'un contrôle. | CookieParameter | Paramètre qui peut être utilisé pour créer une liaison avec la valeur d'un cookie. | FormParameter | Paramètre qui peut être utilisé pour créer une liaison avec un attribut de la page Web Forms en cours. | QueryStringParameter | Paramètre qui peut être utilisé pour créer une liaison avec une valeur passée à une page Web Forms sur une chaîne de requête. | SessionParameter | Paramètre qui peut être utilisé pour créer une liaison avec la valeur d'une variable de session. | ProfileParameter | Paramètre qui peut être utilisé pour créer une liaison avec la valeur d'une propriété de profil ASP.NET. |
Exemples
L'exemple de code suivant montre comment utiliser un contrôle AccessDataSource et un FormParameter pour afficher des informations à partir d'une base de données Microsoft Access dans un contrôle GridView. L'objet FormParameter est ajouté à la collection SelectParameters à l'aide de la méthode Add. | Note de sécurité |
|---|
Cet exemple a une zone de texte qui accepte l'entrée d'utilisateur, ce qui constitue une menace éventuelle pour la sécurité. Par défaut, les pages Web ASP.NET vérifient que l'entrée d'utilisateur n'inclut pas de script ni d'éléments HTML. Pour plus d'informations, consultez Vue d'ensemble des attaques de script. |
<%@Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Private Sub Page_Load(sender As Object, e As EventArgs)
' You can add a FormParameter to the AccessDataSource control's
' SelectParameters collection programmatically.
AccessDataSource1.SelectParameters.Clear()
' Security Note: The AccessDataSource uses a FormParameter,
' Security Note: which does not perform validation of input from the client.
' Security Note: To validate the value of the FormParameter,
' Security Note: handle the Selecting event.
Dim formParam As New FormParameter("lastname","LastNameBox")
formParam.Type=TypeCode.String
AccessDataSource1.SelectParameters.Add(formParam)
End Sub ' Page_Load
</script>
<html >
<head runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<asp:accessdatasource
id="AccessDataSource1"
runat="server"
datasourcemode="DataSet"
datafile="Northwind.mdb"
selectcommand="SELECT OrderID,CustomerID,OrderDate,RequiredDate,ShippedDate
FROM Orders WHERE EmployeeID =
(SELECT EmployeeID FROM Employees WHERE LastName = @lastname)">
</asp:accessdatasource>
<br />Enter the name "Davolio" or "King" in the text box and click the button.
<br />
<asp:textbox
id="LastNameBox"
runat="server" />
<br />
<asp:button
id="Button1"
runat="server"
text="Get Records" />
<br />
<asp:gridview
id="GridView1"
runat="server"
allowsorting="True"
datasourceid="AccessDataSource1">
</asp:gridview>
</form>
</body>
</html>
<%@Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
void Page_Load(Object sender, EventArgs e){
// You can add a FormParameter to the AccessDataSource control's
// SelectParameters collection programmatically.
AccessDataSource1.SelectParameters.Clear();
// Security Note: The AccessDataSource uses a FormParameter,
// Security Note: which does not perform validation of input from the client.
// Security Note: To validate the value of the FormParameter,
// Security Note: handle the Selecting event.
FormParameter formParam = new FormParameter("lastname","LastNameBox");
formParam.Type=TypeCode.String;
AccessDataSource1.SelectParameters.Add(formParam);
}
</script>
<html >
<head runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<asp:accessdatasource
id="AccessDataSource1"
runat="server"
datasourcemode="DataSet"
datafile="Northwind.mdb"
selectcommand="SELECT OrderID,CustomerID,OrderDate,RequiredDate,ShippedDate
FROM Orders WHERE EmployeeID =
(SELECT EmployeeID FROM Employees WHERE LastName = @lastname)">
</asp:accessdatasource>
<br />Enter the name "Davolio" or "King" in the text box and click the button.
<br />
<asp:textbox
id="LastNameBox"
runat="server" />
<br />
<asp:button
id="Button1"
runat="server"
text="Get Records" />
<br />
<asp:gridview
id="GridView1"
runat="server"
allowsorting="True"
datasourceid="AccessDataSource1">
</asp:gridview>
</form>
</body>
</html>
Informations de version
.NET FrameworkPris en charge dans : 4, 3.5, 3.0, 2.0
Plateformes
Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows XP SP2 Édition x64, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2
Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.
Sécurité des threads
Tous les membres static ( Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.
Voir aussi
|