DSRefClipboardObject Class

  • Article

Provides the ability to create and read a clipboard object used for drag-and-drop operations between Server Explorer and the data designer. The DSRefClipboardObject object contains identifying information about the underlying object that is transferred.

Inheritance Hierarchy

System.Object
  System.Windows.Forms.DataObject
    Microsoft.VisualStudio.Data.Framework.ClipboardObject
      Microsoft.VisualStudio.Data.Framework.DSRefClipboardObject

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

Syntax

'Declaration
Public Class DSRefClipboardObject _
    Inherits ClipboardObject

public class DSRefClipboardObject : ClipboardObject

public ref class DSRefClipboardObject : public ClipboardObject

type DSRefClipboardObject =  
    class 
        inherit ClipboardObject 
    end

public class DSRefClipboardObject extends ClipboardObject

The DSRefClipboardObject type exposes the following members.

Constructors

  Name Description
Public method DSRefClipboardObject() Initializes a new instance of the DSRefClipboardObject class.
Public method DSRefClipboardObject(Object) Initializes a new instance of the DSRefClipboardObject class, specifying a DSRef object.

Top

Methods

  Name Description
Public method ContainsAudio Indicates whether the data object contains data in the WaveAudio format. (Inherited from DataObject.)
Public method ContainsDSRef Indicates whether the current DSRefClipboardObject contains a DSRef object.
Public method ContainsFileDropList Indicates whether the data object contains data that is in the FileDrop format or can be converted to that format. (Inherited from DataObject.)
Public method ContainsImage Indicates whether the data object contains data that is in the Bitmap format or can be converted to that format. (Inherited from DataObject.)
Public method ContainsText() Indicates whether the data object contains data in the UnicodeText format. (Inherited from DataObject.)
Public method ContainsText(TextDataFormat) Indicates whether the data object contains text data in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAudioStream Retrieves an audio stream from the data object. (Inherited from DataObject.)
Public method GetData(String) Retrieves the data stored in the clipboard object in the specified format. (Inherited from ClipboardObject.)
Public method GetData(Type) Retrieves the data stored in the clipboard object in the specified format. (Inherited from ClipboardObject.)
Public method GetData(String, Boolean) Retrieves the data stored in the clipboard object in the specified format, using an automated conversion parameter to determine whether to convert the data to the format. (Inherited from ClipboardObject.)
Public method GetDataPresent(String) Indicates whether data stored in the clipboard object can be converted to or is associated with the specified format. (Inherited from ClipboardObject.)
Public method GetDataPresent(Type) Indicates whether data stored in the clipboard object can be converted to or is associated with the specified format. (Inherited from ClipboardObject.)
Public method GetDataPresent(String, Boolean) Indicates whether data stored in the clipboard object can be converted to or is associated with the specified format, using an automatic conversion parameter to determine whether to convert the data to the format. (Inherited from ClipboardObject.)
Public method GetDSRef Extracts the DSRef object from the DSRefClipboardObject.
Public method GetFileDropList Retrieves a collection of file names from the data object. (Inherited from DataObject.)
Public method GetFormats() Retrieves a list of all formats that are supported for the data stored in the clipboard object. (Inherited from ClipboardObject.)
Public method GetFormats(Boolean) Retrieves a list of all formats that are supported for the data stored in the clipboard object, using an automatic conversion parameter to determine whether to retrieve only native data formats or all formats that the data can be converted to. (Inherited from ClipboardObject.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetImage Retrieves an image from the data object. (Inherited from DataObject.)
Public method GetText() Retrieves text data from the data object in the UnicodeText format. (Inherited from DataObject.)
Public method GetText(TextDataFormat) Retrieves text data from the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetAudio(array<Byte[]) Adds a Byte array to the data object in the WaveAudio format after converting it to a Stream. (Inherited from DataObject.)
Public method SetAudio(Stream) Adds a Stream to the data object in the WaveAudio format. (Inherited from DataObject.)
Public method SetData(Object) Adds data to the clipboard object. (Inherited from ClipboardObject.)
Public method SetData(String, Object) Adds data to the clipboard object in the specified format. (Inherited from ClipboardObject.)
Public method SetData(Type, Object) Adds data to the clipboard object, using the specified type as the format. (Inherited from ClipboardObject.)
Public method SetData(String, Boolean, Object) Adds data to the clipboard object. (Inherited from ClipboardObject.)
Public method SetDSRef Adds the DSRef object to the DSRefClipboardObject.
Public method SetFileDropList Adds a collection of file names to the data object in the FileDrop format. (Inherited from DataObject.)
Public method SetImage Adds an Image to the data object in the Bitmap format. (Inherited from DataObject.)
Public method SetText(String) Adds text data to the data object in the UnicodeText format. (Inherited from DataObject.)
Public method SetText(String, TextDataFormat) Adds text data to the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IDataObject.DAdvise Creates a connection between the clipboard object and an advisory sink. This method is called by an object that supports an advisory sink and enables the advisory sink to be notified of changes in the object's data. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.DAdvise Creates a connection between the clipboard object and an advisory sink. This method is called by an object that supports an advisory sink and enables the advisory sink to be notified of changes in the object's data. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.DUnadvise Removes a notification connection that has been established. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.DUnadvise Removes a notification connection that had been previously established. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.EnumDAdvise Creates an object that can be used to enumerate the current advisory connections. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.EnumDAdvise Creates an object that can be used to enumerate the current advisory connections. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.EnumFormatEtc Creates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to IDataObject.GetData or IDataObject.SetData. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.EnumFormatEtc Creates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to IDataObject.GetData or IDataObject.SetData. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.GetCanonicalFormatEtc Provides a standard FORMATETC structure that is logically equivalent to a more complex structure. Use this method to determine whether two different FORMATETC structures return the same data, removing the need for duplicate rendering. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.GetCanonicalFormatEtc Provides a standard FORMATETC structure that is logically equivalent to a more complex structure. Use this method to determine whether two different FORMATETC structures return the same data, removing the need for duplicate rendering. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.GetData Obtains data from a source data object. This method is called by a data consumer. It renders the data described in the specified FORMATETC structure and transfers it through the specified STGMEDIUM structure. The caller then assumes responsibility for releasing the STGMEDIUM structure. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.GetData Obtains data from a source data object. This method is called by a data consumer. It renders the data described in the specified FORMATETC structure and transfers it through the specified STGMEDIUM structure. The caller then assumes responsibility for releasing the STGMEDIUM structure. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.GetDataHere Obtains data from a source data object. This method, which is called by a data consumer, differs from the IDataObject.GetData method in that the caller must allocate and free the specified storage medium. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.GetDataHere Obtains data from a source data object. This method, which is called by a data consumer, differs from the IDataObject.GetData method in that the caller must allocate and free the specified storage medium. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.QueryGetData Determines whether the data object is capable of rendering the data described in the FORMATETC structure. Objects attempting a paste or drop operation can call this method before calling IDataObject.GetData to get an indication of whether the operation will be successful. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.QueryGetData Determines whether the data object is capable of rendering the data described in the FORMATETC structure. Objects attempting a paste or drop operation can call this method before calling IDataObject.GetData to get an indication of whether the operation will be successful. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.SetData Transfers data to the object that implements this method. This method is called by an object that contains a data source. (Inherited from ClipboardObject.)
Explicit interface implemetationPrivate method IDataObject.SetData Transfers data to the object that implements this method. This method is called by an object that contains a data source. (Inherited from ClipboardObject.)

Top

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

Microsoft.VisualStudio.Data.Framework Namespace

IDSRefProvider