ForeignKey.DeleteAction Property

Article
07/16/2015

Applies To: SQL Server 2016 Preview

Gets or sets the action taken when the row that is referenced by the foreign key is deleted.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

[SfcPropertyAttribute(SfcPropertyFlags.None | SfcPropertyFlags.ReadOnlyAfterCreation | SfcPropertyFlags.Standalone | SfcPropertyFlags.SqlAzureDatabase | SfcPropertyFlags.Design | SfcPropertyFlags.Matrix)]
public ForeignKeyAction DeleteAction { get; set; }

public:
[SfcPropertyAttribute(SfcPropertyFlags::None | SfcPropertyFlags::ReadOnlyAfterCreation | SfcPropertyFlags::Standalone | SfcPropertyFlags::SqlAzureDatabase | SfcPropertyFlags::Design | SfcPropertyFlags::Matrix)]
property ForeignKeyAction DeleteAction {
    ForeignKeyAction get();
    void set(ForeignKeyAction value);
}

[<SfcPropertyAttribute(SfcPropertyFlags.None | SfcPropertyFlags.ReadOnlyAfterCreation | SfcPropertyFlags.Standalone | SfcPropertyFlags.SqlAzureDatabase | SfcPropertyFlags.Design | SfcPropertyFlags.Matrix)>]
member DeleteAction : ForeignKeyAction with get, set

<SfcPropertyAttribute(SfcPropertyFlags.None Or SfcPropertyFlags.ReadOnlyAfterCreation Or SfcPropertyFlags.Standalone Or SfcPropertyFlags.SqlAzureDatabase Or SfcPropertyFlags.Design Or SfcPropertyFlags.Matrix)>
Public Property DeleteAction As ForeignKeyAction

Property Value

Type: Microsoft.SqlServer.Management.Smo.ForeignKeyAction

A ForeignKeyAction value that specifies the action taken when the row that is referenced by the foreign key is deleted.

Remarks

The DeleteAction property can be used to specify that the action is cascaded. This means that the foreign key row is also deleted. You can also set the foreign key to the default value, or set it to Null.

Examples

Legacy Code Example

Creating, Altering, and Removing Foreign Keys