SchemaCompareSettingsService Class

Article
11/05/2012

Provides standard settings that are used by the Schema Compare window in Visual Studio Premium and Visual Studio Ultimate.

Inheritance Hierarchy

System.Object
Microsoft.Data.Schema.Tools.Compare.Schema.SchemaCompareSettingsService

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

Syntax

'Declaration
<DatabaseSchemaProviderCompatibilityAttribute(GetType(DatabaseSchemaProvider))> _
Public Class SchemaCompareSettingsService _
    Implements IExtensionInformation, IExtension

[DatabaseSchemaProviderCompatibilityAttribute(typeof(DatabaseSchemaProvider))]
public class SchemaCompareSettingsService : IExtensionInformation, 
    IExtension

[DatabaseSchemaProviderCompatibilityAttribute(typeof(DatabaseSchemaProvider))]
public ref class SchemaCompareSettingsService : IExtensionInformation, 
    IExtension

[<DatabaseSchemaProviderCompatibilityAttribute(typeof(DatabaseSchemaProvider))>]
type SchemaCompareSettingsService =  
    class
        interface IExtensionInformation
        interface IExtension
    end

public class SchemaCompareSettingsService implements IExtensionInformation, IExtension

The SchemaCompareSettingsService type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	ConfigurationOptions	Gets or sets the options that are used when the comparison engine compares schema models and when it generates the deployment script.
	DatabaseSchemaProvider	Gets the current database schema provider.
	DisplayableTopElementClassesTypes	When overridden in a derived class, gets a list of types that represent the types of classes that are to be displayed in the Schema Compare window of Visual Studio Premium and Visual Studio Ultimate.
	IsCmdVariableSubstitutionEnabled	When overridden in a derived class, gets a value that indicates whether to enable the Specify SQLCMD variables… button in the Schema Compare window of Visual Studio Premium and Visual Studio Ultimate.
	ModelInformation	When overridden in a derived class, gets or sets the schema model information object.
	SerializationData	When overridden in a derived class, gets or sets options and values to be serialized.

Top

Methods

	Name	Description
	AllowToCompareModels
	AllowToUpdateTarget
	AreModelElementsSorted
	ConvertPropertyValueToString	When overridden in a derived class, returns the value of the provided object as a string.
	CreateConfigurationOptions	When overridden in a derived class, returns a set of deployment options.
	Deserialize	Deserializes the schema compare settings from the specified XML.
	DisplayableTopElementClasses
	DisplayCmdVariableFilesDialog
	DisplayOptionsDialog	When overridden in a derived class, displays the Options dialog box in Visual Studio Premium and Visual Studio Ultimate and returns the output parameter values.
	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.)
	GetElementName
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetPropertyValue
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize
	InitializeForComparison	When overridden in a derived class, provides an opportunity for additional initialization before the comparison process.
	IsModelElementACompositeProjectReference	When overridden in a derived class, returns a value to indicate whether the provided element is external to the current model.
	IsModelElementDisplayedAtTopLevel	When overridden in a derived class, returns a value that indicates whether the provided element should be displayed at the top level in the Schema Compare window of Visual Studio Premium and Visual Studio Ultimate.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NormalizeComparisonResult	When overridden in a derived class, returns a normalized version of the provided comparison result by using the source and target models and configuration information.
	Serialize	Serializes this object and saves it in the provided XML node.
	Sort	When overridden in a derived class, returns the provided list of grid rows as a sorted list of grid rows.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IExtensionInformation.ExtensionHandle
	IExtensionInformation.SetExtensionHandle

Top

Remarks

This class is one of the predefined extension points for the Schema Compare window in Visual Studio ALM. The other predefined extension point is the SchemaCompareScriptService class.

Most settings in this class are intended to be overridden and modified to represent a DatabaseSchemaProvider for a specific database model and version in the Schema Compare window.

Notes to Inheritors

Other classes that you will have to extend for a derived version of this class to support a specific DatabaseSchemaProvider:

You will also need to implement the ISchemaDeploymentController interface.

For your specific implementation, you may also have to extend other classes and implement other interfaces.

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.

Share via