ObjectDataSource.SortParameterName プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

ObjectDataSource.SortParameterName プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

データソースの並べ替えをサポートするために、SelectMethod パラメータで並べ替え式を指定する際に使用したビジネスオブジェクトの名前を取得また設定します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Property SortParameterName As
 String

Visual Basic (使用法)

Dim instance As ObjectDataSource
Dim value As String

value = instance.SortParameterName

instance.SortParameterName = value

public string SortParameterName { get;
 set; }

C++

public:
property String^ SortParameterName {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_SortParameterName ()

/** @property */
public void set_SortParameterName (String value)

JScript

public function get SortParameterName
 () : String

public function set SortParameterName
 (value : String)

プロパティ値
データの並べ替えに使用するパラメータを示すために使用するメソッドパラメータの名前。既定値は空の文字列です。

解説

SortParameterName プロパティは、データソースの並べ替えをサポートするために使用されます。DataSourceSelectArguments オブジェクトで SortExpression プロパティが設定され、Select メソッドに渡される場合、SortParameterName 値は、並べ替えるデータに基づいて、SelectMethod ビジネスオブジェクトメソッドのパラメータ名を識別します。

ObjectDataSource がデータバインドコントロールに関連付けられている場合、このパラメータに渡される値は、"ASC" または "DESC" が後続するコンマ区切りのフィールド値の形式を使用します。たとえば、Name で昇順並べ替えを行う場合の値は "Name ASC" になります。

SortParameterName プロパティは、ObjectDataSource コントロールに関連付けられた ObjectDataSourceView オブジェクトの SortParameterName プロパティに処理を代行させます。

使用例

このセクションには、2 つのコード例が含まれています。1 つ目のコード例では、並べ替えをサポートする型を実装する方法を示します。2 つ目のコード例では、並べ替え式を実装する方法を示します。

並べ替えをサポートする型を実装する方法を次のコード例に示します。SortingData クラスの SelectMethod は、sortExpression パラメータを受け取ります。SelectMethod に渡される文字列は、SelectMethod によって返される DataView オブジェクトの Sort プロパティで使用されます。

並べ替え式を実装する方法を次のコード例に示します。Web ページのコードによって、ObjectDataSource コントロールのインスタンスを作成します。TypeName プロパティが SortingData に設定され、SortParameterName プロパティが sortExpression に設定されます。GridView コントロールの AllowSorting プロパティが true に設定されます。ユーザーが [Sort] ボタンをクリックすると、フィールド名である Name または Number が並べ替えパラメータの選択メソッドに渡されます。

Visual Basic

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.VB"
 Assembly="Samples.AspNet.VB"
 %>
<%@ 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">

</script>

<html  >
<head id="Head1" runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:GridView ID="GridView1" 
            runat="server" 
            DataSourceID="ObjectDataSource1"
            AllowSorting="True">
        </asp:GridView>
        <asp:ObjectDataSource 
            ID="ObjectDataSource1" 
            runat="server" 
            SelectMethod="SelectMethod" 
            TypeName="Samples.AspNet.VB.SortingData"
 
            SortParameterName="sortExpression">
        </asp:ObjectDataSource>
    </div>
    </form>
</body>
</html>

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS"
 Assembly="Samples.AspNet.CS" %>
<%@ 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">

</script>

<html  >
<head id="Head1" runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:GridView ID="GridView1" 
            runat="server" 
            DataSourceID="ObjectDataSource1"
            AllowSorting="True">
        </asp:GridView>
        <asp:ObjectDataSource 
            ID="ObjectDataSource1" 
            runat="server" 
            SelectMethod="SelectMethod" 
            TypeName="Samples.AspNet.CS.SortingData" 
            SortParameterName="sortExpression">
        </asp:ObjectDataSource>
    </div>
    </form>
</body>
</html>