DSRefBuilder Class

Allows you to create a Data Source Reference (DSRef) object that identifies a data object.

Namespace:  Microsoft.VisualStudio.Data
Assembly:  Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

<GuidAttribute("D42D21CE-A94A-47f2-A2DA-ACE133020BCD")> _
Public Class DSRefBuilder _
    Inherits ObjectWithSite

Dim instance As DSRefBuilder
[GuidAttribute("D42D21CE-A94A-47f2-A2DA-ACE133020BCD")]
public class DSRefBuilder : ObjectWithSite
[GuidAttribute(L"D42D21CE-A94A-47f2-A2DA-ACE133020BCD")]
public ref class DSRefBuilder : public ObjectWithSite
public class DSRefBuilder extends ObjectWithSite

Remarks

This class uses information provided in a data provider's data object support XML file to build a DSRef object to enable drag-and-drop operations.

When specifying the BuildDSRef action, a data provider should attach certain parameters to indicate which nodes should be created where, and which identifier parts should be used as values for the nodes. The format of these parameters is as follows.

  • Parameter 1: The name of the node.

  • Parameter 2: The owner of the node.

  • Parameter 3: The node type (Table, Field, Database, Trigger, StoredProcedure, View, Synonym, Function, or Index).

  • Parameter 4: The extended type of the node.

  • Parameter 5: A collection of custom properties specified as child parameters where the value is the GUID of the custom property and an embedded parameter contains the value.

  • Parameter 6: A collection of child nodes specified as child parameters.

When this class does not adequately service your data provider's requirements, you may inherit from it and specify your own class, although in most cases that will not be necessary. However, in cases where a data provider must implement a custom DSRef building mechanism, the DSRefBuilder class provides you with this ability.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.ObjectWithSite
    Microsoft.VisualStudio.Data.DSRefBuilder

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.

See Also

Reference

DSRefBuilder Members

Microsoft.VisualStudio.Data Namespace