Column.IsForeignKey Property

Gets the Boolean property value that specifies whether the column is a foreign key.

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

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.None Or SfcPropertyFlags.Standalone Or SfcPropertyFlags.SqlAzureDatabase)> _
Public ReadOnly Property IsForeignKey As Boolean 
    Get
'Usage
Dim instance As Column 
Dim value As Boolean 

value = instance.IsForeignKey
[SfcPropertyAttribute(SfcPropertyFlags.None|SfcPropertyFlags.Standalone|SfcPropertyFlags.SqlAzureDatabase)]
public bool IsForeignKey { get; }
[SfcPropertyAttribute(SfcPropertyFlags::None|SfcPropertyFlags::Standalone|SfcPropertyFlags::SqlAzureDatabase)]
public:
property bool IsForeignKey {
    bool get ();
}
[<SfcPropertyAttribute(SfcPropertyFlags.None|SfcPropertyFlags.Standalone|SfcPropertyFlags.SqlAzureDatabase)>]
member IsForeignKey : bool
function get IsForeignKey () : boolean

Property Value

Type: System.Boolean
A Boolean value that specifies whether the column is a foreign key. If True, the column is a foreign key. Otherwise, False (default).

Remarks

The foreign key is the column referenced by a primary key column in another table.

Note

The value of the IsForeignKey property is always treated as false by columns based on the UserDefinedTableType object.

Examples

Working with Database Objects

See Also

Reference

Column Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Creating, Altering, and Removing Foreign Keys