DataColumn.AutoIncrement プロパティ

  • リファレンス

定義

名前空間:
System.Data
アセンブリ:
System.Data.Common.dll
アセンブリ:
System.Data.dll
アセンブリ:
netstandard.dll
ソース:
DataColumn.cs
ソース:
DataColumn.cs
ソース:
DataColumn.cs

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

public:
 property bool AutoIncrement { bool get(); void set(bool value); };
public bool AutoIncrement { get; set; }
[System.Data.DataSysDescription("DataColumnAutoIncrementDescr")]
public bool AutoIncrement { get; set; }
member this.AutoIncrement : bool with get, set
[<System.Data.DataSysDescription("DataColumnAutoIncrementDescr")>]
member this.AutoIncrement : bool with get, set
Public Property AutoIncrement As Boolean

プロパティ値

Boolean

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

属性
DataSysDescriptionAttribute

例外

ArgumentException

この列は計算列です。

例

次の例では、および の各プロパティをAutoIncrementAutoIncrementSeedAutoIncrementStep設定します。

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

Private Sub AddAutoIncrementColumn()
    Dim column As 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

注釈

このプロパティを設定するときに、この列の型が Int16、Int32、または Int64 でない場合、 DataType プロパティは Int32 に強制的に適用されます。 これが計算列の場合、例外が生成されます。 プロパティが Expression 設定されています。 増分値は、列コレクションに追加されるときに、この列の行の値が既定値と等しい場合にのみ使用されます。

クラスの プロパティを使用して新しい行をItemArrayDataRow作成し、値の配列を渡すことができます。 これは、値が自動的に生成されるため、 が にtrue設定されている列AutoIncrementの潜在的な問題です。 プロパティを ItemArray 使用するには、配列内の列の位置に を配置 null します。 詳しくは、DataRow クラスの ItemArray プロパティを参照してください。

列の型が または SqlInt32AutoIncrement の場合はSqlInt16機能しません。 代わりに Int16 または Int32 を使用してください。

列の型が または SqlDecimalAutoIncrement の場合はSqlInt64、部分的にのみ機能します。 代わりに Int64 または Decimal を使用してください。

値が現在の AutoIncrementStep 値に追加されると、オーバーフロー チェックは抑制されます。

適用対象

こちらもご覧ください