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)

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

The DSRefBuilder type exposes the following members.

  NameDescription
Public methodDSRefBuilder()Initializes a new instance of the DSRefBuilder class.
Public methodDSRefBuilder(IVsDataConnection)Initializes a new instance of the DSRefBuilder class with the data connection.
Top

  NameDescription
Public propertySiteGets or sets the object site. (Inherited from DataSiteableObject<T>.)
Top

  NameDescription
Public methodAppendToDSRef(Object, String, Object[])Appends information about a data object with the specified type and identifier to a specified existing DSRef object.
Protected methodAppendToDSRef(Object, String, Object[], Object[])Appends information about a data object with the specified type and identifier to a specified existing DSRef object.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnSiteChangedRaises the SiteChanged event. (Inherited from DataSiteableObject<T>.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventSiteChangedOccurs when the Site property is changed. (Inherited from DataSiteableObject<T>.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIVsDataSupportObject<IDSRefBuilder>.InvokeInvokes the method specified by the method name and passes it the specified arguments.
Top

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft