Article
02/08/2012

SqlSmoObject Class

The SqlSmoObject object represents all SQL Server objects.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      More...

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

Syntax

'Declaration
<TypeConverterAttribute(GetType(LocalizableTypeConverter))> _
Public MustInherit Class SqlSmoObject _
    Inherits SmoObjectBase _
    Implements ISfcPropertyProvider, ISfcNotifyPropertyMetadataChanged, INotifyPropertyChanged, IRefreshable,  _
    IAlienObject
'Usage
Dim instance As SqlSmoObject

[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
public abstract class SqlSmoObject : SmoObjectBase, 
    ISfcPropertyProvider, ISfcNotifyPropertyMetadataChanged, INotifyPropertyChanged, IRefreshable, IAlienObject

[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
public ref class SqlSmoObject abstract : public SmoObjectBase, 
    ISfcPropertyProvider, ISfcNotifyPropertyMetadataChanged, INotifyPropertyChanged, IRefreshable, IAlienObject

[<AbstractClassAttribute>]
[<TypeConverterAttribute(typeof(LocalizableTypeConverter))>]
type SqlSmoObject =  
    class
        inherit SmoObjectBase
        interface ISfcPropertyProvider
        interface ISfcNotifyPropertyMetadataChanged
        interface INotifyPropertyChanged
        interface IRefreshable
        interface IAlienObject
    end

public abstract class SqlSmoObject extends SmoObjectBase implements ISfcPropertyProvider, ISfcNotifyPropertyMetadataChanged, INotifyPropertyChanged, IRefreshable, IAlienObject

The SqlSmoObject type exposes the following members.

Constructors

	Name	Description
	SqlSmoObject	Initializes a new instance of the SqlSmoObject class.

Top

Properties

	Name	Description
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server.
	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.
	Properties	Gets a collection of Property objects that represent the object properties.
	ScalarResult	Gets the scalar result for the referenced object.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	AddDatabaseContext(StringCollection)	Add the database context to the collection of queries identified by the queries parameter.
	AddDatabaseContext(StringCollection, ScriptingOptions)	Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options.
	AlterImpl	Activates the object altered event.
	AlterImplFinish	Method called when object altered event finishes.
	AlterImplInit	Method called when object-altered event is intialized.
	AlterImplWorker	Calls the Alter methods.
	BindDefaultImpl	Binds the default items identified by the parameters.
	BindRuleImpl	Binds the rule schema to the rule and columns identified by the parameters.
	CheckCollation	Checks the order of the scripting options by the collation method identified by the collationName parameter.
	CheckObjectState()	Validates the state of the referenced object.
	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.
	CheckObjectStateImpl	Checks the state of a SqlSmoObject.
	CheckVersion100	Checks whether version of SQL Server is SQL Server 2008.
	CheckVersion80	Checks the validity of the object on SQL Server 2000.
	CheckVersion80SP3	Checks the validity of the object on SQL Server 2000 SP3.
	CheckVersion90	Check the validity of the object on SQL Server 2005.
	CheckVersionBelow90	Checks whether version of SQL Server is before SQL Server 2005.
	CleanObject	Sets the object to unmodified state.
	CreateImpl	Creates an object with scripting options.
	CreateImplFinish	Method called when the create event finishes.
	CreateImplInit	Method called when the create event initializes.
	Discover	Discovers a list of type Object.
	DropImpl	Drops a SqlSmoObject.
	DropImplWorker	Calls the drop methods.
	EnumScriptImpl	Enumerates scripts specified by the so parameter.
	EnumScriptImplWorker	Calls the methods that enumerate scripts specified by the so parameter.
	EnumScriptImplWorkerSOChanged	Returns an IEnumerable string describing the scripting options for an object.
	Equals	(Inherited from Object.)
	ExecuteNonQuery	Executes a batch in the context of the database where there are no results returned.
	Finalize	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type.
	GenerateDataSpaceFileStreamScript	Generates a script to create data file.
	GenerateDataSpaceScript	Generates a script to allocate space in the data file.
	GetBindDefaultScript	Gets the script that binds defaults specified by the defSchema and defName parameters.
	GetBindRuleScript	Gets the script that specifies the binding rules.
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Assigns a Boolean parameter of the SqlSmoObject.
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Assigns a Boolean property of the SqlSmoObject.
	GetChildType	Gets the type of a child element.
	GetDateTimeParameter	Assigns the datetime property of the SqlSmoObject.
	GetDateTimeParameterAsInt	Assigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null.
	GetDBName	Gets the database name that is associated with the object.
	GetEnumParameter	Assigns an enumeration property of the SqlSmoObject.
	GetFragOptionString	Gets a FragmentationOption object as a string value.
	GetGuidParameter	Assigns a Guid property of the SqlSmoObject.
	GetHashCode	(Inherited from Object.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Assigns a parameter of the SqlSmoObject.
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Assigns a parameter of the SqlSmoObject.
	GetPropValue	Gets a property value of the SqlSmoObject object.
	GetPropValueOptional	Gets a property value of the SqlSmoObject object.
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object.
	GetRealValue	Gets a property value of the SqlSmoObject object.
	GetScriptingOptionsForCreate	Gets ScriptingOptions for the SqlSmoObject object.
	GetServerName	Gets the name of the instance of SQL Server with which the object is associated.
	GetServerObject	Gets the server of the SqlSmoObject object.
	GetSqlServerVersionName	Gets the version name of the instance of SQL Server with which the object is associated.
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Assigns a string parameter of the SqlSmoObject object.
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Assigns a string parameter of the SqlSmoObject object.
	GetTimeSpanParameterAsInt	Assigns a time span parameter of the SqlSmoObject object.
	GetType	(Inherited from Object.)
	GetTypeFromUrnSkeleton	Gets the type from the Urn object specified by the parameter.
	GetUrnRecursive(StringBuilder)	Assigns an Urn object of the SqlSmoObject object.
	GetUrnRecursive(StringBuilder, UrnIdOption)	Assigns an Urn object of the SqlSmoObject object.
	ImplInitialize	Initializes the fields of the SqlSmoObject object.
	Initialize()	Initializes the object and forces the properties be loaded.
	Initialize(Boolean)	Initializes the object and forces the properties be loaded.
	IsCollectionDirty	Determines whether any object in the SqlSmoObject collection has been modified.
	IsObjectDirty	Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server.
	IsObjectInitialized	Verifies whether the object has been initialized.
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server.
	IsVersion80SP3	Determines whether the version of SQL Server is SQL Server 2000 with SP3.
	IsVersion90AndAbove	Determines whether the version of SQL Server is SQL Server 2005 or later.
	MarkDropped	Sets the SqlSmoState to dropped.
	MarkForDropImpl	Sets the SqlSmoState to dropped.
	MemberwiseClone	(Inherited from Object.)
	PostAlter	Method activated after the SqlSmoObject is altered.
	PostCreate	Method activated after the SqlSmoObject is created.
	PostDrop	Method activated after the SqlSmoObject is dropped.
	Refresh	Refreshes the object and retrieves properties when the object is next accessed.
	ScriptAlter	Alters the SqlSmoObject according to the parameters.
	ScriptCreate	Alters the SqlSmoObject according to the parameters.
	ScriptDdl	Throws InvalidSmoOperationException.
	ScriptDrop	Throws InvalidSmoOperationException.
	ScriptImpl()	Gets a collection of scripts of the SqlSmoObject.
	ScriptImpl(ScriptingOptions)	Gets a collection of scripts of the SqlSmoObject.
	ScriptImplWorker	Gets a collection of scripts of the SqlSmoObject.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter.
	ToString	Returns a String that represents the referenced object. (Overrides Object.ToString().)
	TouchImpl	Not implemented.
	Trace	Traces the object.
	UnbindDefaultImpl	Unbinds the default columns of the SqlSmoObject.
	UnbindRuleImpl	Unbinds rules of the SqlSmoObject.
	UpdateCollectionState2	Updates the collection state of the SqlSmoObject.
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed.
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes.

Top

Fields

	Name	Description
	m_ExtendedProperties	Represents a property that is defined to extend the properties provided by a SqlSmoObject.
	singletonParent	Represents the singleton parent.

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
	IAlienObject.GetDomainRoot	Returns the root of the domain.
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
	IAlienObject.GetPropertyType	Gets the type of the specified property.
	IAlienObject.GetPropertyValue	Gets the value of the specified property.
	IAlienObject.GetUrn	Gets the Unified Resource Name of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name of the object.
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value.
	IAlienObject.SetPropertyValue	Sets the property value.
	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.

Top

Remarks

The SqlSmoObject is a generic object that is used to referenced objects that are not of a specified type. The SqlSmoObject is also used as a base class.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Inheritance Hierarchy

SqlSmoObject Class

Inheritance Hierarchy

Syntax

Constructors

Properties

Methods

Events

Fields

Explicit Interface Implementations

Remarks

Thread Safety

Thread Safety

See Also

Reference

Inheritance Hierarchy

Additional resources