Практическое руководство. Извлечение данных из буфера обмена

Статья
06/02/2023

Класс Clipboard предоставляет методы, которые можно использовать для взаимодействия с функцией буфера обмена операционной системы Windows. Многие приложения используют буфер обмена в качестве временного хранилища данных. Например, текстовые процессоры используют буфер обмена во время операций вырезания и вставки. Буфер обмена также удобен для передачи сведений из одного приложения в другое.

Некоторые приложения хранят данные в буфере обмена в нескольких форматах, чтобы увеличить количество принимающих приложений, которые могут использовать данные. Формат буфера обмена — это строка, идентифицирующая формат. Приложение, использующее указанный формат, может получать связанные данные из буфера обмена. Класс DataFormats предоставляет для использования предопределенные имена форматов. Вы также можете использовать собственные имена форматов или задать тип объекта в качестве формата. Сведения о добавлении данных в буфер обмена см. в статье Практическое руководство. Добавление данных в буфер обмена.

Чтобы определить, содержит ли буфер обмена данные в определенном формате, используйте один из методов ContainsФормат или метод GetData. Чтобы получить данные из буфера обмена, используйте один из методов GetФормат или метод GetData. Эти методы являются новыми в .NET Framework 2.0.

Для доступа к данным в буфере обмена при использовании версий до .NET Framework 2.0 используйте метод Clipboard.GetDataObject и вызовите методы возвращенного объекта IDataObject. Чтобы определить, доступен ли определенный формат в возвращенном объекте, вызовите, например, метод GetDataPresent.

Примечание.

Все приложения на основе Windows совместно используют системный буфер обмена. Поэтому содержимое может измениться при переключении на другое приложение.

Класс Clipboard можно использовать только в потоках в режиме контейнера с одним потоком (STA). Чтобы использовать этот класс, убедитесь, что метод Main отмечен атрибутом STAThreadAttribute.

Получение данных из буфера обмена в одном общем формате

Используйте методы GetAudioStream, GetFileDropList, GetImage или GetText. При необходимости сначала используйте соответствующие методы ContainsФормат, чтобы определить, доступны ли данные в определенном формате. Эти методы доступны только на платформе .NET Framework версии 2.0.

// Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
public System.IO.Stream SwapClipboardAudio(
    System.IO.Stream replacementAudioStream)
{
    System.IO.Stream returnAudioStream = null;
    if (Clipboard.ContainsAudio())
    {
        returnAudioStream = Clipboard.GetAudioStream();
        Clipboard.SetAudio(replacementAudioStream);
    }
    return returnAudioStream;
}

// Demonstrates SetFileDropList, ContainsFileDroList, and GetFileDropList
public System.Collections.Specialized.StringCollection
    SwapClipboardFileDropList(
    System.Collections.Specialized.StringCollection replacementList)
{
    System.Collections.Specialized.StringCollection returnList = null;
    if (Clipboard.ContainsFileDropList())
    {
        returnList = Clipboard.GetFileDropList();
        Clipboard.SetFileDropList(replacementList);
    }
    return returnList;
}

// Demonstrates SetImage, ContainsImage, and GetImage.
public System.Drawing.Image SwapClipboardImage(
    System.Drawing.Image replacementImage)
{
    System.Drawing.Image returnImage = null;
    if (Clipboard.ContainsImage())
    {
        returnImage = Clipboard.GetImage();
        Clipboard.SetImage(replacementImage);
    }
    return returnImage;
}

// Demonstrates SetText, ContainsText, and GetText.
public String SwapClipboardHtmlText(String replacementHtmlText)
{
    String returnHtmlText = null;
    if (Clipboard.ContainsText(TextDataFormat.Html))
    {
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html);
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html);
    }
    return returnHtmlText;
}

' Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
Public Function SwapClipboardAudio( _
    ByVal replacementAudioStream As System.IO.Stream) _
    As System.IO.Stream

    Dim returnAudioStream As System.IO.Stream = Nothing

    If (Clipboard.ContainsAudio()) Then
        returnAudioStream = Clipboard.GetAudioStream()
        Clipboard.SetAudio(replacementAudioStream)
    End If

    Return returnAudioStream

End Function

' Demonstrates SetFileDropList, ContainsFileDroList, and GetFileDropList
Public Function SwapClipboardFileDropList(ByVal replacementList _
    As System.Collections.Specialized.StringCollection) _
    As System.Collections.Specialized.StringCollection

    Dim returnList As System.Collections.Specialized.StringCollection _
        = Nothing

    If Clipboard.ContainsFileDropList() Then

        returnList = Clipboard.GetFileDropList()
        Clipboard.SetFileDropList(replacementList)
    End If

    Return returnList

End Function

' Demonstrates SetImage, ContainsImage, and GetImage.
Public Function SwapClipboardImage( _
    ByVal replacementImage As System.Drawing.Image) _
    As System.Drawing.Image

    Dim returnImage As System.Drawing.Image = Nothing

    If Clipboard.ContainsImage() Then
        returnImage = Clipboard.GetImage()
        Clipboard.SetImage(replacementImage)
    End If

    Return returnImage
End Function

' Demonstrates SetText, ContainsText, and GetText.
Public Function SwapClipboardHtmlText( _
    ByVal replacementHtmlText As String) As String

    Dim returnHtmlText As String = Nothing

    If (Clipboard.ContainsText(TextDataFormat.Html)) Then
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html)
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html)
    End If

    Return returnHtmlText

End Function

Получение данных из буфера обмена в пользовательском формате

Используйте метод GetData, самостоятельно задав формат. Этот метод доступен только на платформе .NET Framework версии 2.0.

Имена стандартных форматов также можно использовать с методом SetData. Дополнительные сведения см. в разделе DataFormats.

// Demonstrates SetData, ContainsData, and GetData
// using a custom format name and a business object.
public Customer TestCustomFormat
{
    get
    {
        Clipboard.SetData("CustomerFormat", new Customer("Customer Name"));
        if (Clipboard.ContainsData("CustomerFormat"))
        {
            return Clipboard.GetData("CustomerFormat") as Customer;
        }
        return null;
    }
}

' Demonstrates SetData, ContainsData, and GetData
' using a custom format name and a business object.
Public ReadOnly Property TestCustomFormat() As Customer
    Get
        Clipboard.SetData("CustomerFormat", New Customer("Customer Name"))

        If Clipboard.ContainsData("CustomerFormat") Then
            Return CType(Clipboard.GetData("CustomerFormat"), Customer)
        End If

        Return Nothing
    End Get
End Property

[Serializable]
public class Customer
{
    private string nameValue = string.Empty;
    public Customer(String name)
    {
        nameValue = name;
    }
    public string Name
    {
        get { return nameValue; }
        set { nameValue = value; }
    }
}

<Serializable()> Public Class Customer

    Private nameValue As String = String.Empty

    Public Sub New(ByVal name As String)
        nameValue = name
    End Sub

    Public Property Name() As String
        Get
            Return nameValue
        End Get
        Set(ByVal value As String)
            nameValue = value
        End Set
    End Property

End Class

Получение данных из буфера обмена в нескольких форматах

Используйте метод GetDataObject. Этот метод необходимо использовать для получения данных из буфера обмена на платформе .NET Framework более ранней версии, чем версия 2.0.

// Demonstrates how to use a DataObject to add
// data to the Clipboard in multiple formats.
public void TestClipboardMultipleFormats()
{
    DataObject data = new DataObject();

    // Add a Customer object using the type as the format.
    data.SetData(new Customer("Customer as Customer object"));

    // Add a ListViewItem object using a custom format name.
    data.SetData("CustomFormat",
        new ListViewItem("Customer as ListViewItem"));

    Clipboard.SetDataObject(data);
    DataObject retrievedData = (DataObject)Clipboard.GetDataObject();

    if (retrievedData.GetDataPresent("CustomFormat"))
    {
        ListViewItem item =
            retrievedData.GetData("CustomFormat") as ListViewItem;
        if (item != null)
        {
            MessageBox.Show(item.Text);
        }
    }

    if (retrievedData.GetDataPresent(typeof(Customer)))
    {
        Customer customer =
            retrievedData.GetData(typeof(Customer)) as Customer;
        if (customer != null)
        {
            MessageBox.Show(customer.Name);
        }
    }
}

' Demonstrates how to use a DataObject to add
' data to the Clipboard in multiple formats.
Public Sub TestClipboardMultipleFormats()

    Dim data As New DataObject()

    ' Add a Customer object using the type as the format.
    data.SetData(New Customer("Customer as Customer object"))

    ' Add a ListViewItem object using a custom format name.
    data.SetData("CustomFormat", _
        New ListViewItem("Customer as ListViewItem"))

    Clipboard.SetDataObject(data)
    Dim retrievedData As DataObject = _
        CType(Clipboard.GetDataObject(), DataObject)

    If (retrievedData.GetDataPresent("CustomFormat")) Then

        Dim item As ListViewItem = _
            TryCast(retrievedData.GetData("CustomFormat"), ListViewItem)

        If item IsNot Nothing Then
            MessageBox.Show(item.Text)
        End If

    End If

    If retrievedData.GetDataPresent(GetType(Customer)) Then

        Dim customer As Customer = _
            CType(retrievedData.GetData(GetType(Customer)), Customer)

        If customer IsNot Nothing Then

            MessageBox.Show(customer.Name)
        End If

    End If

End Sub

[Serializable]
public class Customer
{
    private string nameValue = string.Empty;
    public Customer(String name)
    {
        nameValue = name;
    }
    public string Name
    {
        get { return nameValue; }
        set { nameValue = value; }
    }
}

<Serializable()> Public Class Customer

    Private nameValue As String = String.Empty

    Public Sub New(ByVal name As String)
        nameValue = name
    End Sub

    Public Property Name() As String
        Get
            Return nameValue
        End Get
        Set(ByVal value As String)
            nameValue = value
        End Set
    End Property

End Class

Практическое руководство. Извлечение данных из буфера обмена

Получение данных из буфера обмена в одном общем формате

Получение данных из буфера обмена в пользовательском формате

Получение данных из буфера обмена в нескольких форматах

См. также

Обратная связь

Дополнительные ресурсы