Language

EntityDataSource.AutoGenerateOrderByClause プロパティ

定義

名前空間:
System.Web.UI.WebControls
アセンブリ:
System.Web.Entity.dll

EntityDataSource コントロールが、OrderByParameters コレクション内の値に基づいて ORDER BY 句を動的に作成するかどうかを示す値を取得または設定します。

public:
 property bool AutoGenerateOrderByClause { bool get(); void set(bool value); };
public bool AutoGenerateOrderByClause { get; set; }
member this.AutoGenerateOrderByClause : bool with get, set
Public Property AutoGenerateOrderByClause As Boolean

プロパティ値

Boolean

true EntityDataSource コントロールが ORDER BY 句を作成する場合は。それ以外の場合はfalse。 既定値は false です。

例外

InvalidOperationException

AutoGenerateOrderByClause プロパティが true に設定されていて、OrderBy プロパティが null でない場合。

例

次の例では、ORDER BY 句を自動的に生成し、 OrderByDropDownList の値を使用してパラメーターの値を設定します。

<asp:DropDownList AutoPostBack="true" ID="OrderByDropDownList" runat="server">
    <asp:ListItem Value="TotalDue"></asp:ListItem>
    <asp:ListItem Value="OrderDate"></asp:ListItem>
</asp:DropDownList>

<asp:EntityDataSource ID="EntityDataSourceWithAutoGenOrderBy" runat="server"
ConnectionString="name=AdventureWorksEntities"
DefaultContainerName="AdventureWorksEntities"
EntitySetName="SalesOrderHeaders"
Select="it.SalesOrderID, it.TotalDue, it.OrderDate"
AutoGenerateOrderByClause="True">
<OrderByParameters>
    <asp:ControlParameter
    ControlID="OrderByDropDownList"/>
</OrderByParameters>
</asp:EntityDataSource>

次の例では、ORDER BY 句を自動的に生成し、DefaultValue要素のParameter属性を使用してパラメーターの値を設定します。

<asp:EntityDataSource ID="EntityDataSourceWithAutoGenOrderBy" runat="server"
ConnectionString="name=AdventureWorksEntities"
DefaultContainerName="AdventureWorksEntities"
EntitySetName="SalesOrderHeaders"
Select="it.SalesOrderID, it.TotalDue, it.OrderDate"
AutoGenerateOrderByClause="True">
<OrderByParameters>
    <asp:Parameter
    DefaultValue="TotalDue"/>
</OrderByParameters>
</asp:EntityDataSource>

注釈

AutoGenerateOrderByClause コントロールの EntityDataSource プロパティが true に設定されている場合、コントロールは、ParameterCollection プロパティに割り当てられたOrderByParametersのパラメーターから ORDER BY 句を自動的に生成します。 これにより、ORDER BY 句を OrderBy プロパティに明示的に割り当てる必要がなくなります。

AutoGenerateOrderByClause プロパティを true に設定する場合は、OrderBy プロパティに値を明示的に割り当てないようにしてください。

適用対象