DataColumn.AutoIncrement プロパティ

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

DataColumn.AutoIncrement プロパティ

このテーブルに追加される新しい行でこの列の値を自動的にインクリメントするかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Property AutoIncrement As
 Boolean

Visual Basic (使用法)

Dim instance As DataColumn
Dim value As Boolean

value = instance.AutoIncrement

instance.AutoIncrement = value

C#

public bool AutoIncrement { get;
 set; }

C++

public:
property bool AutoIncrement {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_AutoIncrement ()

/** @property */
public void set_AutoIncrement (boolean value)

JScript

public function get AutoIncrement
 () : boolean

public function set AutoIncrement
 (value : boolean)

プロパティ値
この列の値を自動的にインクリメントする場合は true。それ以外の場合は false。既定値は false です。

例外

例外の種類	条件
ArgumentException	この列は計算列です。

解説

この列の型が Int16、Int32、または Int64 のいずれでもない場合にこのプロパティが設定されているときは、DataType プロパティが強制的に Int32 に変更されます。この列が計算列の場合、例外が生成されます。Expression プロパティが設定されます。列コレクションにこの列が追加されたときにこの列の行の値が既定値と等しい場合だけ、インクリメントされた値が使用されます。

DataRow クラスの ItemArray プロパティを使用し、値の配列を渡して、新しい行を作成できます。ただし、AutoIncrement が true に設定されている列では、値が自動的に生成されるため、このプロパティを使用すると問題が発生することがあります。このため、ItemArray プロパティを使用するには、配列内のその列の位置に null 参照 (Visual Basic では Nothing) を指定してください。詳細については、DataRow クラスの ItemArray プロパティのトピックを参照してください。

使用例

AutoIncrement、AutoIncrementSeed、AutoIncrementStep の各プロパティを設定する例を次に示します。

Visual Basic

Private Sub AddAutoIncrementColumn()
    Dim column As DataColumn = New
 DataColumn
    column.DataType = System.Type.GetType("System.Int32")
    With column
        .AutoIncrement = True
        .AutoIncrementSeed = 1000
        .AutoIncrementStep = 10
    End With

    ' Add the column to a new DataTable.
    Dim table As DataTable
    table = New DataTable
    table.Columns.Add(column)
End Sub

C#

private void AddAutoIncrementColumn()
{
    DataColumn column = new DataColumn();
    column.DataType = System.Type.GetType("System.Int32");
    column.AutoIncrement = true;
    column.AutoIncrementSeed = 1000;
    column.AutoIncrementStep = 10;

    // Add the column to a new DataTable.
    DataTable table = new DataTable("table");
    table.Columns.Add(column);
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
DataColumn クラス
DataColumn メンバ
System.Data 名前空間
AutoIncrementSeed
AutoIncrementStep
Expression
ItemArray
NewRow