UserInteractionServices Class

Article
11/05/2012

Provides a variety of helper methods and properties to facilitate user interaction with the windows in Visual Studio.

Inheritance Hierarchy

System.Object
Microsoft.Data.Schema.UserInteractionServices
Microsoft.Data.Schema.Sql.SqlUserInteractionServices

Namespace: Microsoft.Data.Schema
Assembly: Microsoft.Data.Schema (in Microsoft.Data.Schema.dll)

Syntax

'Declaration
Public MustInherit Class UserInteractionServices

public abstract class UserInteractionServices

public ref class UserInteractionServices abstract

[<AbstractClass>]
type UserInteractionServices =  class end

public abstract class UserInteractionServices

The UserInteractionServices type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	BatchSeparator	Gets a string to insert between each batch of script.
	DatabaseSchemaProvider	Gets a reference to the current DatabaseSchemaProvider.
	DatabaseSchemaProviderDisplayName	Gets the full name of the DSP.
	DisplayableElementClasses	Gets a list of the displayable element classes in the ModelSchema of the DSP.
	ProjectIcon	Gets the icon for the specific DSP project.
	TransparentColor	Gets the color used to make parts of a bitmap transparent.
	Unnamed	Gets a localized string for "unnamed."

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetDisplayName(ModelIdentifier, Boolean, Boolean)	Returns a display name for an identifier that specifies whether to use an escape character on the name, and whether to provide the full name or a short version.
	GetDisplayName(ModelIdentifier, Boolean, Boolean, Int32)	Returns a display name for an identifier.
	GetElementName(IModelElement, ElementNameStyle)	Returns the element name for the specified element.
	GetElementName(IModelElement, Boolean, Boolean, Boolean)	Returns the name for the specified element.
	GetElementName(IModelElement, Boolean, Boolean, Boolean, Int32)	Returns the element name for the specified element.
	GetElementTypeDescription	Returns the type description of the specified element.
	GetEscapedNameString	Returns an escaped version of the provided name.
	GetFileExtension	Returns the file extension for model elements for the current DatabaseSchemaProvider when they are saved to a file.
	GetFolderIcon	Returns a bitmap icon that is selected according to the provided style indication.
	GetFolderName	Returns a folder name for the specified model element type.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIcon(IModelElement)	Returns a bitmap for an icon to use in the UI to match the provided element.
	GetIcon(ModelElementClass)	Returns a bitmap for an icon to use in the UI to match the provided element.
	GetIcon(IModelElement, ElementIconState)	Returns a bitmap for an icon to use in the UI to match the provided element and icon state.
	GetIcon(ModelElementClass, ElementIconState)	Returns a bitmap for an icon to use in the UI to match the provided element and icon state.
	GetModelCollation	Returns a ModelCollation object for the provided culture ID and case sensitivity indication.
	GetNameString	Returns the name and escapes the string, if requested.
	GetRelatedElementTypeDescription	Returns a description of the related object in the provided relationship.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MakeIconTransparent	Makes the provided icon transparent by using the value of the TransparentColor property.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryConstructConnectionStringAndProvider	Used to get the connection string and the GUID of the provider.

Top

Fields

	Name	Description
	SqlExtension	Returns ".sql".

Top

Remarks

You must create a derived class to provide custom values and functionality more suited to your specific version of the DatabaseSchemaProvider class.

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.