EntityDataSource.WhereParameters 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 collection of parameters that are used to create the WHERE clause.

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

abstract WhereParameters : ParameterCollection with get
override WhereParameters : ParameterCollection with get

Property Value

Type: System.Web.UI.WebControls.ParameterCollection

The parameters that are used for creating the WHERE clause.

Like the Where method of the ObjectQuery<'T> class, parameters can be passed to the predicate assigned to the Where property. The WhereParameters property of the EntityDataSource control specifies a ParameterCollection that contains the parameters to supply to the WHERE clause of the query. The WhereParameters property uses named arguments to refer to the parameters that are specified in the string that is supplied to the Where property.

If the WhereParametersproperty is not set, no parameter substitution is made. All the parameter names in the WHERE clause preceded by the symbol "@" must have a matching name in the ParameterCollection. Null values are not allowed for parameters in a ParameterCollection.

The XML markup in the following example, in an .aspx file, retrieves a value from a control and passes it as a parameter to the Where property.

<asp:EntityDataSource ID="SalesOrderHeader" runat="server" 
  DefaultContainerName="AdventureWorksEntities" EnableDelete="True" 
  EnableInsert="True" EnableUpdate="True" EntitySetName="SalesOrderHeader" 
  EntityTypeFilter="" OrderBy="it.TotalDue DESC" Select="" 
   Where="it.OnlineOrderFlag = TRUE AND it.TotalDue &gt; @ordercost">
    <asp:ControlParameter ControlID="costLimit" DbType="Int32" 
      DefaultValue="2500" Name="ordercost" PropertyName="Text" />

The previous XML example is the same as the following ObjectQuery<'T> named onlineOrders:

ObjectQuery<SalesOrderHeader> onlineOrders =
       .Where("it.OnlineOrderFlag = TRUE AND it.TotalDue > @ordercost",
         new ObjectParameter("ordercost", orderCost))
        .OrderBy("it.TotalDue DESC");

.NET Framework
Available since 3.5
Return to top