DSRefBuilder Class

 

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

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

System.Object
  Microsoft.VisualStudio.Data.Framework.DataSiteableObject<T>
    Microsoft.VisualStudio.Data.Framework.DSRefBuilder

public class DSRefBuilder : DataSiteableObject<IVsDataConnection>, 
	IDSRefBuilder, IVsDataSupportObject<IDSRefBuilder>

NameDescription
System_CAPS_pubmethodDSRefBuilder()

Initializes a new instance of the DSRefBuilder class.

System_CAPS_pubmethodDSRefBuilder(IVsDataConnection)

Initializes a new instance of the DSRefBuilder class with the data connection.

NameDescription
System_CAPS_pubpropertySite

Gets or sets the object site.(Inherited from DataSiteableObject<T>.)

NameDescription
System_CAPS_pubmethodAppendToDSRef(Object, String, Object[])

Appends information about a data object with the specified type and identifier to a specified existing DSRef object.

System_CAPS_protmethodAppendToDSRef(Object, String, Object[], Object[])

Appends information about a data object with the specified type and identifier to a specified existing DSRef object.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnSiteChanged(EventArgs)

Raises the SiteChanged event.(Inherited from DataSiteableObject<T>.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventSiteChanged

Occurs when the Site property is changed.(Inherited from DataSiteableObject<T>.)

This particular implementation of the IDSRefBuilder interface uses information provided in a data provider's data object support XML file to append information to an existing DSRef object to enable drag-and-drop operations.

When specifying the IDSRefBuilder service with this implementation, 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 top-level parameters identify nodes that appear directly underneath the root DSRef node. The format of sub-parameters under a given top-level parameter is as follows:

  • Parameter 1: The name of the node.

  • Parameter 2: The owner of the node.

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

  • Parameter 4: The extended type of the node, as a GUID.

  • 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 can inherit from it and specify your own class, although in most cases that will not be necessary.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: