ForeignKey Members
The ForeignKey object represents a Microsoft SQL Server foreign key.
The following tables list the members exposed by the ForeignKey type.
Public Constructors
| Name | Description | |
|---|---|---|
| ForeignKey | Overloaded. Initializes a new instance of the ForeignKey class. |
Top
Protected Fields
| Name | Description | |
|---|---|---|
.gif "ms219530.protfield(en-US,SQL.90).gif") |
m_ExtendedProperties | (inherited from SqlSmoObject ) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "ms219530.pubproperty(en-US,SQL.90).gif") |
Columns | Represents a collection of Column objects. Each Column object represents a column included in the foreign key. |
|
CreateDate | Gets the date and time when the foreign key was created. |
|
DateLastModified | Gets the date and time when the foreign key was last modified. |
|
DeleteAction | Gets or sets the action taken when the row that is referenced by the foreign key is deleted. |
|
ExtendedProperties | Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property on the ForeignKey object. |
|
ID | Gets the ID value that uniquely identifies the foreign key. |
|
IsChecked | Gets or sets the Boolean property value that specifies whether the foreign key constraint was enabled without checking existing rows. |
|
IsEnabled | Gets or sets the Boolean property value that specifies whether the foreign key is enabled. |
|
IsSystemNamed | Gets the Boolean property value that specifies whether the foreign key is named by the system or by the user. |
|
Name | Gets or sets the name of the object. (inherited from NamedSmoObject) |
|
NotForReplication | Gets the Boolean property value that specifies whether the foreign key is available for replication. |
|
Parent | Gets or sets the Table object that is the parent of the ForeignKey object. |
|
Properties | Gets a collection of Property objects that represent the object properties. (inherited from SqlSmoObject) |
|
ReferencedKey | Gets the primary key referenced by the foreign key. |
|
ReferencedTable | Gets or sets the table that contains the primary key referenced by the foreign key. |
|
ReferencedTableSchema | Gets or sets the table schema that contains the primary key referenced by the foreign key. |
|
ScriptReferencedTable | Gets or sets the Boolean value that specifies whether to script the table referenced by the foreign key. |
|
ScriptReferencedTableSchema | Gets or sets the Boolean value that specifies whether to script the schema of the table referenced by the foreign key. |
|
State | Gets the state of the referenced object. (inherited from SmoObjectBase) |
|
UpdateAction | Gets or sets the Boolean property value that specifies whether the foreign key supports cascading updates. |
|
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (inherited from SqlSmoObject) |
|
UserData | Gets or sets user-defined data associated with the referenced object. (inherited from SmoObjectBase) |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms219530.protproperty(en-US,SQL.90).gif") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject) |
|
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject) |
|
PresetProperties | Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject) |
|
ScalarResult | Gets the scalar result for the referenced object. (inherited from SqlSmoObject) |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms219530.pubmethod(en-US,SQL.90).gif") |
Alter | Updates any ForeignKey object property changes on instance of Microsoft SQL Server. |
|
Create | Creates a foreign key on the instance of Microsoft SQL Server as defined by the ForeignKey object. |
|
Drop | Drops the foreign key. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Initialize | Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject) |
|
MarkForDrop | Marks the foreign key to be dropped the next time its parent Table object is altered by the Alter method. |
.gif "ms219530.static(en-US,SQL.90).gif") |
ReferenceEquals | (inherited from Object ) |
|
Refresh | Refreshes the script name. (inherited from ScriptNameObjectBase) |
|
Script | Overloaded. Generates a Transact-SQL script that can be used to re-create the foreign key. |
|
ToString | Returns a String that represents the referenced object. (inherited from SqlSmoObject) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms219530.protmethod(en-US,SQL.90).gif") |
AlterImpl | (inherited from SqlSmoObject ) |
|
AlterImplFinish | (inherited from SqlSmoObject ) |
|
AlterImplInit | (inherited from SqlSmoObject ) |
|
AlterImplWorker | (inherited from SqlSmoObject ) |
|
AppendCommaText | (inherited from ScriptNameObjectBase ) |
|
AppendWithCommaText | (inherited from ScriptNameObjectBase ) |
|
AppendWithOption | (inherited from ScriptNameObjectBase ) |
|
BindDefaultImpl | (inherited from SqlSmoObject ) |
|
BindRuleImpl | (inherited from SqlSmoObject ) |
|
CheckCollation | (inherited from SqlSmoObject ) |
|
CheckObjectState | Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject) |
|
CheckObjectStateImpl | (inherited from SqlSmoObject ) |
|
CheckTextCorectness | (inherited from ScriptNameObjectBase ) |
|
CheckTextModeSupport | (inherited from ScriptNameObjectBase ) |
|
CheckVersion80 | Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject) |
|
CheckVersion80SP3 | Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject) |
|
CheckVersion90 | Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject) |
|
CheckVersionBelow90 | (inherited from SqlSmoObject ) |
|
CleanObject | Cleans the referenced object. (inherited from ScriptNameObjectBase) |
|
CreateImpl | (inherited from SqlSmoObject ) |
|
CreateImplFinish | (inherited from SqlSmoObject ) |
|
CreateImplInit | (inherited from SqlSmoObject ) |
|
DropImpl | (inherited from SqlSmoObject ) |
|
DropImplWorker | (inherited from SqlSmoObject ) |
|
Finalize | (inherited from Object ) |
|
ForceTextModeOnTextBody | Enforces text mode on the text body. (inherited from ScriptNameObjectBase) |
|
FormatSqlVariant | (inherited from SqlSmoObject ) |
|
GenerateDataSpaceScript | (inherited from SqlSmoObject ) |
|
GetBindDefaultScript | (inherited from SqlSmoObject ) |
|
GetBindRuleScript | (inherited from SqlSmoObject ) |
|
GetBoolParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetBraketNameForText | (inherited from ScriptNameObjectBase ) |
|
GetDateTimeParameter | (inherited from SqlSmoObject ) |
|
GetDateTimeParameterAsInt | (inherited from SqlSmoObject ) |
|
GetDBName | Gets the database name associated with the object. (inherited from SqlSmoObject) |
|
GetEnumParameter | (inherited from SqlSmoObject ) |
|
GetFragOptionString | (inherited from SqlSmoObject ) |
|
GetGuidParameter | (inherited from SqlSmoObject ) |
|
GetIsTextDirty | Determines whether the text value is consistent with stored value. (inherited from ScriptNameObjectBase) |
|
GetParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetPropValue | (inherited from SqlSmoObject ) |
|
GetPropValueOptional | (inherited from SqlSmoObject ) |
|
GetPropValueOptionalAllowNull | (inherited from SqlSmoObject ) |
|
GetRealValue | (inherited from SqlSmoObject ) |
|
GetScriptIncludeExists | (inherited from ScriptNameObjectBase ) |
|
GetScriptingOptionsForCreate | (inherited from SqlSmoObject ) |
|
GetServerName | Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetSqlServerVersionName | Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetStringParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetTextBody | Overloaded. Returns the text body. (inherited from ScriptNameObjectBase) |
|
GetTextForScript | (inherited from ScriptNameObjectBase ) |
|
GetTextHeader | (inherited from ScriptNameObjectBase ) |
|
GetTextMode | Determines whether the script name is using text mode. (inherited from ScriptNameObjectBase) |
|
GetTextProperty | (inherited from ScriptNameObjectBase ) |
|
GetTimeSpanParameterAsInt | (inherited from SqlSmoObject ) |
|
GetUrnRecursive | Overloaded. (inherited from SqlSmoObject ) |
|
ImplInitialize | (inherited from SqlSmoObject ) |
|
IsCollectionDirty | (inherited from SqlSmoObject ) |
|
IsObjectDirty | Determines whether the referenced object is consistent with the stored object. (inherited from ScriptNameObjectBase) |
|
IsObjectInitialized | Verifies whether the object has been initialized. (inherited from SqlSmoObject) |
|
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of Microsoft SQL Server. (inherited from SqlSmoObject) |
|
IsVersion80SP3 | (inherited from SqlSmoObject ) |
|
MarkDropped | (inherited from SqlSmoObject ) |
|
MarkForDropImpl | (inherited from SqlSmoObject ) |
|
MemberwiseClone | (inherited from Object ) |
|
PostAlter | (inherited from SqlSmoObject ) |
|
PostCreate | (inherited from SqlSmoObject ) |
|
PostDrop | (inherited from SqlSmoObject ) |
|
RenameImpl | (inherited from NamedSmoObject ) |
|
RenameImplWorker | (inherited from NamedSmoObject ) |
|
ScriptAlter | (inherited from SqlSmoObject ) |
|
ScriptAnsiQI | (inherited from ScriptNameObjectBase ) |
|
ScriptChangeOwner | (inherited from NamedSmoObject ) |
|
ScriptCreate | (inherited from SqlSmoObject ) |
|
ScriptDdl | (inherited from SqlSmoObject ) |
|
ScriptDrop | (inherited from SqlSmoObject ) |
|
ScriptImpl | Overloaded. (inherited from SqlSmoObject ) |
|
ScriptImplWorker | (inherited from SqlSmoObject ) |
|
ScriptInformativeHeaders | (inherited from ScriptNameObjectBase ) |
|
ScriptRename | (inherited from NamedSmoObject ) |
|
SetCollectionTextMode | (inherited from ScriptNameObjectBase ) |
|
SetParentImpl | (inherited from SqlSmoObject ) |
|
SetTextBody | (inherited from ScriptNameObjectBase ) |
|
SetTextHeader | (inherited from ScriptNameObjectBase ) |
|
SetTextMode | (inherited from ScriptNameObjectBase ) |
|
SwitchTextMode | (inherited from ScriptNameObjectBase ) |
|
ThrowIfTextIsDirtyForAlter | (inherited from ScriptNameObjectBase ) |
|
Trace | (inherited from SqlSmoObject ) |
|
UnbindDefaultImpl | (inherited from SqlSmoObject ) |
|
UnbindRuleImpl | (inherited from SqlSmoObject ) |
|
UpdateCollectionState2 | (inherited from SqlSmoObject ) |
Top
See Also
Reference
ForeignKey Class
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
Creating, Altering, and Removing Foreign Keys
Creating and Modifying FOREIGN KEY Constraints
CREATE TABLE (Transact-SQL)