DSRefBuilder Class

Article
02/23/2011

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

Inheritance Hierarchy

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

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

Syntax

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

[GuidAttribute("D42D21CE-A94A-47f2-A2DA-ACE133020BCD")]
public class DSRefBuilder : ObjectWithSite

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

[<GuidAttribute("D42D21CE-A94A-47f2-A2DA-ACE133020BCD")>]
type DSRefBuilder =  
    class
        inherit ObjectWithSite
    end

public class DSRefBuilder extends ObjectWithSite

The DSRefBuilder type exposes the following members.

Constructors

	Name	Description
	DSRefBuilder	Class constructor constructor. Initializes a new instance of the DSRefBuilder class.

Top

Properties

	Name	Description
	Connection	Retrieves a data-source connection as a DataConnection object instance.
	Site	Retrieves or sets the object site. (Inherited from ObjectWithSite.)

Top

Methods

	Name	Description
	AppendToDSRef	Appends information about a data object with the specified type and identifier to a specified existing DSRef object.
	BuildDSRef	Builds a DSRef object that identifies a data object with the specified type and identifier.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnSiteChanged	Raises the SiteChanged event. (Inherited from ObjectWithSite.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	SiteChanged	Event that is raised when the Site property is changed. (Inherited from ObjectWithSite.)

Top

Explicit Interface Implementations

	Name	Description
	IObjectWithSite.GetSite	Retrieves the last site set using the IObjectWithSite.SetSite method. In cases where there is no known site, the object returns an exception. (Inherited from ObjectWithSite.)
	IObjectWithSite.SetSite	Provides the site's pointer to the site object. (Inherited from ObjectWithSite.)

Top

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.

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.