Synonym Synonym Synonym Class

Definition

The Synonym object represents a SQL Server synonym.

public ref class Synonym sealed : Microsoft::SqlServer::Management::Smo::ScriptSchemaObjectBase, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDropIfExists, Microsoft::SqlServer::Management::Common::IDroppable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcSupportsDesignMode, Microsoft::SqlServer::Management::Smo::IExtendedProperties, Microsoft::SqlServer::Management::Smo::IObjectPermission, Microsoft::SqlServer::Management::Smo::IScriptable
[Microsoft.SqlServer.Management.Facets.EvaluationMode(Microsoft.SqlServer.Management.Dmf.AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElement(Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.Standalone | Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.SqlAzureDatabase)]
[Microsoft.SqlServer.Management.Sdk.Sfc.PhysicalFacet]
public sealed class Synonym : Microsoft.SqlServer.Management.Smo.ScriptSchemaObjectBase, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDropIfExists, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcSupportsDesignMode, Microsoft.SqlServer.Management.Smo.IExtendedProperties, Microsoft.SqlServer.Management.Smo.IObjectPermission, Microsoft.SqlServer.Management.Smo.IScriptable
Public NotInheritable Class Synonym
Inherits ScriptSchemaObjectBase
Implements IAlterable, ICreatable, IDropIfExists, IDroppable, IExtendedProperties, IObjectPermission, IScriptable, ISfcSupportsDesignMode
Inheritance
Attributes
Microsoft.SqlServer.Management.Facets.EvaluationModeAttribute Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementAttribute PhysicalFacetAttribute
Implements
Microsoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterable Microsoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatable Microsoft.SqlServer.Management.Common.IDropIfExistsMicrosoft.SqlServer.Management.Common.IDropIfExistsMicrosoft.SqlServer.Management.Common.IDropIfExists Microsoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppable ISfcSupportsDesignModeISfcSupportsDesignModeISfcSupportsDesignMode IExtendedPropertiesIExtendedPropertiesIExtendedProperties IObjectPermissionIObjectPermissionIObjectPermission IScriptableIScriptableIScriptable

Examples

Remarks

The Synonym object provides programmatic access to synonyms. Synonyms can be used to create an alternative name for any SQL Server object.

Constructors

Synonym() Synonym() Synonym()

Initializes a new instance of the Synonym class.

Synonym(Database, String) Synonym(Database, String) Synonym(Database, String)

Initializes a new instance of the Synonym class on the specified database and with the specified name.

Synonym(Database, String, String) Synonym(Database, String, String) Synonym(Database, String, String)

Initializes a new instance of the Synonym class on the specified database and with the specified name and schema.

Synonym(Database, String, String, String, String, String) Synonym(Database, String, String, String, String, String) Synonym(Database, String, String, String, String, String)

Initializes a new instance of the Synonym class on the specified database and with the specified name, and base object.

Synonym(Database, String, String, String, String, String, String) Synonym(Database, String, String, String, String, String, String) Synonym(Database, String, String, String, String, String, String)

Initializes a new instance of the Synonym class on the specified database and with the specified name, schema, and base object.

Properties

BaseDatabase BaseDatabase BaseDatabase

Gets or sets the base database on which the base object resides.

BaseObject BaseObject BaseObject

Gets or sets the base object for which the synonym is defined.

BaseSchema BaseSchema BaseSchema

Gets or sets the schema of the base object.

BaseServer BaseServer BaseServer

Gets or sets the instance of SQL Server on which the base object resides.

BaseType BaseType BaseType

Specifies the type of the Synonym object.

CreateDate CreateDate CreateDate

Gets the date and time when the synonym was created.

DateLastModified DateLastModified DateLastModified

Gets the date and time when the synonym was last modified.

Events Events Events

Gets the events that are supported by the synonym.

ExecuteForScalar ExecuteForScalar ExecuteForScalar

Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option.

(Inherited from SqlSmoObject)
ExecutionManager ExecutionManager ExecutionManager

Gets the object to execute to the manager.

(Inherited from SqlSmoObject)
ExtendedProperties ExtendedProperties ExtendedProperties

Represents a collection of ExtendedProperty objects that contain information about the extended properties of the Synonym object.

ID ID ID

Gets the ID value that uniquely identifies the synonym.

IsSchemaOwned IsSchemaOwned IsSchemaOwned

Gets a Boolean value that specifies whether the Synonym object is owned by a schema.

IsTouched IsTouched IsTouched

Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server.

(Inherited from SqlSmoObject)
Name Name Name

Gets or sets a String value that specifies the name of the synonym.

ObjectInSpace ObjectInSpace ObjectInSpace

Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
Owner Owner Owner

Gets or sets the owner of the Synonym.

Parent Parent Parent

Gets the Database object that is the parent of the Synonym object.

Properties Properties Properties

Gets a collection of Property objects that represent the object properties.

(Inherited from SqlSmoObject)
ScalarResult ScalarResult ScalarResult

Gets the scalar result for the referenced object.

(Inherited from SqlSmoObject)
Schema Schema Schema

Gets or sets a String value that specifies the name of the schema that contains the synonym.

State State State

Gets the state of the referenced object.

(Inherited from SmoObjectBase)
Urn Urn Urn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.

(Inherited from SqlSmoObject)
UserData UserData UserData

Gets or sets user-defined data associated with the referenced object.

(Inherited from SmoObjectBase)

Methods

AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection)

Add the database context to the collection of queries identified by the queries parameter.

(Inherited from SqlSmoObject)
Alter() Alter() Alter()

Updates any Synonym object property changes on the instance of SQL Server.

AlterImpl() AlterImpl() AlterImpl()

Activates the object altered event.

(Inherited from SqlSmoObject)
AlterImplWorker() AlterImplWorker() AlterImplWorker()

Calls the Alter methods.

(Inherited from SqlSmoObject)
AppendCommaText(StringBuilder, String, Boolean, String) AppendCommaText(StringBuilder, String, Boolean, String) AppendCommaText(StringBuilder, String, Boolean, String)

Appends text, optionally separated by a comma.

(Inherited from ScriptNameObjectBase)
AppendWithCommaText(StringBuilder, String, Boolean) AppendWithCommaText(StringBuilder, String, Boolean) AppendWithCommaText(StringBuilder, String, Boolean)

Appends text, optionally separated by a comma.

(Inherited from ScriptNameObjectBase)
AppendWithOption(StringBuilder, String, String, Boolean) AppendWithOption(StringBuilder, String, String, Boolean) AppendWithOption(StringBuilder, String, String, Boolean)

Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma.

(Inherited from ScriptNameObjectBase)
AutoGenerateName() AutoGenerateName() AutoGenerateName()

Generates a name automatically based on the object Guid.

(Inherited from ScriptNameObjectBase)
BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean)

Binds the default items identified by the parameters.

(Inherited from SqlSmoObject)
BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean)

Binds the rule schema to the rule and columns identified by the parameters.

(Inherited from SqlSmoObject)
CheckObjectDirty() CheckObjectDirty() CheckObjectDirty()

Checks whether object has been modified and not persisted.

(Inherited from ScriptNameObjectBase)
CheckObjectState() CheckObjectState() CheckObjectState()

Validates the state of the referenced object.

(Inherited from SqlSmoObject)
CheckObjectState(Boolean) CheckObjectState(Boolean) CheckObjectState(Boolean)

Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created.

(Inherited from SqlSmoObject)
CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean)

Checks the state of a SqlSmoObject.

(Inherited from SqlSmoObject)
CheckTextCorectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo) CheckTextCorectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo) CheckTextCorectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo)

Checks text for correctness against the parameters.

(Inherited from ScriptNameObjectBase)
CheckTextModeSupport() CheckTextModeSupport() CheckTextModeSupport()

Checks mode of support.

(Inherited from ScriptNameObjectBase)
CleanObject() CleanObject() CleanObject()

Cleans the referenced object.

(Inherited from ScriptNameObjectBase)
Create() Create() Create()

Creates a synonym on the instance of SQL Server as defined by the Synonym object.

CreateImpl() CreateImpl() CreateImpl()

Creates an object with scripting options.

(Inherited from SqlSmoObject)
Deny(ObjectPermissionSet, String) Deny(ObjectPermissionSet, String) Deny(ObjectPermissionSet, String)

Denies the specified set of permissions for the specified grantee on the synonym.

Deny(ObjectPermissionSet, String, Boolean) Deny(ObjectPermissionSet, String, Boolean) Deny(ObjectPermissionSet, String, Boolean)

Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the synonym.

Deny(ObjectPermissionSet, String[]) Deny(ObjectPermissionSet, String[]) Deny(ObjectPermissionSet, String[])

Denies the specified set of permissions for the specified grantees on the synonym.

Deny(ObjectPermissionSet, String[], Boolean) Deny(ObjectPermissionSet, String[], Boolean) Deny(ObjectPermissionSet, String[], Boolean)

Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the synonym.

Discover() Discover() Discover()

Discovers a list of type Object.

(Inherited from SqlSmoObject)
Drop() Drop() Drop()

Removes the synonym from the instance of SQL Server.

DropIfExists() DropIfExists() DropIfExists()

Drops the Synonym object if exists.

DropImpl(Boolean) DropImpl(Boolean) DropImpl(Boolean)

Drops a SqlSmoObject.

(Inherited from SqlSmoObject)
DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean)

Drops the IMPL worker.

(Inherited from SqlSmoObject)
EnumObjectPermissions() EnumObjectPermissions() EnumObjectPermissions()

Enumerates a list of object permissions for the synonym.

EnumObjectPermissions(ObjectPermissionSet) EnumObjectPermissions(ObjectPermissionSet) EnumObjectPermissions(ObjectPermissionSet)

Enumerates a list of object permissions for a specified permission on the synonym.

EnumObjectPermissions(String) EnumObjectPermissions(String) EnumObjectPermissions(String)

Enumerates a list of object permissions for a specified grantee on the synonym.

EnumObjectPermissions(String, ObjectPermissionSet) EnumObjectPermissions(String, ObjectPermissionSet) EnumObjectPermissions(String, ObjectPermissionSet)

Enumerates a list of object permissions for a specified grantee and a specified permission on the synonym.

ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean)

Executes a batch of statements that does not return a result set.

(Inherited from SqlSmoObject)
ExecuteRenameQuery(String) ExecuteRenameQuery(String) ExecuteRenameQuery(String)

Executes the rename query for the object.

(Inherited from NamedSmoObject)
ForceTextModeOnTextBody() ForceTextModeOnTextBody() ForceTextModeOnTextBody()

Enforces text mode on the text body.

(Inherited from ScriptNameObjectBase)
FormatSqlVariant(Object) FormatSqlVariant(Object) FormatSqlVariant(Object)

Formats an object as Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.

(Inherited from SqlSmoObject)
GenerateAlterEvent() GenerateAlterEvent() GenerateAlterEvent()

Generates the alter event with the specified value.

(Inherited from SqlSmoObject)
GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object)

Generates alter event with the specified URN and inner object value.

(Inherited from SqlSmoObject)
GetBraketNameForText() GetBraketNameForText() GetBraketNameForText()

Gets the bracket name for the text.

(Inherited from ScriptNameObjectBase)
GetContextDB() GetContextDB() GetContextDB()

Gets the context database that is associated with this object.

(Inherited from SqlSmoObject)
GetDBName() GetDBName() GetDBName()

Gets the database name that is associated with the object.

(Inherited from SqlSmoObject)
GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption)

Gets a FragmentationOption object as a string value.

(Inherited from SqlSmoObject)
GetIsSystemNamed() GetIsSystemNamed() GetIsSystemNamed()

Indicates a value that specifies whether the system is named.

(Inherited from ScriptNameObjectBase)
GetIsTextDirty() GetIsTextDirty() GetIsTextDirty()

Determines whether the text value is consistent with stored value.

(Inherited from ScriptNameObjectBase)
GetPropValue(String) GetPropValue(String) GetPropValue(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptional(String) GetPropValueOptional(String) GetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetRealValue(Property, Object) GetRealValue(Property, Object) GetRealValue(Property, Object)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetServerName() GetServerName() GetServerName()

Gets the name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetServerObject() GetServerObject() GetServerObject()

Gets the server of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetSqlServerVersionName() GetSqlServerVersionName() GetSqlServerVersionName()

Gets the version name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetTextBody() GetTextBody() GetTextBody()

Returns the text body.

(Inherited from ScriptNameObjectBase)
GetTextBody(Boolean) GetTextBody(Boolean) GetTextBody(Boolean)

Returns the text body.

(Inherited from ScriptNameObjectBase)
GetTextHeader(Boolean) GetTextHeader(Boolean) GetTextHeader(Boolean)

Returns the text header.

(Inherited from ScriptNameObjectBase)
GetTextMode() GetTextMode() GetTextMode()

Determines whether the script name is using text mode.

(Inherited from ScriptNameObjectBase)
GetTextProperty(String) GetTextProperty(String) GetTextProperty(String)

Gets the text of the object, if not available, throw appropriate exception based on the state of the object.

(Inherited from ScriptNameObjectBase)
GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
Grant(ObjectPermissionSet, String) Grant(ObjectPermissionSet, String) Grant(ObjectPermissionSet, String)

Grants the specified set of permissions to the specified grantee on the synonym.

Grant(ObjectPermissionSet, String, Boolean) Grant(ObjectPermissionSet, String, Boolean) Grant(ObjectPermissionSet, String, Boolean)

Grants access to the specified permission to the grantee and the ability to grant access to other users on the synonym.

Grant(ObjectPermissionSet, String, Boolean, String) Grant(ObjectPermissionSet, String, Boolean, String) Grant(ObjectPermissionSet, String, Boolean, String)

Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the synonym under an assumed role.

Grant(ObjectPermissionSet, String[]) Grant(ObjectPermissionSet, String[]) Grant(ObjectPermissionSet, String[])

Grants the specified set of permissions to the specified grantees on the synonym.

Grant(ObjectPermissionSet, String[], Boolean) Grant(ObjectPermissionSet, String[], Boolean) Grant(ObjectPermissionSet, String[], Boolean)

Grants access to the specified permission to the grantees and the ability to grant access to other users on the synonym.

Grant(ObjectPermissionSet, String[], Boolean, String) Grant(ObjectPermissionSet, String[], Boolean, String) Grant(ObjectPermissionSet, String[], Boolean, String)

Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the synonym under an assumed role.

ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[])

Initializes the fields of the SqlSmoObject object.

(Inherited from SqlSmoObject)
Initialize() Initialize() Initialize()

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
Initialize(Boolean) Initialize(Boolean) Initialize(Boolean)

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
IsObjectDirty() IsObjectDirty() IsObjectDirty()

Determines whether the referenced object is consistent with the stored object.

(Inherited from ScriptNameObjectBase)
IsObjectInitialized() IsObjectInitialized() IsObjectInitialized()

Verifies whether the object has been initialized.

(Inherited from SqlSmoObject)
IsObjectInSpace() IsObjectInSpace() IsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
IsSupportedProperty(String) IsSupportedProperty(String) IsSupportedProperty(String)

Determines whether the specified property is supported in the target .NET Framework.

(Inherited from SqlSmoObject)
IsVersion80SP3() IsVersion80SP3() IsVersion80SP3()

Determines whether the version of SQL Server is SQL Server 2000 with SP3.

(Inherited from SqlSmoObject)
IsVersion90AndAbove() IsVersion90AndAbove() IsVersion90AndAbove()

Determines whether the version of SQL Server is SQL Server 2005 or later.

(Inherited from SqlSmoObject)
MarkDropped() MarkDropped() MarkDropped()

Sets the SqlSmoState to dropped.

(Inherited from SqlSmoObject)
MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean)

Sets the SqlSmoState for drop operation.

(Inherited from SqlSmoObject)
PostAlter() PostAlter() PostAlter()

The method that is activated after the SqlSmoObject is altered.

(Inherited from SqlSmoObject)
PostCreate() PostCreate() PostCreate()

The method that is activated after the SqlSmoObject is created.

(Inherited from SqlSmoObject)
PostDrop() PostDrop() PostDrop()

The method that is activated after the SqlSmoObject is dropped.

(Inherited from SqlSmoObject)
Refresh() Refresh() Refresh()

Refreshes the script name.

(Inherited from ScriptNameObjectBase)
RenameImpl(String) RenameImpl(String) RenameImpl(String)

This method supports the SMO infrastructure and is not intended to be used directly from your code.

(Inherited from NamedSmoObject)
RenameImplWorker(String) RenameImplWorker(String) RenameImplWorker(String)

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

(Inherited from NamedSmoObject)
Revoke(ObjectPermissionSet, String) Revoke(ObjectPermissionSet, String) Revoke(ObjectPermissionSet, String)

Revokes a previously granted set of permissions from a grantee on the synonym.

Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revoke(ObjectPermissionSet, String, Boolean, Boolean)

Revokes previously granted permissions from a grantee on the synonym and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.

Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)

Revokes previously granted permissions from a grantee on the synonym and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.

Revoke(ObjectPermissionSet, String[]) Revoke(ObjectPermissionSet, String[]) Revoke(ObjectPermissionSet, String[])

Revokes a previously granted set of permissions from a list of grantees on the synonym.

Revoke(ObjectPermissionSet, String[], Boolean, Boolean) Revoke(ObjectPermissionSet, String[], Boolean, Boolean) Revoke(ObjectPermissionSet, String[], Boolean, Boolean)

Revokes previously granted permissions from grantees on the synonym and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.

Revoke(ObjectPermissionSet, String[], Boolean, Boolean, String) Revoke(ObjectPermissionSet, String[], Boolean, Boolean, String) Revoke(ObjectPermissionSet, String[], Boolean, Boolean, String)

Revokes previously granted permissions from grantees on the synonym and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.

Script() Script() Script()

Generates a Transact-SQL script that can be used to re-create the synonym.

Script(ScriptingOptions) Script(ScriptingOptions) Script(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the synonym as specified by the script options.

ScriptImpl() ScriptImpl() ScriptImpl()

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions)

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
SetCollectionTextMode(Boolean, SmoCollectionBase) SetCollectionTextMode(Boolean, SmoCollectionBase) SetCollectionTextMode(Boolean, SmoCollectionBase)

Sets the collection text mode.

(Inherited from ScriptNameObjectBase)
SetIsSystemNamed(Boolean) SetIsSystemNamed(Boolean) SetIsSystemNamed(Boolean)

Specifies a value that indicates whether the system is named.

(Inherited from ScriptNameObjectBase)
SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.

(Inherited from SqlSmoObject)
SetSchemaOwned() SetSchemaOwned() SetSchemaOwned()

Sets the schema owned value for the named Smo object.

(Inherited from NamedSmoObject)
SetTextBody(String) SetTextBody(String) SetTextBody(String)

Specifies the text body.

(Inherited from ScriptNameObjectBase)
SetTextHeader(String) SetTextHeader(String) SetTextHeader(String)

Specifies the text header.

(Inherited from ScriptNameObjectBase)
SetTextMode(Boolean, SmoCollectionBase[]) SetTextMode(Boolean, SmoCollectionBase[]) SetTextMode(Boolean, SmoCollectionBase[])

Specifies the text mode.

(Inherited from ScriptNameObjectBase)
SwitchTextMode(Boolean, SmoCollectionBase[]) SwitchTextMode(Boolean, SmoCollectionBase[]) SwitchTextMode(Boolean, SmoCollectionBase[])

Switches the text mode.

(Inherited from ScriptNameObjectBase)
ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String)

Throws the object if above version 100.

(Inherited from SqlSmoObject)
ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String)

Throws SqlSmoObject if version is above 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String)

Throws exception if the version is below 100.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String)

Throws the object if the version belows 110.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String)

Throws the SqlSmoObject if version is below 110Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String)

Throws the object if the version is below 120.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String)

Throws the object if the version belows 120 property.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String)

Throws the object if the version is below 130.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String)

Throws an object if BelowVersion130Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String)

Throws the object if the version is below 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3()

Throws an exception if the version is below 80SP3.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String)

Throws the object if the version is below 90.

(Inherited from SqlSmoObject)
ThrowIfTextIsDirtyForAlter() ThrowIfTextIsDirtyForAlter() ThrowIfTextIsDirtyForAlter()

Throws an exception of text has been modified and not persisted.

(Inherited from ScriptNameObjectBase)
ToString() ToString() ToString()

Returns a String that represents the referenced object.

(Inherited from SqlSmoObject)
TouchImpl() TouchImpl() TouchImpl()

Implements a touch object.

(Inherited from SqlSmoObject)
UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean)

Unbinds the default columns of the SqlSmoObject.

(Inherited from SqlSmoObject)
UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean)

Unbinds rules of the SqlSmoObject.

(Inherited from SqlSmoObject)
Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[])

Validates the state of an object.

(Inherited from SmoObjectBase)

Explicit Interface Implementations

IAlienObject.Discover() IAlienObject.Discover() IAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot()

Returns the root of the domain.

(Inherited from SqlSmoObject)
IAlienObject.GetParent() IAlienObject.GetParent() IAlienObject.GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String)

Gets the type of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetUrn() IAlienObject.GetUrn() IAlienObject.GetUrn()

Gets the Unified Resource Name (URN) of the object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
IAlienObject.Resolve(String) IAlienObject.Resolve(String) IAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.

(Inherited from SqlSmoObject)
IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.

(Inherited from SqlSmoObject)
IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.

(Inherited from SqlSmoObject)
ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
ISfcSupportsDesignMode.IsDesignMode ISfcSupportsDesignMode.IsDesignMode ISfcSupportsDesignMode.IsDesignMode

Gets a value that indicates whether the object supports design mode.

Fields

m_ExtendedProperties m_ExtendedProperties m_ExtendedProperties

Represents a property that is defined to extend the properties provided by a SqlSmoObject.

(Inherited from SqlSmoObject)
singletonParent singletonParent singletonParent

Represents the singleton parent.

(Inherited from SqlSmoObject)

Events

PropertyChanged PropertyChanged PropertyChanged

Represents the event that occurs when a property is changed.

(Inherited from SqlSmoObject)
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged

Represents the event that occurs when property metadata changes.

(Inherited from SqlSmoObject)

Applies to