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

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

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

DataObjectFieldAttribute クラス

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

データフィールドを表すプロパティのメタデータを提供します。このクラスは継承できません。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class
 DataObjectFieldAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As DataObjectFieldAttribute

[AttributeUsageAttribute(AttributeTargets.Property)] 
public sealed class DataObjectFieldAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Property)] 
public ref class DataObjectFieldAttribute sealed
 : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
public final class DataObjectFieldAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Property) 
public final class DataObjectFieldAttribute
 extends Attribute

解説

基になるデータのスキーマに関する情報を提供するには、DataObjectFieldAttribute 属性を使用します。ObjectDataSourceDesigner クラスなどのデザイン時のクラスは、デザイン時に DataObjectAttribute 属性を使用し、公開されたスキーマに基づいてプロパティを設定します。

DataObjectAttribute 属性でマークされたオブジェクトの Select メソッドで返されるデータ項目のオブジェクトのメンバに、DataObjectFieldAttribute 属性を適用します。次の例では、NorthwindData クラスが DataObjectAttribute 属性でマークされ、NorthwindEmployee オブジェクトが格納された IEnumerable オブジェクトが GetAllEmployees メソッドから返されます。NorthwindEmployee クラスのフィールドが DataObjectFieldAttribute 属性でマークされ、それらが、基になるデータソースのデータフィールドを表していることを示します。

属性の使用方法については、「属性を使用したメタデータの拡張」を参照してください。

使用例

パブリックに公開されたプロパティに DataObjectFieldAttribute を適用し、プロパティに関連付けられたメタデータを識別する方法を次のコード例に示します。この例では、NorthwindEmployee 型で、EmployeeID、FirstName、および LastName の 3 つのデータのプロパティを公開します。DataObjectFieldAttribute 属性は 3 つすべてのプロパティに適用されますが、EmployeeID プロパティの属性だけが、これがデータ行の主キーであることを示します。

Visual Basic

Public Class NorthwindEmployee

  Public Sub New()
  End Sub 'New 

  Private _employeeID As Integer
  <DataObjectFieldAttribute(True, True,
 False)> _
  Public Property EmployeeID() As
 Integer
    Get
      Return _employeeID
    End Get
    Set(ByVal value As Integer)
      _employeeID = value
    End Set
  End Property

  Private _firstName As String
 = String.Empty
  <DataObjectFieldAttribute(False, False,
 False)> _
  Public Property FirstName() As
 String
    Get
      Return _firstName
    End Get
    Set(ByVal value As String)
      _firstName = value
    End Set
  End Property

  Private _lastName As String
 = String.Empty
  <DataObjectFieldAttribute(False, False,
 False)> _
  Public Property LastName() As
 String
    Get
      Return _lastName
    End Get
    Set(ByVal value As String)
      _lastName = value
    End Set
  End Property

End Class 'NorthwindEmployee

public class NorthwindEmployee
{
  public NorthwindEmployee() { }

  private int _employeeID;
  [DataObjectFieldAttribute(true, true, false)]
  public int EmployeeID
  {
    get { return _employeeID; }
    set { _employeeID = value; }
  }

  private string _firstName = String.Empty;
  [DataObjectFieldAttribute(false, false, true)]
  public string FirstName
  {
    get { return _firstName; }
    set { _firstName = value; }
  }

  private string _lastName = String.Empty;
  [DataObjectFieldAttribute(false, false, true)]
  public string LastName
  {
    get { return _lastName; }
    set { _lastName = value; }
  }
}