OleDataObject Class
Provides a managed class that implements the IOleDataObject interface.
Inheritance Hierarchy
Object
DataObject
Microsoft.VisualStudio.Shell.OleDataObject
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Syntax
'Declaration
Public Class OleDataObject _
Inherits DataObject _
Implements IDataObject
public class OleDataObject : DataObject,
IDataObject
public ref class OleDataObject : public DataObject,
IDataObject
type OleDataObject =
class
inherit DataObject
interface IDataObject
end
public class OleDataObject extends DataObject implements IDataObject
The OleDataObject type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
OleDataObject() | Initializes a new instance of OleDataObject. |
|
OleDataObject(IDataObject) | Initializes a new instance of OleDataObject for the specified IDataObject. |
|
OleDataObject(IDataObject) | Initializes a new instance of OleDataObject for the specified IDataObject. |
|
OleDataObject(IDataObject) | Initializes a new instance of OleDataObject for the specified object implementing IDataObject. |
Top
Methods
| Name | Description | |
|---|---|---|
|
ContainsAudio | Indicates whether the data object contains data in the WaveAudio format. (Inherited from DataObject.) |
|
ContainsFileDropList | Indicates whether the data object contains data that is in the FileDrop format or can be converted to that format. (Inherited from DataObject.) |
|
ContainsImage | Indicates whether the data object contains data that is in the Bitmap format or can be converted to that format. (Inherited from DataObject.) |
|
ContainsText | Indicates whether the data object contains data in the UnicodeText format. (Inherited from DataObject.) |
|
ContainsText(TextDataFormat) | Indicates whether the data object contains text data in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.) |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
.gif "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.) |
|
GetAudioStream | Retrieves an audio stream from the data object. (Inherited from DataObject.) |
|
GetData(String) | Returns the data associated with the specified data format. (Inherited from DataObject.) |
|
GetData(Type) | Returns the data associated with the specified class type format. (Inherited from DataObject.) |
|
GetData(String, Boolean) | Returns the data associated with the specified data format, using an automated conversion parameter to determine whether to convert the data to the format. (Inherited from DataObject.) |
|
GetDataPresent(Type) | Determines whether data stored in this DataObject is associated with, or can be converted to, the specified format. (Inherited from DataObject.) |
|
GetDataPresent(String) | Determines whether data stored in this DataObject is associated with, or can be converted to, the specified format. (Inherited from DataObject.) |
|
GetDataPresent(String, Boolean) | Determines whether this DataObject contains data in the specified format or, optionally, contains data that can be converted to the specified format. (Inherited from DataObject.) |
|
GetFileDropList | Retrieves a collection of file names from the data object. (Inherited from DataObject.) |
|
GetFormats | Returns a list of all formats that data stored in this DataObject is associated with or can be converted to. (Inherited from DataObject.) |
|
GetFormats(Boolean) | Returns a list of all formats that data stored in this DataObject is associated with or can be converted to, 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 DataObject.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetImage | Retrieves an image from the data object. (Inherited from DataObject.) |
|
GetText | Retrieves text data from the data object in the UnicodeText format. (Inherited from DataObject.) |
|
GetText(TextDataFormat) | Retrieves text data from the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
SetAudio(Byte) | Adds a Byte array to the data object in the WaveAudio format after converting it to a Stream. (Inherited from DataObject.) |
|
SetAudio(Stream) | Adds a Stream to the data object in the WaveAudio format. (Inherited from DataObject.) |
|
SetData(Object) | Adds the specified object to the DataObject using the object type as the data format. (Inherited from DataObject.) |
|
SetData(String, Object) | Adds the specified object to the DataObject using the specified format. (Inherited from DataObject.) |
|
SetData(Type, Object) | Adds the specified object to the DataObject using the specified type as the format. (Inherited from DataObject.) |
|
SetData(String, Boolean, Object) | Adds the specified object to the DataObject using the specified format and indicating whether the data can be converted to another format. (Inherited from DataObject.) |
|
SetFileDropList | Adds a collection of file names to the data object in the FileDrop format. (Inherited from DataObject.) |
|
SetImage | Adds an Image to the data object in the Bitmap format. (Inherited from DataObject.) |
|
SetText(String) | Adds text data to the data object in the UnicodeText format. (Inherited from DataObject.) |
|
SetText(String, TextDataFormat) | Adds text data to the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
System#Runtime#InteropServices#ComTypes#IDataObject#DAdvise | Infrastructure. Creates a connection between a data 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 DataObject.) |
|
System#Runtime#InteropServices#ComTypes#IDataObject#DUnadvise | Infrastructure. Destroys a notification connection that had been previously established. (Inherited from DataObject.) |
|
System#Runtime#InteropServices#ComTypes#IDataObject#EnumDAdvise | Infrastructure. Creates an object that can be used to enumerate the current advisory connections. (Inherited from DataObject.) |
|
System#Runtime#InteropServices#ComTypes#IDataObject#EnumFormatEtc | Infrastructure. Creates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to GetData or SetData. (Inherited from DataObject.) |
|
System#Runtime#InteropServices#ComTypes#IDataObject#GetCanonicalFormatEtc | Infrastructure. Provides a standard FORMATETC structure that is logically equivalent to a more complex structure. Use this method to determine whether two different FORMATETC structures would return the same data, removing the need for duplicate rendering. (Inherited from DataObject.) |
|
System#Runtime#InteropServices#ComTypes#IDataObject#GetData | Infrastructure. Obtains data from a source data object. The GetData method, which is called by a data consumer, 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 DataObject.) |
|
System#Runtime#InteropServices#ComTypes#IDataObject#GetDataHere | Infrastructure. Obtains data from a source data object. This method, which is called by a data consumer, differs from the GetData method in that the caller must allocate and free the specified storage medium. (Inherited from DataObject.) |
|
IDataObject.DAdvise | Establishes a connection between the data object and a caller object implementing IAdviseSink. |
|
IDataObject.DUnadvise | Terminates an advise connection previously established through DAdvise. |
|
IDataObject.EnumDAdvise | Creates an enumerator to iterate through the current advisory connections. |
|
IDataObject.EnumFormatEtc | Creates an enumerator to iterate through the FORMATETC structures supported by the data object. |
|
IDataObject.GetCanonicalFormatEtc | Retrieves a FORMATETC structure that is logically equivalent to one that is more complex. |
|
IDataObject.GetData | Transfers data from the data object to the client. The pformatetcIn parameter must specify a storage medium type of TYMED_MFPICT. |
|
IDataObject.GetDataHere | Transfers data from the data object to the client. The client must allocate the STGMEDIUM structure. |
|
IDataObject.QueryGetData | Determines whether the data object supports a particular FORMATETC structure for transferring data. |
|
IDataObject.SetData | Transfers data from the client to the data object. |
|
System#Runtime#InteropServices#ComTypes#IDataObject#QueryGetData | Infrastructure. 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 GetData to get an indication of whether the operation may be successful. (Inherited from DataObject.) |
|
System#Runtime#InteropServices#ComTypes#IDataObject#SetData | Infrastructure. Transfers data to the object that implements this method. This method is called by an object that contains a data source. (Inherited from DataObject.) |
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.