EntityDataSource.CommandParameters Property


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

Gets the parameter collection for the query.

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

public ParameterCollection CommandParameters { get; }

Property Value

Type: System.Web.UI.WebControls.ParameterCollection

A ParameterCollection that contains the parameters that are passed to the query command.

The CommandParameters property is used to access the ParameterCollection of parameters that are passed to an explicit Entity SQL query that is specified using the CommandText property.

The following example supplies Entity SQL command text that returns a collection of Product objects.

<asp:EntityDataSource ID="ProductDataSource" runat="server" 
    CommandText="SELECT value p FROM Products AS p
        WHERE p.ProductID
        BETWEEN @OrderIdMin AND @OrderIdMax"
    DefaultContainerName="AdventureWorksEntities" >
        <asp:ControlParameter Name="OrderIdMin" 
            ControlID="ProductIdMin" Type="Int32"/>
        <asp:ControlParameter Name="OrderIdMax" 
            ControlID="ProductIdMax" Type="Int32" />

The following example returns a projected series of columns:

<asp:EntityDataSource ID="ProductDataSource" runat="server" 
    CommandText="SELECT p.ProductID, p.ProductName, p.UnitsOnOrder
         FROM Products AS p 
         WHERE p.ProductID BETWEEN @OrderIDMin AND @OrderIDMax" 
         ContextTypeName="AdventureWorksModel. AdventureWorksEntities">
        <asp:ControlParameter Name="OrderIDMin" 
               ControlID="ProductIDMinTextBox" Type="Int32"/>
        <asp:ControlParameter Name="OrderIDMax" 
               ControlID="ProductIDMaxTextBox" Type="Int32" />

.NET Framework
Available since 3.5
Return to top