DataColumn.AutoIncrement Propriedade

  • Referência

Definição

Namespace:
System.Data
Assembly:
System.Data.Common.dll
Assembly:
System.Data.dll
Assembly:
netstandard.dll
Origem:
DataColumn.cs
Origem:
DataColumn.cs
Origem:
DataColumn.cs

Obtém ou define um valor que indica se a coluna incrementa automaticamente o valor da coluna para novas linhas adicionadas à tabela.

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

Valor da propriedade

Boolean

true se o valor da coluna for incrementado automaticamente; caso contrário, false. O padrão é false.

Atributos
DataSysDescriptionAttribute

Exceções

ArgumentException

A coluna é uma coluna computada.

Exemplos

O exemplo a seguir define as AutoIncrementpropriedades , AutoIncrementSeede AutoIncrementStep .

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

Comentários

Se o tipo dessa coluna não for Int16, Int32 ou Int64 quando essa propriedade for definida, a DataType propriedade será coagida a Int32. Uma exceção será gerada se esta for uma coluna computada. A Expression propriedade é definida. O valor incrementado será usado somente se o valor da linha para essa coluna, quando adicionado à coleção columns, for igual ao valor padrão.

Você pode criar uma nova linha usando a ItemArray propriedade da DataRow classe e passando uma matriz de valores. Esse é um problema potencial para uma coluna com seu AutoIncrement definido truecomo , porque seu valor é gerado automaticamente. Para usar a ItemArray propriedade , coloque null na posição da coluna na matriz . Para obter mais informações, confira a propriedade ItemArray da classe DataRow.

Se o tipo da coluna for SqlInt16 ou SqlInt32, AutoIncrement não funcionará. Em vez disso, use Int16 ou Int32.

Se o tipo da coluna for SqlInt64 ou SqlDecimal, AutoIncrement funcionará apenas parcialmente. Em vez disso, use Int64 ou Decimal.

Quando o AutoIncrementStep valor é adicionado ao valor atual, a marcar de estouro é suprimida.

Aplica-se a

Confira também