UserDefinedDataType Class

The UserDefinedDataType object represents a SQL Server user-defined data type.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.ScriptSchemaObjectBase
            Microsoft.SqlServer.Management.Smo.UserDefinedDataType

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class UserDefinedDataType _
    Inherits ScriptSchemaObjectBase _
    Implements ICreatable, IAlterable, IDroppable, IRenamable,  _
    IExtendedProperties, IScriptable, ISfcSupportsDesignMode, IObjectPermission
'Usage
Dim instance As UserDefinedDataType

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class UserDefinedDataType : ScriptSchemaObjectBase, 
    ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, 
    IScriptable, ISfcSupportsDesignMode, IObjectPermission

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class UserDefinedDataType sealed : public ScriptSchemaObjectBase, 
    ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, 
    IScriptable, ISfcSupportsDesignMode, IObjectPermission

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type UserDefinedDataType =  
    class 
        inherit ScriptSchemaObjectBase 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IRenamable 
        interface IExtendedProperties 
        interface IScriptable 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
    end

public final class UserDefinedDataType extends ScriptSchemaObjectBase implements ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode, IObjectPermission

The UserDefinedDataType type exposes the following members.

Constructors

	Name	Description
	UserDefinedDataType()	Initializes a new instance of the UserDefinedDataType class.
	UserDefinedDataType(Database, String)	Initializes a new instance of the UserDefinedDataType class on the specified database and with the specified name.
	UserDefinedDataType(Database, String, String)	Initializes a new instance of the UserDefinedDataType class on the specified database and with the specified name and schema.

Top

Properties

	Name	Description
	AllowIdentity	Gets the Boolean property value that specifies whether the user-defined data type is able to participate in a column defined with the identity property.
	Collation	Gets the collation assigned to the user-defined data type.
	Default	Gets or sets a SQL Server default that is bound to the user-defined data type.
	DefaultSchema	Gets or sets the SQL Server default schema for the user-defined data type.
	ExtendedProperties	Gets the extended properties of the user-defined data type.
	ID	Gets an ID value that uniquely identifies the user-defined data type.
	IsSchemaOwned	Gets a Boolean value that indicates whether the UserDefinedDataType object is owned by a schema.
	Length	Gets or sets the number of characters in the user-defined data type.
	MaxLength	Gets the maximum number of characters accepted by the user-defined data type.
	Name	Gets or sets a String value that specifies the name of the user defined data type. (Overrides ScriptSchemaObjectBase.Name.)
	Nullable	Gets or sets the Boolean property value that specifies whether the user-defined data type accepts null values or not.
	NumericPrecision	Gets or sets the maximum number of digits in a numeric value used in the definition of the user-defined data type.
	NumericScale	Gets or sets the maximum number of digits to the right of the decimal point in a numeric value used in the definition of the user-defined data type.
	Owner	Gets the name of the owner of the UserDefinedDataType object.
	Parent	Gets or sets the Database object that is the parent of the UserDefinedDataType object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	Rule	Gets or sets a SQL Server rule that is bound to the user-defined data type.
	RuleSchema	Gets or sets the SQL Server rule schema for the user-defined data type.
	Schema	Gets or sets a String value that specifies the name of the schema that contains the user defined data type. (Overrides ScriptSchemaObjectBase.Schema.)
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	SystemType	Gets or sets the base system data type from which the user-defined data type is derived.
	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.)
	VariableLength	Gets the Boolean property value that specifies whether the user-defined data type is variable in length.

Top

Methods

	Name	Description
	Alter	Updates any UserDefinedDataType object property changes on the instance of Microsoft SQL Server.
	BindDefault(String, String)	Binds a default to the user-defined data type.
	BindDefault(String, String, Boolean)	Binds a default to the user-defined data type.
	BindRule(String, String)	Binds a default to the user-defined data type.
	BindRule(String, String, Boolean)	Binds a default to the user-defined data type.
	Create	Creates a user-defined data type on the instance of Microsoft SQL Server as defined by the UserDefinedType object.
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the user-defined data type.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the user-defined data type.
	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 user-defined data type.
	Deny(ObjectPermissionSet, array<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 user-defined data type.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the user-defined data type from the instance of Microsoft SQL Server.
	EnumBoundColumns	Enumerates a list of columns to which the user-defined data type type is bound.
	EnumObjectPermissions()	Enumerates a list of object permissions for the user-defined data type.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the user-defined data type.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the user-defined data type.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the user-defined data type.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the user-defined data type.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the user-defined data type.
	Grant(ObjectPermissionSet, String, Boolean)	Grants the specified set of permissions to the grantee and the ability to grant the specified set of permissions to other users on the user-defined data type.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants the specified set pf permissions to the grantees and the ability to grant the specified set of permissions to other users on the user-defined data type.
	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 user-defined data type under an assumed role.
	Grant(ObjectPermissionSet, array<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 user-defined data type data type under an assumed role.
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Rename	Renames the user defined data type.
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the user-defined data type.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the user-defined data type.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes previously granted permissions from a grantee on the user-defined data type 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, array<String[], Boolean, Boolean)	Revokes previously granted permissions from grantees on the user-defined data type 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)	Revokes previously granted permissions from a grantee on the user-defined data type 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, array<String[], Boolean, Boolean, String)	Revokes previously granted permissions from grantees on the user-defined data type 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()	Generates a Transact-SQL script that can be used to re-create the user-defined data type.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the user-defined data type as specified by the script options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	UnbindDefault()	Unbinds a default from the user-defined data type.
	UnbindDefault(Boolean)	Unbinds a default from the user-defined data type.
	UnbindRule()	Unbinds a rule from the user-defined data type.
	UnbindRule(Boolean)	Unbinds a rule from the user-defined data type.
	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. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

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. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	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	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	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	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that specifies whether the user defined data type supports design mode.

Top

Remarks

To get UserDefinedDataType object permissions, users can be a member of the public fixed server role.

To set UserDefinedDataType object permissions, users must have CREATE TYPE permission in the parent database and ALTER permission on specified schema. If an assembly is specified, users must either own the assembly or have REFERENCES permission on it.

To create an user-defined data type data type, users must have CREATE TYPE permission in the parent database and ALTER permission on specified schema. If an assembly is specified, users must either own the assembly or have REFERENCES permission on it.

To drop a user-defined data type data type, users must have CONTROL permission on the type and ALTER permission on the specified schema.

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.

Examples

Working with Data Types

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.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Data Types (Database Engine)