Microsoft.VisualStudio.Data.Services Namespace

 

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.

ClassDescription
System_CAPS_pubclassDataConnectionMessageReceivedEventArgs

Encapsulates the event data for the MessageReceived event for a data connection.

System_CAPS_pubclassDataConnectionOpenCanceledException

Represents the exception thrown when a data connection open call is canceled.

System_CAPS_pubclassDataConnectionStateChangedEventArgs

Encapsulates event data for the StateChanged event for a data connection.

System_CAPS_pubclassDataExplorerNodeEventArgs

Encapsulates the event data for the following events: NodeInserted, NodeChanged, NodeRemoving, and NodeExpandedOrRefreshed.

System_CAPS_pubclassDataMappedObjectTypeAttribute

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.

System_CAPS_pubclassDataObjectAddedEventArgs

Encapsulates event data for the ObjectAdded event.

System_CAPS_pubclassDataObjectChangedEventArgs

Encapsulates event data for the ObjectChanged event.

System_CAPS_pubclassDataObjectDeletedEventArgs

Encapsulates event data for the ObjectDeleted event.

System_CAPS_pubclassDataObjectEventArgs

Represents the base class for the following other classes that contain data object event data: DataObjectAddedEventArgs, DataObjectChangedEventArgs, and DataObjectDeletedEventArgs.

System_CAPS_pubclassDataProtection

Represents the ability to encrypt and decrypt strings by using the Windows Data Protection API (DPAPI).

InterfaceDescription
System_CAPS_pubinterfaceIVsDataConnection

Represents the interface for a data connection.

System_CAPS_pubinterfaceIVsDataConnectionDialog

Provides access to the Add Connection dialog box, with which you can obtain data connection information from users.

System_CAPS_pubinterfaceIVsDataConnectionDialogFactory

Represents the interface that provides the ability to create an instance of the IVsDataConnectionDialog class.

System_CAPS_pubinterfaceIVsDataConnectionEvents

Represents basic events for a data connection.

System_CAPS_pubinterfaceIVsDataConnectionFactory

Provides the ability to create stand-alone instances of the IVsDataConnection class.

System_CAPS_pubinterfaceIVsDataConnectionManager

Represents a shared set of data connection objects that are created on demand and managed by Visual Studio.

System_CAPS_pubinterfaceIVsDataExplorerChildNodeCollection

Represents the collection of connection node objects in Server Explorer in Visual Studio.

System_CAPS_pubinterfaceIVsDataExplorerConnection

Represents a connection that exists in the Visual Studio Server Explorer.

System_CAPS_pubinterfaceIVsDataExplorerConnectionManager

Provides the ability to perform common tasks with data connections in Server Explorer, such as adding, removing, or finding a connection, among others.

System_CAPS_pubinterfaceIVsDataExplorerNode

Represents any node in the Visual Studio Server Explorer that appears as a child to the Data Connections node.

System_CAPS_pubinterfaceIVsDataExplorerNodeSelection

Represents a group of currently selected nodes in the Visual Studio Server Explorer, together with a set of properties and actions.

System_CAPS_pubinterfaceIVsDataMappedObject

Represents a well-known concept for use by a generic designer.

System_CAPS_pubinterfaceIVsDataMappedObjectCallMapperConversionStep

Represents a call mapper conversion step for a data object support mapped type.

System_CAPS_pubinterfaceIVsDataMappedObjectConversion

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.

System_CAPS_pubinterfaceIVsDataMappedObjectConversionStep

Represents a conversion step for a data object support mapped type.

System_CAPS_pubinterfaceIVsDataMappedObjectSelection

Represents the Selection XML tag corresponding to this mapped type in the data object support XML file.

System_CAPS_pubinterfaceIVsDataMappedObjectSelector

Represents a selector of mapped objects.

System_CAPS_pubinterfaceIVsDataMappedObjectSubstitutionValue

Represents a substitution value for a data object support mapped type.

System_CAPS_pubinterfaceIVsDataMappedObjectType

Represents a data object support mapped type, that is, the generic type that is converted from the underlying data source–specific types.

System_CAPS_pubinterfaceIVsDataMappedObjectTypeMember

Represents a member of a data object support mapped type.

System_CAPS_pubinterfaceIVsDataObject

Represents a data object.

System_CAPS_pubinterfaceIVsDataObjectChangeEvents

Represents a set of events that are raised when data objects are added to, changed in, or deleted from a data source.

System_CAPS_pubinterfaceIVsDataObjectChangeEventsBroker

Represents the ability to raise events when data objects are added, changed, or deleted on a data source.

System_CAPS_pubinterfaceIVsDataObjectCollection

Represents a collection of data objects that are selected from an object store.

System_CAPS_pubinterfaceIVsDataObjectIdentifier

Represents the identifier of a data object.

System_CAPS_pubinterfaceIVsDataObjectPropertyDictionary

Represents the properties of a data object.

System_CAPS_pubinterfaceIVsDataObjectService

Represents a service of a data object support type.

System_CAPS_pubinterfaceIVsDataObjectStore

Represents a store, that is, a cache, of data source–specific data objects.

System_CAPS_pubinterfaceIVsDataObjectSupportModel

Represents the model that describes data object support.

System_CAPS_pubinterfaceIVsDataObjectType

Represents a data object support type that is data source specific.

System_CAPS_pubinterfaceIVsDataObjectTypeMember

Represents a member of a data object support type.

System_CAPS_pubinterfaceIVsDataViewCommandInfo

Encapsulates information that describes a command for a node in Server Explorer.

System_CAPS_pubinterfaceIVsDataViewCommonNodeInfo

Encapsulates properties that are common among different types of nodes; specifically, the connection node (IVsDataViewConnectionNodeInfo) and the static and selection nodes (IVsDataViewNodeInfo).

System_CAPS_pubinterfaceIVsDataViewConnectionNodeInfo

Encapsulates properties for a connection node in Server Explorer.

System_CAPS_pubinterfaceIVsDataViewDisplayNameInfo

Encapsulates properties about the display name of a node in Server Explorer.

System_CAPS_pubinterfaceIVsDataViewIconInfo

Encapsulates properties of a node icon in Server Explorer.

System_CAPS_pubinterfaceIVsDataViewInfo

Provides information about a data view.

System_CAPS_pubinterfaceIVsDataViewMemberInfo

Represents information about a member of a data view that is associated with a data connection in Server Explorer.

System_CAPS_pubinterfaceIVsDataViewNodeInfo

Encapsulates properties of a static or selection node in Server Explorer.

System_CAPS_pubinterfaceIVsDataViewPropertyInfo

Represents information about a node property in Server Explorer.

System_CAPS_pubinterfaceIVsDataViewSelectionInfo

Encapsulates properties of a selection of nodes in Server Explorer.

System_CAPS_pubinterfaceIVsDataViewSelectionNodeInfo

Encapsulates properties of a selection node in Server Explorer.

System_CAPS_pubinterfaceIVsDataViewSupportModel

Represents the model that describes data view support.

DelegateDescription
System_CAPS_pubdelegateDataConnectionDialogFilterCallback

Represents the method that is called when data sources and providers are being filtered in the data connection dialog box.

EnumerationDescription
System_CAPS_pubenumDataConnectionState

Specifies the current state of the data connection.

System_CAPS_pubenumDataObjectIdentifierFormat

Specifies the type of formatting required for the data object identifier string value. The formatting of the identifier depends on its intended use.

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.

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

Return to top
Show: