DataObjectMethodAttribute クラスとは何？わかりやすく解説 Weblio辞書

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

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

DataObjectMethodAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

型、メソッドが実行する操作の種類、およびメソッドが既定のデータメソッドであるかどうかによって公開される、データ操作メソッドを識別します。このクラスは継承できません。

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Method)> _
Public NotInheritable Class
 DataObjectMethodAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As DataObjectMethodAttribute

[AttributeUsageAttribute(AttributeTargets.Method)] 
public sealed class DataObjectMethodAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Method)] 
public ref class DataObjectMethodAttribute
 sealed : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Method) */ 
public final class DataObjectMethodAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Method) 
public final class DataObjectMethodAttribute
 extends Attribute

解説

DataObjectMethodAttribute を使用して、DataObjectAttribute 属性でマークされている型のデータ操作メソッドを識別し、これらがリフレクションを使用して呼び出し元によって簡単に識別されるようにできます。DataObjectMethodAttribute 属性は、メソッドに適用された場合、そのメソッドによって実行される操作の種類を示し、そのメソッドが型の既定のデータ操作メソッドであるかどうかを示します。ObjectDataSource コントロールや ObjectDataSourceDesigner クラスなどのコンポーネントは、実行時に呼び出すデータメソッドを確認するために、この属性の値 (存在する場合) を調べます。

使用例

パブリックに公開されているメソッドに DataObjectMethodAttribute 属性を適用し、そのメソッドによって実行されるデータ操作の種類、およびそのメソッドがその型の既定のデータメソッドかどうかを識別する方法を次のコード例に示します。この例では、NorthwindData 型によって 2 つのデータメソッドが公開されています。1 つは GetAllEmployees という名前のデータのセットを取得するメソッドで、もう 1 つは DeleteEmployeeByID という名前のデータを削除するメソッドです。どちらのメソッドにも DataObjectMethodAttribute 属性が適用され、GetAllEmployees メソッドは Select データ操作の既定のメソッドとしてマークされ、DeleteEmployeeByID メソッドは Delete データ操作の既定のメソッドとしてマークされています。

Visual Basic

<DataObjectAttribute()> _
Public Class NorthwindData

  <DataObjectMethodAttribute(DataObjectMethodType.Select, True)>
 _
  Public Shared Function
 GetAllEmployees() As IEnumerable
    Dim ads As New AccessDataSource()
    ads.DataSourceMode = SqlDataSourceMode.DataReader
    ads.DataFile = "~/App_Data/Northwind.mdb"
    ads.SelectCommand = "SELECT EmployeeID,FirstName,LastName
 FROM Employees"
    Return ads.Select(DataSourceSelectArguments.Empty)
  End Function 'GetAllEmployees

  ' Delete the Employee by ID.
  <DataObjectMethodAttribute(DataObjectMethodType.Delete, True)>
 _
  Public Sub DeleteEmployeeByID(ByVal
 employeeID As Integer)
    Throw New Exception("The
 value passed to the delete method is " + employeeID.ToString())
  End Sub 'DeleteEmployeeByID

End Class 'NorthwindData

[DataObjectAttribute]
public class NorthwindData
{  
  public NorthwindData() {}

  [DataObjectMethodAttribute(DataObjectMethodType.Select, true)]
  public static IEnumerable GetAllEmployees()
  {
    AccessDataSource ads = new AccessDataSource();
    ads.DataSourceMode = SqlDataSourceMode.DataReader;
    ads.DataFile = "~//App_Data//Northwind.mdb";
    ads.SelectCommand = "SELECT EmployeeID,FirstName,LastName FROM Employees";
    return ads.Select(DataSourceSelectArguments.Empty);
  }

  // Delete the Employee by ID.
  [DataObjectMethodAttribute(DataObjectMethodType.Delete, true)]
  public void DeleteEmployeeByID(int
 employeeID)
  {
    throw new Exception("The value passed to the delete method
 is "
                         + employeeID.ToString());
  }
}