DataColumn.AutoIncrementStep Property

Reference

Definition

Namespace:: System.Data

Assemblies:: netstandard.dll, System.Data.Common.dll

Assembly:: System.Data.Common.dll

Assembly:: System.Data.dll

Assembly:: netstandard.dll

Source:: DataColumn.cs

Source:: DataColumn.cs

Source:: DataColumn.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the increment used by a column with its AutoIncrement property set to true.

public:
 property long AutoIncrementStep { long get(); void set(long value); };

public long AutoIncrementStep { get; set; }

[System.Data.DataSysDescription("DataColumnAutoIncrementStepDescr")]
public long AutoIncrementStep { get; set; }

member this.AutoIncrementStep : int64 with get, set

[<System.Data.DataSysDescription("DataColumnAutoIncrementStepDescr")>]
member this.AutoIncrementStep : int64 with get, set

Public Property AutoIncrementStep As Long

Property Value

Int64

The number by which the value of the column is automatically incremented. The default is 1.

Attributes: DataSysDescriptionAttribute

Exceptions

ArgumentException

The value set is zero.

Examples

The following example sets the AutoIncrement, AutoIncrementSeed, and AutoIncrementStep properties.

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

Applies to

Product	Versions
.NET	Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Share via