Microsoft.VisualStudio.Data.Services Namespace

  • Article

The Microsoft.VisualStudio.Data.Services namespace provides various services that allow clients to control the data connection by creating a new connection, or by providing a custom connection UI control, or by taking other actions. Furthermore, clients can have access to the data object mappings between the data source–specific metadata objects and the generic metadata. Also, this namespace contains services that define the hierarchical relationships between nodes in the data view. Note that, in addition to services, there are several interfaces that represent entities implemented internally as classes in DDEX, like for instance the IVsDataExplorerNode.

As part of the DDEX architecture, services are designed to consume support entities, which are defined in the Microsoft.VisualStudio.Data.Services.SupportEntities namespace. For instance, the IVsDataConnectionDialog service uses the IVsDataConnectionUIControl support entity, which allows the addition of a custom UI control for connection properties.

Classes

  Class Description
Public class DataConnectionMessageReceivedEventArgs Encapsulates the event data for the MessageReceived event for a data connection.
Public class DataConnectionOpenCanceledException Represents the exception thrown when a data connection open call is canceled.
Public class DataConnectionStateChangedEventArgs Encapsulates event data for the StateChanged event for a data connection.
Public class DataExplorerNodeEventArgs Encapsulates the event data for the following events: NodeInserted, NodeChanged, NodeRemoving, and NodeExpandedOrRefreshed.
Public class DataMappedObjectTypeAttribute Specifies that an interface or class represents a mapped object type. A mapped object type is an API that exposes a strongly-typed view of a particular underlying data source–specific object.
Public class DataObjectAddedEventArgs Encapsulates event data for the ObjectAdded event.
Public class DataObjectChangedEventArgs Encapsulates event data for the ObjectChanged event.
Public class DataObjectDeletedEventArgs Encapsulates event data for the ObjectDeleted event.
Public class DataObjectEventArgs Represents the base class for the following other classes that contain data object event data: DataObjectAddedEventArgs, DataObjectChangedEventArgs, and DataObjectDeletedEventArgs.
Public class DataProtection Represents the ability to encrypt and decrypt strings by using the Windows Data Protection API (DPAPI).

Interfaces

  Interface Description
Public interface IVsDataConnection Represents the interface for a data connection.
Public interface IVsDataConnectionDialog Provides access to the Add Connection dialog box, with which you can obtain data connection information from users.
Public interface IVsDataConnectionDialogFactory Represents the interface that provides the ability to create an instance of the IVsDataConnectionDialog class.
Public interface IVsDataConnectionEvents Represents basic events for a data connection.
Public interface IVsDataConnectionFactory Provides the ability to create stand-alone instances of the IVsDataConnection class.
Public interface IVsDataConnectionManager Represents a shared set of data connection objects that are created on demand and managed by Visual Studio.
Public interface IVsDataExplorerChildNodeCollection Represents the collection of connection node objects in Server Explorer in Visual Studio.
Public interface IVsDataExplorerConnection Represents a connection that exists in the Visual Studio Server Explorer.
Public interface IVsDataExplorerConnectionManager Provides the ability to perform common tasks with data connections in Server Explorer, such as adding, removing, or finding a connection, among others.
Public interface IVsDataExplorerNode Represents any node in the Visual Studio Server Explorer that appears as a child to the Data Connections node.
Public interface IVsDataExplorerNodeSelection Represents a group of currently selected nodes in the Visual Studio Server Explorer, together with a set of properties and actions.
Public interface IVsDataMappedObject Represents a well-known concept for use by a generic designer.
Public interface IVsDataMappedObjectCallMapperConversionStep Represents a call mapper conversion step for a data object support mapped type.
Public interface IVsDataMappedObjectConversion Represents a conversion for a data object support mapped type and contains the conversion steps needed to convert a data source–specific object to a mapped object.
Public interface IVsDataMappedObjectConversionStep Represents a conversion step for a data object support mapped type.
Public interface IVsDataMappedObjectSelection Represents the Selection XML tag corresponding to this mapped type in the data object support XML file.
Public interface IVsDataMappedObjectSelector Represents a selector of mapped objects.
Public interface IVsDataMappedObjectSubstitutionValue Represents a substitution value for a data object support mapped type.
Public interface IVsDataMappedObjectType Represents a data object support mapped type, that is, the generic type that is converted from the underlying data source–specific types.
Public interface IVsDataMappedObjectTypeMember Represents a member of a data object support mapped type.
Public interface IVsDataObject Represents a data object.
Public interface IVsDataObjectChangeEvents Represents a set of events that are raised when data objects are added to, changed in, or deleted from a data source.
Public interface IVsDataObjectChangeEventsBroker Represents the ability to raise events when data objects are added, changed, or deleted on a data source.
Public interface IVsDataObjectCollection Represents a collection of data objects that are selected from an object store.
Public interface IVsDataObjectIdentifier Represents the identifier of a data object.
Public interface IVsDataObjectPropertyDictionary Represents the properties of a data object.
Public interface IVsDataObjectService Represents a service of a data object support type.
Public interface IVsDataObjectStore Represents a store, that is, a cache, of data source–specific data objects.
Public interface IVsDataObjectSupportModel Represents the model that describes data object support.
Public interface IVsDataObjectType Represents a data object support type that is data source specific.
Public interface IVsDataObjectTypeMember Represents a member of a data object support type.
Public interface IVsDataViewCommandInfo Encapsulates information that describes a command for a node in Server Explorer.
Public interface IVsDataViewCommonNodeInfo Encapsulates properties that are common among different types of nodes; specifically, the connection node (IVsDataViewConnectionNodeInfo) and the static and selection nodes (IVsDataViewNodeInfo).
Public interface IVsDataViewConnectionNodeInfo Encapsulates properties for a connection node in Server Explorer.
Public interface IVsDataViewDisplayNameInfo Encapsulates properties about the display name of a node in Server Explorer.
Public interface IVsDataViewIconInfo Encapsulates properties of a node icon in Server Explorer.
Public interface IVsDataViewInfo Provides information about a data view.
Public interface IVsDataViewMemberInfo Represents information about a member of a data view that is associated with a data connection in Server Explorer.
Public interface IVsDataViewNodeInfo Encapsulates properties of a static or selection node in Server Explorer.
Public interface IVsDataViewPropertyInfo Represents information about a node property in Server Explorer.
Public interface IVsDataViewSelectionInfo Encapsulates properties of a selection of nodes in Server Explorer.
Public interface IVsDataViewSelectionNodeInfo Encapsulates properties of a selection node in Server Explorer.
Public interface IVsDataViewSupportModel Represents the model that describes data view support.

Delegates

  Delegate Description
Public delegate DataConnectionDialogFilterCallback Represents the method that is called when data sources and providers are being filtered in the data connection dialog box.

Enumerations

  Enumeration Description
Public enumeration DataConnectionState Specifies the current state of the data connection.
Public enumeration DataObjectIdentifierFormat Specifies the type of formatting required for the data object identifier string value. The formatting of the identifier depends on its intended use.

Examples

Here are some examples of the above-mentioned services:

A sample of data connection–related services:

IVsDataConnectionDialogFactory

IVsDataConnectionDialog

IVsDataConnectionFactory

IVsDataConnection

A sample of data object support–related services:

IVsDataObjectSupportModel

IVsDataObjectService

IVsDataObjectStore

A sample of data view support–related services:

IVsDataViewSupportModel