IVSDBToolsOptionsSettings Interface
This class and its members are reserved for internal use and are not intended to be used in your code. Defines a settings contract for any feature that provides settings to be hosted in the Tools Options page or the Project Properties page in Visual Studio Application Lifecycle Management (ALM).
Namespace: Microsoft.Data.Schema.Tools.Settings.Internal
Assembly: Microsoft.Data.Schema.Tools (in Microsoft.Data.Schema.Tools.dll)
Syntax
'Declaration
Public Interface IVSDBToolsOptionsSettings
public interface IVSDBToolsOptionsSettings
public interface class IVSDBToolsOptionsSettings
type IVSDBToolsOptionsSettings = interface end
public interface IVSDBToolsOptionsSettings
The IVSDBToolsOptionsSettings type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
SettingValues | Gets or sets a dictionary of named settings and their current values. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
CompareSettingValues | Returns a list of VSDBToolsOptionsSettingChange objects that specify which settings have been changed, based on the provided list of previous setting values. It also raises the SettingsChanged event if any settings have changed. |
|
IsSupportedSetting | Returns a value that indicates whether the provided setting name is supported in the current settings. |
|
Reset | When implemented in an inherited class, resets all settings to their default values. |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
SettingsChanged | Raised by the CompareSettingValues method if any values have changed. |
Top
Remarks
Notes to Implementers
Every setting in implemented classes must be a writable property that either can be converted to a string or has a TypeConverter, and that is decorated with the VSDBToolsOptionsSettingAttribute.
Implemented classes must also override both the Equals() and GetHashCode methods, which will enable the comparison of old values to new values and will raise the SettingsChanged event.
The easiest way to implement this interface is to inherit from the VSDBToolsOptionsSettingsBase class.
See Also
Reference
Microsoft.Data.Schema.Tools.Settings.Internal Namespace
VSDBToolsOptionsSettingAttribute
Equals()