DataObjectFieldAttribute

.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

C#

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

C++

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

J#

/** @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

C#

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; }
  }
}

継承階層

System.Object
   System.Attribute
    System.ComponentModel.DataObjectFieldAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataObjectFieldAttribute メンバ
System.ComponentModel 名前空間

DataObjectFieldAttribute コンストラクタ (Boolean)

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

DataObjectFieldAttribute クラスの新しいインスタンスを初期化し、フィールドがデータ行の主キーかどうかを示します。

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

Visual Basic (宣言)

Public Sub New ( _
    primaryKey As Boolean _
)

Visual Basic (使用法)

Dim primaryKey As Boolean

Dim instance As New DataObjectFieldAttribute(primaryKey)

C#

public DataObjectFieldAttribute (
    bool primaryKey
)

C++

public:
DataObjectFieldAttribute (
    bool primaryKey
)

J#

public DataObjectFieldAttribute (
    boolean primaryKey
)

JScript

public function DataObjectFieldAttribute (
    primaryKey : boolean
)

パラメータ

primaryKey

フィールドがデータ行の主キーに含まれることを示す場合は true。それ以外の場合は false。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataObjectFieldAttribute クラス
DataObjectFieldAttribute メンバ
System.ComponentModel 名前空間

DataObjectFieldAttribute コンストラクタ (Boolean, Boolean)

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

DataObjectFieldAttribute クラスの新しいインスタンスを初期化し、フィールドがデータ行の主キーかどうか、フィールドがデータベースの ID フィールドかどうかを示します。

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

Visual Basic (宣言)

Public Sub New ( _
    primaryKey As Boolean, _
    isIdentity As Boolean _
)

Visual Basic (使用法)

Dim primaryKey As Boolean
Dim isIdentity As Boolean

Dim instance As New DataObjectFieldAttribute(primaryKey,
 isIdentity)

C#

public DataObjectFieldAttribute (
    bool primaryKey,
    bool isIdentity
)

C++

public:
DataObjectFieldAttribute (
    bool primaryKey, 
    bool isIdentity
)

J#

public DataObjectFieldAttribute (
    boolean primaryKey, 
    boolean isIdentity
)

JScript

public function DataObjectFieldAttribute (
    primaryKey : boolean, 
    isIdentity : boolean
)

パラメータ

primaryKey

フィールドがデータ行の主キーに含まれることを示す場合は true。それ以外の場合は false。

isIdentity

フィールドがデータ行を一意に識別する ID フィールドであることを示す場合は true。それ以外の場合は false。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataObjectFieldAttribute クラス
DataObjectFieldAttribute メンバ
System.ComponentModel 名前空間

DataObjectFieldAttribute コンストラクタ (Boolean, Boolean, Boolean)

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

DataObjectFieldAttribute クラスの新しいインスタンスを初期化し、フィールドがデータ行の主キーかどうか、フィールドがデータベースの ID フィールドかどうか、フィールドを null にできるかどうかを示します。

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

Visual Basic (宣言)

Public Sub New ( _
    primaryKey As Boolean, _
    isIdentity As Boolean, _
    isNullable As Boolean _
)

Visual Basic (使用法)

Dim primaryKey As Boolean
Dim isIdentity As Boolean
Dim isNullable As Boolean

Dim instance As New DataObjectFieldAttribute(primaryKey,
 isIdentity, isNullable)

C#

public DataObjectFieldAttribute (
    bool primaryKey,
    bool isIdentity,
    bool isNullable
)

C++

public:
DataObjectFieldAttribute (
    bool primaryKey, 
    bool isIdentity, 
    bool isNullable
)

J#

public DataObjectFieldAttribute (
    boolean primaryKey, 
    boolean isIdentity, 
    boolean isNullable
)

JScript

public function DataObjectFieldAttribute (
    primaryKey : boolean, 
    isIdentity : boolean, 
    isNullable : boolean
)

パラメータ

primaryKey

フィールドがデータ行の主キーに含まれることを示す場合は true。それ以外の場合は false。

isIdentity

フィールドがデータ行を一意に識別する ID フィールドであることを示す場合は true。それ以外の場合は false。

isNullable

データ ストア内でフィールドを null にできることを示す場合は true。それ以外の場合は false。

使用例

パブリックに公開されたプロパティに 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

C#

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; }
  }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataObjectFieldAttribute クラス
DataObjectFieldAttribute メンバ
System.ComponentModel 名前空間

DataObjectFieldAttribute コンストラクタ (Boolean, Boolean, Boolean, Int32)

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

DataObjectFieldAttribute クラスの新しいインスタンスを初期化し、フィールドがデータ行の主キーかどうか、データベースの ID フィールドかどうか、null にできるかどうかを示し、フィールドの長さも設定します。

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

Visual Basic (宣言)

Public Sub New ( _
    primaryKey As Boolean, _
    isIdentity As Boolean, _
    isNullable As Boolean, _
    length As Integer _
)

Visual Basic (使用法)

Dim primaryKey As Boolean
Dim isIdentity As Boolean
Dim isNullable As Boolean
Dim length As Integer

Dim instance As New DataObjectFieldAttribute(primaryKey,
 isIdentity, isNullable, length)

C#

public DataObjectFieldAttribute (
    bool primaryKey,
    bool isIdentity,
    bool isNullable,
    int length
)

C++

public:
DataObjectFieldAttribute (
    bool primaryKey, 
    bool isIdentity, 
    bool isNullable, 
    int length
)

J#

public DataObjectFieldAttribute (
    boolean primaryKey, 
    boolean isIdentity, 
    boolean isNullable, 
    int length
)

JScript

public function DataObjectFieldAttribute (
    primaryKey : boolean, 
    isIdentity : boolean, 
    isNullable : boolean, 
    length : int
)

パラメータ

primaryKey

フィールドがデータ行の主キーに含まれることを示す場合は true。それ以外の場合は false。

isIdentity

フィールドがデータ行を一意に識別する ID フィールドであることを示す場合は true。それ以外の場合は false。

isNullable

データ ストア内でフィールドを null にできることを示す場合は true。それ以外の場合は false。

length

フィールドの長さ (バイト単位)。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataObjectFieldAttribute クラス
DataObjectFieldAttribute メンバ
System.ComponentModel 名前空間

DataObjectFieldAttribute コンストラクタ

DataObjectFieldAttribute クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
DataObjectFieldAttribute (Boolean)	DataObjectFieldAttribute クラスの新しいインスタンスを初期化し、フィールドがデータ行の主キーかどうかを示します。
DataObjectFieldAttribute (Boolean, Boolean)	DataObjectFieldAttribute クラスの新しいインスタンスを初期化し、フィールドがデータ行の主キーかどうか、フィールドがデータベースの ID フィールドかどうかを示します。
DataObjectFieldAttribute (Boolean, Boolean, Boolean)	DataObjectFieldAttribute クラスの新しいインスタンスを初期化し、フィールドがデータ行の主キーかどうか、フィールドがデータベースの ID フィールドかどうか、フィールドを null にできるかどうかを示します。
DataObjectFieldAttribute (Boolean, Boolean, Boolean, Int32)	DataObjectFieldAttribute クラスの新しいインスタンスを初期化し、フィールドがデータ行の主キーかどうか、データベースの ID フィールドかどうか、null にできるかどうかを示し、フィールドの長さも設定します。

参照

関連項目

DataObjectFieldAttribute クラス
DataObjectFieldAttribute メンバ
System.ComponentModel 名前空間

DataObjectFieldAttribute プロパティ

パブリック プロパティ

	名前	説明
	IsIdentity	プロパティが、基になるデータの ID フィールドを表しているかどうかを示す値を取得します。
	IsNullable	プロパティが、基になるデータ ストア内で null にできるフィールドを表しているかどうかを示す値を取得します。
	Length	バイト単位のプロパティの長さを取得します。
	PrimaryKey	プロパティが、基になるデータの主キーに含まれるかどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

DataObjectFieldAttribute クラス
System.ComponentModel 名前空間

DataObjectFieldAttribute メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 2 つの DataObjectFieldAttribute オブジェクトが等しいかどうかを判断します。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	オーバーライドされます。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

DataObjectFieldAttribute クラス
System.ComponentModel 名前空間

DataObjectFieldAttribute メンバ

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

DataObjectFieldAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	DataObjectFieldAttribute	オーバーロードされます。 DataObjectFieldAttribute クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	IsIdentity	プロパティが、基になるデータの ID フィールドを表しているかどうかを示す値を取得します。
	IsNullable	プロパティが、基になるデータ ストア内で null にできるフィールドを表しているかどうかを示す値を取得します。
	Length	バイト単位のプロパティの長さを取得します。
	PrimaryKey	プロパティが、基になるデータの主キーに含まれるかどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 2 つの DataObjectFieldAttribute オブジェクトが等しいかどうかを判断します。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	オーバーライドされます。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

DataObjectFieldAttribute クラス
System.ComponentModel 名前空間