Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

1221 lines
70 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="DataObject" FullName="System.Windows.Forms.DataObject">
<TypeSignature Language="C#" Value="public class DataObject : System.Runtime.InteropServices.ComTypes.IDataObject, System.Windows.Forms.IDataObject" />
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.InteropServices.ComTypes.IDataObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Windows.Forms.IDataObject</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Windows.Forms.DataObject" /> implements the <see cref="T:System.Windows.Forms.IDataObject" /> interface, whose methods provide a format-independent mechanism for data transfer.</para>
<para>A <see cref="T:System.Windows.Forms.DataObject" /> is typically used with the <see cref="T:System.Windows.Forms.Clipboard" /> and in drag-and-drop operations. The <see cref="T:System.Windows.Forms.DataObject" /> class provides the recommended implementation of the <see cref="T:System.Windows.Forms.IDataObject" /> interface. It is suggested that you use the <see cref="T:System.Windows.Forms.DataObject" /> class rather than implementing <see cref="T:System.Windows.Forms.IDataObject" /> yourself.</para>
<para>Multiple pieces of data in different formats can be stored in a <see cref="T:System.Windows.Forms.DataObject" />. Data is retrieved from a <see cref="T:System.Windows.Forms.DataObject" /> by its associated format. Because the target application might not be known, you can increase the likelihood that the data will be in the appropriate format for an application by placing the data in a <see cref="T:System.Windows.Forms.DataObject" /> in multiple formats. See <see cref="T:System.Windows.Forms.DataFormats" /> for the predefined formats. You can implement your own format by creating an instance of the <see cref="T:System.Windows.Forms.DataFormats.Format" /> class.</para>
<para>To store data in a <see cref="T:System.Windows.Forms.DataObject" />, pass the data to the constructor or call <see cref="Overload:System.Windows.Forms.DataObject.SetData" />. You can add data in multiple formats to the same <see cref="T:System.Windows.Forms.DataObject" />. If you want the data you add to be retrieved in its native format only, call <see cref="M:System.Windows.Forms.DataObject.SetData(System.String,System.Boolean,System.Object)" /> with the <paramref name="autoConvert" /> parameter set to false.</para>
<para>Data can be retrieved from a <see cref="T:System.Windows.Forms.DataObject" /> in any format which is compatible with <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" />. For example, text can be converted to Unicode. To retrieve data in the format in which it was stored, call <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" /> with the <paramref name="autoConvert" /> parameter set to false.</para>
<para>To determine what formats the data is stored in, call <see cref="M:System.Windows.Forms.DataObject.GetFormats(System.Boolean)" />. To determine if a format is available, call <see cref="M:System.Windows.Forms.DataObject.GetDataPresent(System.Type)" /> with the desired format.</para>
<para>In dnprdnext, the <see cref="T:System.Windows.Forms.DataObject" /> class provides additional methods that make it easier to work with data in common formats. To add data of a particular format to the <see cref="T:System.Windows.Forms.DataObject" />, use the appropriate SetFormat method, such as <see cref="Overload:System.Windows.Forms.DataObject.SetText" />. To retrieve data of a particular format from the <see cref="T:System.Windows.Forms.DataObject" />, first call the appropriate ContainsFormat method (such as <see cref="Overload:System.Windows.Forms.DataObject.ContainsText" />) to determine whether the <see cref="T:System.Windows.Forms.DataObject" /> contains data in that format, then call the appropriate GetFormat method (such as <see cref="Overload:System.Windows.Forms.DataObject.GetText" />) to retrieve the data if the <see cref="T:System.Windows.Forms.DataObject" /> contains it.</para>
<block subset="none" type="note">
<para>Special considerations may be necessary when using the metafile format with the Clipboard. Due to a limitation in the current implementation of the <see cref="T:System.Windows.Forms.DataObject" /> class, the metafile format used by the .NET Framework may not be recognized by applications that use an older metafile format. In this case, you must interoperate with the Win32 Clipboard application programming interfaces (APIs). For more information, see article 323530, "Metafiles on Clipboard Are Not Visible to All Applications," in the Microsoft Knowledge Base at http://support.microsoft.com.</para>
<para>An object must be serializable for it to be put on the Clipboard. See <see cref="N:System.Runtime.Serialization" /> for more information on serialization. If your target application requires a very specific data format, the headers added to the data in the serialization process may prevent the application from recognizing your data. To preserve your data format, add your data as a <see cref="T:System.Byte" /> array to a <see cref="T:System.IO.MemoryStream" /> and pass the <see cref="T:System.IO.MemoryStream" /> to the <see cref="M:System.Windows.Forms.DataObject.SetData(System.Object)" /> method. </para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements a basic data transfer mechanism.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataObject ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Windows.Forms.DataObject" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataObject (object data);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can add data in any format to the <see cref="T:System.Windows.Forms.DataObject" /> when you use this constructor, or you can add data as an <see cref="T:System.Windows.Forms.IDataObject" /> to provide multiple formats at once. If you are familiar with COM programming, you can also add a data object that implements the COM IDataObject interface. For more information, see IDataObject in the MSDN library at http://msdn.microsoft.com/library.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Windows.Forms.DataObject" /> class and adds the specified object to it.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />The data to store. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataObject (string format, object data);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="format" Type="System.String" />
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Windows.Forms.DataObject" /> class and adds the specified object in the specified format.</para>
</summary>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />The format of the specified data. See <see cref="T:System.Windows.Forms.DataFormats" /> for predefined formats.</param>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />The data to store. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ContainsAudio">
<MemberSignature Language="C#" Value="public virtual bool ContainsAudio ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to determine whether the data object contains audio data before retrieving it with the <see cref="M:System.Windows.Forms.DataObject.GetAudioStream" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the data object contains data in the <see cref="F:System.Windows.Forms.DataFormats.WaveAudio" /> format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the data object contains audio data; otherwise, false.</para>
</returns>
</Docs>
</Member>
<Member MemberName="ContainsFileDropList">
<MemberSignature Language="C#" Value="public virtual bool ContainsFileDropList ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A file drop list is a collection of strings containing path information for files.</para>
<para>Use this method to determine whether the data object contains a file drop list before retrieving it with the <see cref="M:System.Windows.Forms.DataObject.GetFileDropList" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the data object contains data that is in the <see cref="F:System.Windows.Forms.DataFormats.FileDrop" /> format or can be converted to that format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the data object contains a file drop list; otherwise, false.</para>
</returns>
</Docs>
</Member>
<Member MemberName="ContainsImage">
<MemberSignature Language="C#" Value="public virtual bool ContainsImage ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to determine whether the data object contains image data before retrieving it with the <see cref="M:System.Windows.Forms.DataObject.GetImage" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the data object contains data that is in the <see cref="F:System.Windows.Forms.DataFormats.Bitmap" /> format or can be converted to that format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the data object contains image data; otherwise, false.</para>
</returns>
</Docs>
</Member>
<Member MemberName="ContainsText">
<MemberSignature Language="C#" Value="public virtual bool ContainsText ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to determine whether the data object contains text data before retrieving it with the <see cref="Overload:System.Windows.Forms.DataObject.GetText" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the data object contains data in the <see cref="F:System.Windows.Forms.TextDataFormat.UnicodeText" /> format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the data object contains text data; otherwise, false.</para>
</returns>
</Docs>
</Member>
<Member MemberName="ContainsText">
<MemberSignature Language="C#" Value="public virtual bool ContainsText (System.Windows.Forms.TextDataFormat format);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.Windows.Forms.TextDataFormat" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to determine whether the data object contains text data before retrieving it with the <see cref="Overload:System.Windows.Forms.DataObject.GetText" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the data object contains text data in the format indicated by the specified <see cref="T:System.Windows.Forms.TextDataFormat" /> value.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the data object contains text data in the specified format; otherwise, false.</para>
</returns>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.TextDataFormat" /> values.</param>
</Docs>
</Member>
<Member MemberName="GetAudioStream">
<MemberSignature Language="C#" Value="public virtual System.IO.Stream GetAudioStream ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="M:System.Windows.Forms.DataObject.ContainsAudio" /> method to determine whether the data object contains audio data before retrieving it with this method.</para>
<para>Use the <see cref="Overload:System.Windows.Forms.DataObject.SetAudio" /> method to add audio data to the data object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves an audio stream from the data object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.IO.Stream" /> containing audio data or null if the data object does not contain any data in the <see cref="F:System.Windows.Forms.DataFormats.WaveAudio" /> format.</para>
</returns>
</Docs>
</Member>
<Member MemberName="GetData">
<MemberSignature Language="C#" Value="public virtual object GetData (string format);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If this method cannot find data in the specified format, it attempts to convert the data to the format. If the data cannot be converted to the specified format, or if the data was stored with automatic conversion set to false, this method returns null.</para>
<para>To determine whether data is associated with, or can be converted to, a format, call <see cref="M:System.Windows.Forms.DataObject.GetDataPresent(System.Type)" /> before calling <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" />. Call <see cref="M:System.Windows.Forms.DataObject.GetFormats(System.Boolean)" /> for a list of valid formats for the data stored in this <see cref="T:System.Windows.Forms.DataObject" />.</para>
<block subset="none" type="note">
<para>Data can be converted to another format if it was stored specifying that conversion is allowed, and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the data associated with the specified data format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The data associated with the specified format, or null.</para>
</returns>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />The format of the data to retrieve. See <see cref="T:System.Windows.Forms.DataFormats" /> for predefined formats. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetData">
<MemberSignature Language="C#" Value="public virtual object GetData (Type format);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.Type" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If this method cannot find data in the specified format, it attempts to convert the data to the format. If the data cannot be converted to the specified format, or if the data was stored with automatic conversion set to false, this method returns null.</para>
<para>To determine whether data is associated with, or can be converted to, a format, call <see cref="M:System.Windows.Forms.DataObject.GetDataPresent(System.Type)" /> before calling <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" />. Call <see cref="M:System.Windows.Forms.DataObject.GetFormats(System.Boolean)" /> for a list of valid formats for the data stored in this <see cref="T:System.Windows.Forms.DataObject" />.</para>
<block subset="none" type="note">
<para>Data can be converted to another format if it was stored specifying that conversion is allowed, and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the data associated with the specified class type format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The data associated with the specified format, or null.</para>
</returns>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Type" /> representing the format of the data to retrieve. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetData">
<MemberSignature Language="C#" Value="public virtual object GetData (string format, bool autoConvert);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String" />
<Parameter Name="autoConvert" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the <paramref name="autoConvert" /> parameter is true and this method cannot find data in the specified format, it attempts to convert the data to the format. If the data cannot be converted to the specified format, or if the data was stored with the automatic conversion set to false, this method returns null.</para>
<para>If the <paramref name="autoConvert" /> parameter is false, this method returns data in the specified format, or null if no data in this format can be found.</para>
<para>To determine whether data is associated with, or can be converted to, a format, call <see cref="M:System.Windows.Forms.DataObject.GetDataPresent(System.Type)" /> before calling <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" />. Call <see cref="M:System.Windows.Forms.DataObject.GetFormats(System.Boolean)" /> for a list of valid formats for the data stored in this <see cref="T:System.Windows.Forms.DataObject" />.</para>
<block subset="none" type="note">
<para>Data can be converted to another format if it was stored specifying that conversion is allowed, and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the data associated with the specified data format, using an automated conversion parameter to determine whether to convert the data to the format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The data associated with the specified format, or null.</para>
</returns>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />The format of the data to retrieve. See <see cref="T:System.Windows.Forms.DataFormats" /> for predefined formats. </param>
<param name="autoConvert">
<attribution license="cc4" from="Microsoft" modified="false" />true to the convert data to the specified format; otherwise, false. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetDataPresent">
<MemberSignature Language="C#" Value="public virtual bool GetDataPresent (string format);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call this method to determine whether a format exists before calling <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" />. Call <see cref="M:System.Windows.Forms.DataObject.GetFormats(System.Boolean)" /> for the formats that are available in this <see cref="T:System.Windows.Forms.DataObject" />.</para>
<block subset="none" type="note">
<para>Data can be converted to another format if it was stored specifying that conversion is allowed, and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text.</para>
</block>
<block subset="none" type="note">
<para>If no data can be retrieved, no exception will be thrown. Instead, false will be returned.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether data stored in this <see cref="T:System.Windows.Forms.DataObject" /> is associated with, or can be converted to, the specified format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if data stored in this <see cref="T:System.Windows.Forms.DataObject" /> is associated with, or can be converted to, the specified format; otherwise, false.</para>
</returns>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />The format to check for. See <see cref="T:System.Windows.Forms.DataFormats" /> for predefined formats. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetDataPresent">
<MemberSignature Language="C#" Value="public virtual bool GetDataPresent (Type format);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.Type" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call this method to determine whether a format exists before calling <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" />. Call <see cref="M:System.Windows.Forms.DataObject.GetFormats(System.Boolean)" /> for the formats that are available in this <see cref="T:System.Windows.Forms.DataObject" />.</para>
<block subset="none" type="note">
<para>Data can be converted to another format if it was stored specifying that conversion is allowed, and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text.</para>
</block>
<block subset="none" type="note">
<para>If no data can be retrieved, no exception will be thrown. Instead, false will be returned.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether data stored in this <see cref="T:System.Windows.Forms.DataObject" /> is associated with, or can be converted to, the specified format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if data stored in this <see cref="T:System.Windows.Forms.DataObject" /> is associated with, or can be converted to, the specified format; otherwise, false.</para>
</returns>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Type" /> representing the format to check for. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetDataPresent">
<MemberSignature Language="C#" Value="public virtual bool GetDataPresent (string format, bool autoConvert);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String" />
<Parameter Name="autoConvert" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call this method to determine whether a format exists before calling <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" />. Call <see cref="M:System.Windows.Forms.DataObject.GetFormats(System.Boolean)" /> for the formats that are available in this <see cref="T:System.Windows.Forms.DataObject" />.</para>
<para>This method returns true when: </para>
<list type="bullet">
<item>
<para>The <paramref name="autoConvert" /> parameter is true and the data is in a format that can be converted to the appropriate format.</para>
</item>
<item>
<para>The <paramref name="autoConvert" /> parameter is false and the data is in the appropriate format.</para>
</item>
</list>
<para>This method returns false when: </para>
<list type="bullet">
<item>
<para>The <paramref name="autoConvert" /> parameter is true and this method cannot find data in the specified format, and it cannot convert data to the specified format, or the data was stored with automatic conversion set to false.</para>
</item>
<item>
<para>The <paramref name="autoConvert" /> parameter is false and data does not exist in this <see cref="T:System.Windows.Forms.DataObject" /> in the specified format.</para>
</item>
</list>
<block subset="none" type="note">
<para>Data can be converted to another format if it was stored specifying that conversion is allowed and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text.</para>
</block>
<block subset="none" type="note">
<para>If no data can be retrieved, no exception will be thrown. Instead, false will be returned.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether this <see cref="T:System.Windows.Forms.DataObject" /> contains data in the specified format or, optionally, contains data that can be converted to the specified format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the data is in, or can be converted to, the specified format; otherwise, false.</para>
</returns>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />The format to check for. See <see cref="T:System.Windows.Forms.DataFormats" /> for predefined formats. </param>
<param name="autoConvert">
<attribution license="cc4" from="Microsoft" modified="false" />true to determine whether data stored in this <see cref="T:System.Windows.Forms.DataObject" /> can be converted to the specified format; false to check whether the data is in the specified format. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetFileDropList">
<MemberSignature Language="C#" Value="public virtual System.Collections.Specialized.StringCollection GetFileDropList ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Specialized.StringCollection</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A file drop list is a collection of strings containing path information for files.</para>
<para>A file drop list is stored in a data object as a <see cref="T:System.String" /> array. This method converts this array to a <see cref="T:System.Collections.Specialized.StringCollection" /> and returns the collection.</para>
<para>Use the <see cref="M:System.Windows.Forms.DataObject.ContainsFileDropList" /> method to determine whether the data object contains a file drop list before retrieving it with this method.</para>
<para>Use the <see cref="M:System.Windows.Forms.DataObject.SetFileDropList(System.Collections.Specialized.StringCollection)" /> method to add a file drop list to the data object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves a collection of file names from the data object. </para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Collections.Specialized.StringCollection" /> containing file names or null if the data object does not contain any data that is in the <see cref="F:System.Windows.Forms.DataFormats.FileDrop" /> format or can be converted to that format.</para>
</returns>
</Docs>
</Member>
<Member MemberName="GetFormats">
<MemberSignature Language="C#" Value="public virtual string[] GetFormats ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call this method to get the supported data formats before calling <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" />. See <see cref="T:System.Windows.Forms.DataFormats" /> for the predefined formats.</para>
<block subset="none" type="note">
<para>Data can be converted to another format if it was stored specifying that conversion is allowed and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a list of all formats that data stored in this <see cref="T:System.Windows.Forms.DataObject" /> is associated with or can be converted to.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An array of type <see cref="T:System.String" />, containing a list of all formats that are supported by the data stored in this object.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetFormats">
<MemberSignature Language="C#" Value="public virtual string[] GetFormats (bool autoConvert);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="autoConvert" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call this method to get the supported data formats before calling <see cref="M:System.Windows.Forms.DataObject.GetData(System.String,System.Boolean)" />. See <see cref="T:System.Windows.Forms.DataFormats" /> for the predefined formats.</para>
<block subset="none" type="note">
<para>Data can be converted to another format if it was stored specifying that conversion is allowed and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a list of all formats that data stored in this <see cref="T:System.Windows.Forms.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.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An array of type <see cref="T:System.String" />, containing a list of all formats that are supported by the data stored in this object.</para>
</returns>
<param name="autoConvert">
<attribution license="cc4" from="Microsoft" modified="false" />true to retrieve all formats that data stored in this <see cref="T:System.Windows.Forms.DataObject" /> is associated with, or can be converted to; false to retrieve only native data formats. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetImage">
<MemberSignature Language="C#" Value="public virtual System.Drawing.Image GetImage ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Drawing.Image</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="M:System.Windows.Forms.DataObject.ContainsImage" /> method to determine whether the data object contains image data before retrieving it with this method.</para>
<para>Use the <see cref="M:System.Windows.Forms.DataObject.SetImage(System.Drawing.Image)" /> method to add image data to the data object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves an image from the data object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Drawing.Image" /> representing the image data in the data object or null if the data object does not contain any data that is in the <see cref="F:System.Windows.Forms.DataFormats.Bitmap" /> format or can be converted to that format.</para>
</returns>
</Docs>
</Member>
<Member MemberName="GetText">
<MemberSignature Language="C#" Value="public virtual string GetText ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="Overload:System.Windows.Forms.DataObject.ContainsText" /> method to determine whether the data object contains text data before retrieving it with this method.</para>
<para>Use the <see cref="Overload:System.Windows.Forms.DataObject.SetText" /> method to add text data to the data object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves text data from the data object in the <see cref="F:System.Windows.Forms.TextDataFormat.UnicodeText" /> format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The text data in the data object or <see cref="F:System.String.Empty" /> if the data object does not contain data in the <see cref="F:System.Windows.Forms.TextDataFormat.UnicodeText" /> format.</para>
</returns>
</Docs>
</Member>
<Member MemberName="GetText">
<MemberSignature Language="C#" Value="public virtual string GetText (System.Windows.Forms.TextDataFormat format);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.Windows.Forms.TextDataFormat" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="Overload:System.Windows.Forms.DataObject.ContainsText" /> method to determine whether the data object contains text data before retrieving it with this method.</para>
<para>Use the <see cref="Overload:System.Windows.Forms.DataObject.SetText" /> method to add text data to the data object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves text data from the data object in the format indicated by the specified <see cref="T:System.Windows.Forms.TextDataFormat" /> value.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The text data in the data object or <see cref="F:System.String.Empty" /> if the data object does not contain data in the specified format.</para>
</returns>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.TextDataFormat" /> values.</param>
</Docs>
</Member>
<Member MemberName="SetAudio">
<MemberSignature Language="C#" Value="public virtual void SetAudio (byte[] audioBytes);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="audioBytes" Type="System.Byte[]" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To retrieve audio data from the data object, first use the <see cref="M:System.Windows.Forms.DataObject.ContainsAudio" /> method to determine whether the data object contains audio data before retrieving it with the <see cref="M:System.Windows.Forms.DataObject.GetAudioStream" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds a <see cref="T:System.Byte" /> array to the data object in the <see cref="F:System.Windows.Forms.DataFormats.WaveAudio" /> format after converting it to a <see cref="T:System.IO.Stream" />.</para>
</summary>
<param name="audioBytes">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Byte" /> array containing the audio data.</param>
</Docs>
</Member>
<Member MemberName="SetAudio">
<MemberSignature Language="C#" Value="public virtual void SetAudio (System.IO.Stream audioStream);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="audioStream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To retrieve audio data from the data object, first use the <see cref="M:System.Windows.Forms.DataObject.ContainsAudio" /> method to determine whether the data object contains audio data before retrieving it with the <see cref="M:System.Windows.Forms.DataObject.GetAudioStream" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds a <see cref="T:System.IO.Stream" /> to the data object in the <see cref="F:System.Windows.Forms.DataFormats.WaveAudio" /> format.</para>
</summary>
<param name="audioStream">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.IO.Stream" /> containing the audio data.</param>
</Docs>
</Member>
<Member MemberName="SetData">
<MemberSignature Language="C#" Value="public virtual void SetData (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If you do not know the format of the target application, you can store data in multiple formats using this method. Data stored using this method can be converted to a compatible format when it is retrieved.</para>
<para>The <see cref="M:System.Windows.Forms.DataObject.SetData(System.Object)" /> overload stores the <paramref name="data" /> value in a format that it determines by calling the <see cref="M:System.Object.GetType" /> method. If <paramref name="data" /> implements the <see cref="T:System.Runtime.Serialization.ISerializable" /> interface, this overload also stores the value in the <see cref="F:System.Windows.DataFormats.Serializable" /> format.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds the specified object to the <see cref="T:System.Windows.Forms.DataObject" /> using the object type as the data format.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />The data to store. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SetData">
<MemberSignature Language="C#" Value="public virtual void SetData (string format, object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String" />
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If you do not know the format of the target application, you can store data in multiple formats using this method.</para>
<para>Data stored using this method can be converted to a compatible format when it is retrieved.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds the specified object to the <see cref="T:System.Windows.Forms.DataObject" /> using the specified format.</para>
</summary>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />The format associated with the data. See <see cref="T:System.Windows.Forms.DataFormats" /> for predefined formats. </param>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />The data to store. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SetData">
<MemberSignature Language="C#" Value="public virtual void SetData (Type format, object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.Type" />
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If you do not know the format of the target application, you can store data in multiple formats using this method.</para>
<para>Data stored using this method can be converted to a compatible format when it is retrieved.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds the specified object to the <see cref="T:System.Windows.Forms.DataObject" /> using the specified type as the format.</para>
</summary>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Type" /> representing the format associated with the data. </param>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />The data to store. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SetData">
<MemberSignature Language="C#" Value="public virtual void SetData (string format, bool autoConvert, object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String" />
<Parameter Name="autoConvert" Type="System.Boolean" />
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If you do not know the format of the target application, you can store data in multiple formats using this method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds the specified object to the <see cref="T:System.Windows.Forms.DataObject" /> using the specified format and indicating whether the data can be converted to another format.</para>
</summary>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />The format associated with the data. See <see cref="T:System.Windows.Forms.DataFormats" /> for predefined formats. </param>
<param name="autoConvert">
<attribution license="cc4" from="Microsoft" modified="false" />true to allow the data to be converted to another format; otherwise, false. </param>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />The data to store. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SetFileDropList">
<MemberSignature Language="C#" Value="public virtual void SetFileDropList (System.Collections.Specialized.StringCollection filePaths);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filePaths" Type="System.Collections.Specialized.StringCollection" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A file drop list is a collection of strings containing path information for files.</para>
<para>A file drop list is stored in a data object as a <see cref="T:System.String" /> array. This method converts <paramref name="filePaths" /> to a <see cref="T:System.String" /> array before adding it to the data object. </para>
<para>To retrieve a file drop list from the data object, first use the <see cref="M:System.Windows.Forms.DataObject.ContainsFileDropList" /> method to determine whether the data object contains data in that format before retrieving it with the <see cref="M:System.Windows.Forms.DataObject.GetFileDropList" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds a collection of file names to the data object in the <see cref="F:System.Windows.Forms.DataFormats.FileDrop" /> format.</para>
</summary>
<param name="filePaths">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.Specialized.StringCollection" /> containing the file names.</param>
</Docs>
</Member>
<Member MemberName="SetImage">
<MemberSignature Language="C#" Value="public virtual void SetImage (System.Drawing.Image image);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="image" Type="System.Drawing.Image" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To retrieve image data from the data object, first use the <see cref="M:System.Windows.Forms.DataObject.ContainsImage" /> method to determine whether the data object contains image data before retrieving it with the <see cref="M:System.Windows.Forms.DataObject.GetImage" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds an <see cref="T:System.Drawing.Image" /> to the data object in the <see cref="F:System.Windows.Forms.DataFormats.Bitmap" /> format.</para>
</summary>
<param name="image">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Image" /> to add to the data object.</param>
</Docs>
</Member>
<Member MemberName="SetText">
<MemberSignature Language="C#" Value="public virtual void SetText (string textData);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="textData" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To retrieve text data from the data object, first use the <see cref="Overload:System.Windows.Forms.DataObject.ContainsText" /> method to determine whether the data object contains image data before retrieving it with the <see cref="Overload:System.Windows.Forms.DataObject.GetText" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds text data to the data object in the <see cref="F:System.Windows.Forms.TextDataFormat.UnicodeText" /> format.</para>
</summary>
<param name="textData">
<attribution license="cc4" from="Microsoft" modified="false" />The text to add to the data object.</param>
</Docs>
</Member>
<Member MemberName="SetText">
<MemberSignature Language="C#" Value="public virtual void SetText (string textData, System.Windows.Forms.TextDataFormat format);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="textData" Type="System.String" />
<Parameter Name="format" Type="System.Windows.Forms.TextDataFormat" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To retrieve text data from the data object, first use the <see cref="Overload:System.Windows.Forms.DataObject.ContainsText" /> method to determine whether the data object contains image data before retrieving it with the <see cref="Overload:System.Windows.Forms.DataObject.GetText" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds text data to the data object in the format indicated by the specified <see cref="T:System.Windows.Forms.TextDataFormat" /> value.</para>
</summary>
<param name="textData">
<attribution license="cc4" from="Microsoft" modified="false" />The text to add to the data object.</param>
<param name="format">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.TextDataFormat" /> values.</param>
</Docs>
</Member>
<Member MemberName="System.Runtime.InteropServices.ComTypes.IDataObject.DAdvise">
<MemberSignature Language="C#" Value="int IDataObject.DAdvise (ref System.Runtime.InteropServices.ComTypes.FORMATETC pFormatetc, System.Runtime.InteropServices.ComTypes.ADVF advf, System.Runtime.InteropServices.ComTypes.IAdviseSink adviseSink, out int connection);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pFormatetc" Type="System.Runtime.InteropServices.ComTypes.FORMATETC&amp;" RefType="ref" />
<Parameter Name="advf" Type="System.Runtime.InteropServices.ComTypes.ADVF" />
<Parameter Name="adviseSink" Type="System.Runtime.InteropServices.ComTypes.IAdviseSink" />
<Parameter Name="connection" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="pFormatetc">To be added.</param>
<param name="advf">To be added.</param>
<param name="adviseSink">To be added.</param>
<param name="connection">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Runtime.InteropServices.ComTypes.IDataObject.DUnadvise">
<MemberSignature Language="C#" Value="void IDataObject.DUnadvise (int connection);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="connection" Type="System.Int32" />
</Parameters>
<Docs>
<param name="connection">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataObject" /> is cast to an <see cref="T:System.Runtime.InteropServices.ComTypes.IDataObject" /> interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Destroys a notification connection that had been previously established.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method supports the following return values:</para>
<list type="table">
<listheader>
<item>
<term>
<para>Value</para>
</term>
<description>
<para>Description</para>
</description>
</item>
</listheader>
<item>
<term>
<para>S_OK</para>
</term>
<description>
<para>The specified connection was successfully deleted.</para>
</description>
</item>
<item>
<term>
<para>OLE_E_NOCONNECTION</para>
</term>
<description>
<para>The specified connection is not valid.</para>
</description>
</item>
<item>
<term>
<para>OLE_E_ADVISENOTSUPPORTED</para>
</term>
<description>
<para>This <see cref="T:System.Runtime.InteropServices.ComTypes.IDataObject" /> implementation does not support notification.</para>
</description>
</item>
</list>
</returns>
</Docs>
</Member>
<Member MemberName="System.Runtime.InteropServices.ComTypes.IDataObject.EnumDAdvise">
<MemberSignature Language="C#" Value="int IDataObject.EnumDAdvise (out System.Runtime.InteropServices.ComTypes.IEnumSTATDATA enumAdvise);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="enumAdvise" Type="System.Runtime.InteropServices.ComTypes.IEnumSTATDATA&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="enumAdvise">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Runtime.InteropServices.ComTypes.IDataObject.EnumFormatEtc">
<MemberSignature Language="C#" Value="System.Runtime.InteropServices.ComTypes.IEnumFORMATETC IDataObject.EnumFormatEtc (System.Runtime.InteropServices.ComTypes.DATADIR direction);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Runtime.InteropServices.ComTypes.IEnumFORMATETC</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="direction" Type="System.Runtime.InteropServices.ComTypes.DATADIR" />
</Parameters>
<Docs>
<param name="direction">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataObject" /> is cast to an <see cref="T:System.Runtime.InteropServices.ComTypes.IDataObject" /> interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates an object for enumerating the <see cref="T:System.Runtime.InteropServices.ComTypes.FORMATETC" /> structures for a data object. These structures are used in calls to <see cref="M:System.Runtime.InteropServices.ComTypes.IDataObject.GetData(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Runtime.InteropServices.ComTypes.STGMEDIUM@)" /> or <see cref="M:System.Runtime.InteropServices.ComTypes.IDataObject.SetData(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Runtime.InteropServices.ComTypes.STGMEDIUM@,System.Boolean)" />. </para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method supports the standard return values E_INVALIDARG and E_OUTOFMEMORY, as well as the following:</para>
<list type="table">
<listheader>
<item>
<term>
<para>Value</para>
</term>
<description>
<para>Description</para>
</description>
</item>
</listheader>
<item>
<term>
<para>S_OK</para>
</term>
<description>
<para>The enumerator object was successfully created.</para>
</description>
</item>
<item>
<term>
<para>E_NOTIMPL</para>
</term>
<description>
<para>The direction specified by the <paramref name="direction" /> parameter is not supported.</para>
</description>
</item>
<item>
<term>
<para>OLE_S_USEREG</para>
</term>
<description>
<para>Requests that OLE enumerate the formats from the registry.</para>
</description>
</item>
</list>
</returns>
</Docs>
</Member>
<Member MemberName="System.Runtime.InteropServices.ComTypes.IDataObject.GetCanonicalFormatEtc">
<MemberSignature Language="C#" Value="int IDataObject.GetCanonicalFormatEtc (ref System.Runtime.InteropServices.ComTypes.FORMATETC formatIn, out System.Runtime.InteropServices.ComTypes.FORMATETC formatOut);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="formatIn" Type="System.Runtime.InteropServices.ComTypes.FORMATETC&amp;" RefType="ref" />
<Parameter Name="formatOut" Type="System.Runtime.InteropServices.ComTypes.FORMATETC&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="formatIn">To be added.</param>
<param name="formatOut">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Runtime.InteropServices.ComTypes.IDataObject.GetData">
<MemberSignature Language="C#" Value="void IDataObject.GetData (ref System.Runtime.InteropServices.ComTypes.FORMATETC format, out System.Runtime.InteropServices.ComTypes.STGMEDIUM medium);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.Runtime.InteropServices.ComTypes.FORMATETC&amp;" RefType="ref" />
<Parameter Name="medium" Type="System.Runtime.InteropServices.ComTypes.STGMEDIUM&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="format">To be added.</param>
<param name="medium">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Runtime.InteropServices.ComTypes.IDataObject.GetDataHere">
<MemberSignature Language="C#" Value="void IDataObject.GetDataHere (ref System.Runtime.InteropServices.ComTypes.FORMATETC format, ref System.Runtime.InteropServices.ComTypes.STGMEDIUM medium);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.Runtime.InteropServices.ComTypes.FORMATETC&amp;" RefType="ref" />
<Parameter Name="medium" Type="System.Runtime.InteropServices.ComTypes.STGMEDIUM&amp;" RefType="ref" />
</Parameters>
<Docs>
<param name="format">To be added.</param>
<param name="medium">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Runtime.InteropServices.ComTypes.IDataObject.QueryGetData">
<MemberSignature Language="C#" Value="int IDataObject.QueryGetData (ref System.Runtime.InteropServices.ComTypes.FORMATETC format);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.Runtime.InteropServices.ComTypes.FORMATETC&amp;" RefType="ref" />
</Parameters>
<Docs>
<param name="format">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Runtime.InteropServices.ComTypes.IDataObject.SetData">
<MemberSignature Language="C#" Value="void IDataObject.SetData (ref System.Runtime.InteropServices.ComTypes.FORMATETC formatIn, ref System.Runtime.InteropServices.ComTypes.STGMEDIUM medium, bool release);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="formatIn" Type="System.Runtime.InteropServices.ComTypes.FORMATETC&amp;" RefType="ref" />
<Parameter Name="medium" Type="System.Runtime.InteropServices.ComTypes.STGMEDIUM&amp;" RefType="ref" />
<Parameter Name="release" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="formatIn">To be added.</param>
<param name="medium">To be added.</param>
<param name="release">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>