Microsoft.VisualStudio.Data.Services.SupportEntities Namespace

  • Article

The Microsoft.VisualStudio.Data.Services.SupportEntities namespace represents the various entities that DDEX services consume as separate objects that plug into these services. This allows for customization of these entities. For instance, a custom connection UI control that is part of the data connection dialog box can be provided through the IVsDataConnectionUIControl support entity. This support entity is consumed by the IVsDataConnectionDialog service.

Classes

  Class Description
Public class DataAsyncCommandCompletedEventArgs<T> Encapsulates event data for various events used in the IVsDataAsyncCommand service
Public class DataViewNodeEventArgs Encapsulates event data for various events that are raised for nodes in Server Explorer when some of their properties change.

Interfaces

  Interface Description
Public interface IDSRefBuilder Allows you to create a Data Source Reference (DSRef) object that identifies one or more data objects.
Public interface IVsDataAsyncCommand Represents the interface that contains methods for executing data commands in an asynchronous manner.
Public interface IVsDataCommand Represents the interface that exposes methods for data command handling, including building and executing data commands of various types against data sources, retrieving read-only results, and retrieving a command status code.
Public interface IVsDataConnectionEquivalencyComparer Provides the ability to compare data connection strings for equivalence.
Public interface IVsDataConnectionPromptDialog Represents the interface for a dialog box that can prompt the user for information when a data connection is being opened.
Public interface IVsDataConnectionProperties Represents the interface that exposes methods and properties for the parsing and formatting of connection strings, as well as for storage of strongly typed properties, custom attributes, and synonyms.
Public interface IVsDataConnectionSupport Represents the interface that exposes methods and properties that enable you to work directly with connections to a data source.
Public interface IVsDataConnectionUIConnector Provides the ability to customize the behavior of opening a connection when in the context of a connection UI (for example, the data connection dialog box).
Public interface IVsDataConnectionUIControl Represents the interface that exposes methods and properties that enable a custom user interface (UI) control for editing connection properties in the Data Connection dialog box.
Public interface IVsDataConnectionUIProperties Provides the ability to manipulate data connection properties in the context of a connection UI (for example, the data connection dialog box).
Public interface IVsDataConnectionUITester Provides the ability to test the connection with the properties specified in the connection dialog box.
Public interface IVsDataMappedObjectConverter Provides the ability to convert restrictions passed to the mapped object selector into underlying restrictions to pass to the data source–specific type selector, thus allowing mapped selection. Also allows conversion of members of an underlying data object to members of a mapped object, resulting in mapped representations of data objects.
Public interface IVsDataObjectIdentifierConverter Represents the interface that exposes methods for converting data source–specific object identifiers from strings to identifier parts, and from identifier parts to strings.
Public interface IVsDataObjectIdentifierResolver Represents the interface that exposes methods for expanding and contracting an identifier for a specified data object.
Public interface IVsDataObjectMemberComparer Represents the interface that exposes methods for comparing two data object identifier parts or properties.
Public interface IVsDataObjectSelector Enables getting data source–specific metadata about objects from the object store. The source of the object store is the data object support XML file.
Public interface IVsDataObjectSupport Provides the ability to retrieve, through an XML stream, a description of data object types for a data source. You can then interpret and manipulate this information programmatically.
Public interface IVsDataParameter Represents the interface that exposes methods and properties to handle data parameters.
Public interface IVsDataParameterDescriptor Exposes properties that describe a data parameter.
Public interface IVsDataReader Represents the interface that exposes methods and properties for reading data from any data source.
Public interface IVsDataReaderDescriptor Exposes properties that describe the data reader.
Public interface IVsDataSourceInformation Represents the interface that exposes methods and properties for retrieving properties about a specified data source passed as name/value pairs.
Public interface IVsDataSourceVersionComparer Represents the interface that exposes the ability to compare two data source–specific version strings.
Public interface IVsDataTransaction Represents the interface that exposes methods and properties for transaction processing, which allows you to commit or roll back a series of related operations as a batch.
Public interface IVsDataViewBrowseObjectProvider Represents the interface that exposes the ability to retrieve a specialized browse object for a specified node in a given data view.
Public interface IVsDataViewCaptionProvider Provides the ability to get the caption of a node item in Server Explorer.
Public interface IVsDataViewCommandProvider Provides the ability to implement commands, specifically custom commands, for nodes in a data view.
Public interface IVsDataViewDocumentProvider Provides the ability to open a document, get a document moniker, and perform other actions pertaining to a document in the Visual Studio Sever Explorer.
Public interface IVsDataViewDocumentProvider2 Provides the ability to check the state of or save the document in the Visual Studio Server Explorer.
Public interface IVsDataViewDragSourceProvider Provides the ability to drag selected nodes in a data view hierarchy.
Public interface IVsDataViewDropTargetProvider Represents the ability to drop data on nodes in a data view hierarchy.
Public interface IVsDataViewHierarchy Represents the ability of a provider to manipulate a Server Explorer connection through its implementation as a data view hierarchy.
Public interface IVsDataViewIconProvider Provides the ability to control the icons for nodes in a data view hierarchy.
Public interface IVsDataViewSupport Represents the interface that exposes the ability to retrieve an XML stream that provides a description of one or more data views.
Public interface IVsDataViewUserContextProvider Provides the ability to create a user context to indicate which component of Server Explorer has just been selected.
Public interface IVsDataViewVisibilityProvider Provides the ability to control the visibility of nodes in a data view hierarchy.

Enumerations

  Enumeration Description
Public enumeration DataCommandType Represents an enumeration of predefined data command types.
Public enumeration DataItemTypeFormat Specifies the format of a data item type returned by the GetItemType method.
Public enumeration DataParameterDirection Specifies the type of a parameter within a query.