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

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

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

ObjectDataSourceView.SelectMethod プロパティ

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

データを取得するために ObjectDataSourceView コントロールが呼び出すメソッドまたは関数の名前を取得または設定します。

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

Visual Basic (宣言)

Public Property SelectMethod As
 String

Visual Basic (使用法)

Dim instance As ObjectDataSourceView
Dim value As String

value = instance.SelectMethod

instance.SelectMethod = value

public string SelectMethod { get;
 set; }

C++

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

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

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

JScript

public function get SelectMethod
 () : String

public function set SelectMethod
 (value : String)

プロパティ値
データを取得するために ObjectDataSourceView が使用するメソッドまたは関数の名前を表す文字列。既定値は空の文字列 ("") です。

解説

指定したメソッドには、任意のメソッドシグネチャを設定できますが、ObjectDataSource コントロールが呼び出しに成功するには、次の表に記載されているいずれかの型を返す必要があります。

戻り値の型	アクション
IEnumerable	IEnumerable は、Select メソッドから返されます。
DataTable	DataView は DataTable を使用して作成され、Select メソッドから返されます。
DataSet	DataSet の最初の DataTable が抽出され、DataView が作成されて Select メソッドから返されます。
Object	このオブジェクトは、要素が 1 つの IEnumerable 内にラップされ、Select メソッドから返されます。

SelectMethod プロパティで指定するメソッドには、インスタンスのメソッド、つまり static (Visual Basic の場合は Shared) なメソッドを指定できます。インスタンスメソッドの場合は、SelectMethod メソッドが呼び出されるたびにビジネスオブジェクトが作成され、破棄されます。ObjectCreated イベントを処理することで、SelectMethod プロパティで指定したメソッドを呼び出す前にビジネスオブジェクトに対して作業を実行できます。SelectMethod プロパティで指定されたメソッドが呼び出された後に発生する ObjectDisposing イベントを処理することもできます (Dispose は、ビジネスオブジェクトが IDisposable インターフェイスを実装する場合にだけ呼び出されます)。メソッドが static (Visual Basic では Shared) なメソッドである場合は、ビジネスオブジェクトが作成されないので、これらのイベントを処理できません。

ObjectDataSource コントロールを扱うビジネスオブジェクトが複数のメソッドまたは関数を同じ名前で実装すると (メソッドのオーバーロード)、データソースコントロールは、SelectParameters コレクションのパラメータなどの一連の条件に従って適切なものを呼び出そうとします。SelectParameters コレクション内のパラメータが、SelectMethod プロパティで指定されたメソッドシグネチャのパラメータと一致しない場合、データソースは例外をスローします。

詳細については、ObjectDataSource.SelectMethod のトピックを参照してください。

使用例

GridView コントロールが Web フォームページ上の ObjectDataSource コントロールを使用してデータを表示する方法を次のコード例に示します。ObjectDataSource は、その TypeName プロパティおよびデータ取得メソッド (SelectMethod プロパティを使用) を使用して、部分修飾または完全修飾クラス名を識別します。実行時にオブジェクトが作成され、メソッドはリフレクションを使用して呼び出されます。GridView コントロールは、SelectMethod によって返された IEnumerable コレクションに対して列挙処理を実行し、データを表示します。

Visual Basic

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.VB"
 Assembly="Samples.AspNet.VB"
 %>
<%@ Page language="vb" %>
<html>
  <head>
    <title>ObjectDataSource - Visual Basic Example</title>
  </head>
  <body>
    <form id="Form1" method="post"
 runat="server">

        <asp:gridview
          id="GridView1"
          runat="server"
          datasourceid="ObjectDataSource1" />

        <asp:objectdatasource
          id="ObjectDataSource1"
          runat="server"
          selectmethod="GetAllEmployees"
          typename="Samples.AspNet.VB.EmployeeLogic"
 />

    </form>
  </body>
</html>

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS"
 Assembly="Samples.AspNet.CS" %>
<%@ Page language="c#" %>
<html>
  <head>
    <title>ObjectDataSource - C# Example</title>
  </head>
  <body>
    <form id="Form1" method="post" runat="server">

        <asp:gridview
          id="GridView1"
          runat="server"
          datasourceid="ObjectDataSource1" />

        <asp:objectdatasource
          id="ObjectDataSource1"
          runat="server"
          selectmethod="GetAllEmployees"
          typename="Samples.AspNet.CS.EmployeeLogic" />

    </form>
  </body>
</html>

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.JSL"
 Assembly="Samples.AspNet.JSL" %>
<%@ Page language="VJ#" %>
<html>
  <head>
    <title>ObjectDataSource - VJ# Example</title>
  </head>
  <body>
    <form id="Form1" method="post" runat="server">

        <asp:gridview
          id="GridView1"
          runat="server"
          datasourceid="ObjectDataSource1" />

        <asp:objectdatasource
          id="ObjectDataSource1"
          runat="server"
          selectmethod="GetAllEmployees"
          typename="Samples.AspNet.JSL.EmployeeLogic" />

    </form>
  </body>
</html>