Så här lägger du till data i Urklipp

Klassen Clipboard innehåller metoder som interagerar med urklippsfunktionen för Windows-operativsystemet. Många program använder Urklipp som en tillfällig lagringsplats för data. Ordbehandlare använder till exempel Urklipp under åtgärderna klipp ut och klistra in. Urklipp överför också data från en applikation till en annan.

När du lägger till data i Urklipp anger du dataformatet så att andra program kan känna igen data om de kan använda det formatet. Lägg till data i Urklipp i flera olika format för att öka antalet andra program som potentiellt kan använda data.

Ett Urklippsformat är en sträng som identifierar formatet så att ett program som använder det formatet kan hämta associerade data. Klassen DataFormats innehåller fördefinierade formatnamn för din användning. Du kan också använda egna formatnamn eller använda ett objekts typ som format.

Anmärkning

Alla Windows-baserade program delar klippbordet. Innehållet kan därför ändras när du byter till ett annat program.

Klassen Clipboard kan endast användas i trådar som är inställda på sta-läge (single thread apartment). Om du vill använda den här klassen kontrollerar du att din Main-metod har markerats med attributet STAThreadAttribute.

Om du vill lägga till data i Urklipp i ett eller flera format använder du metoden SetDataObject. Skicka vilket som helst objekt till den här metoden. Om du vill lägga till data i flera format lägger du först till data i ett separat objekt som är utformat för att fungera med flera format. Lägg vanligtvis till dina data i en DataObject, men du kan använda vilken typ som helst som implementerar IDataObject gränssnittet.

Om du vill lägga till data i Urklipp i ett enda gemensamt format använder du den specifika metoden för formatet, till exempel SetText för text.

.NET

Viktigt!

Anpassade objekt måste vara serialiserbara för JSON för att de ska kunna placeras i Urklipp. Använd de nya typsäkra metoderna som SetDataAsJson automatiskt hanterar JSON-serialisering. Den äldre SetData() metoden fungerar inte längre med anpassade objekt som börjar med .NET 9 på grund av borttagningen av BinaryFormatter.

.NET Framework

Viktigt!

Ett objekt måste vara serialiserbart för att det ska kunna placeras i Urklipp. Om du vill göra en typ serialiserbar markerar du den med attributet SerializableAttribute. Om du skickar ett icke-serialiserbart objekt till en Urklippsmetod misslyckas metoden utan att utlösa ett undantag. Mer information om serialisering finns i System.Runtime.Serialization.

Lägga till data i ett enda format

Använd metoden SetAudio, SetFileDropList, SetImageeller SetText.

.NET

// Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
public Stream SwapClipboardAudio(Stream replacementAudioStream)
{
    Stream? returnAudioStream = null;

    if (Clipboard.ContainsAudio())
    {
        returnAudioStream = Clipboard.GetAudioStream();
        Clipboard.SetAudio(replacementAudioStream);
    }
    return returnAudioStream;
}

// Demonstrates SetFileDropList, ContainsFileDroList, and GetFileDropList
public StringCollection SwapClipboardFileDropList(StringCollection replacementList)
{
    StringCollection? returnList = null;

    if (Clipboard.ContainsFileDropList())
    {
        returnList = Clipboard.GetFileDropList();
        Clipboard.SetFileDropList(replacementList);
    }
    return returnList;
}

// Demonstrates SetImage, ContainsImage, and GetImage.
public Image SwapClipboardImage(Image replacementImage)
{
    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 Stream) As Stream

    Dim returnAudioStream As 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 StringCollection) As StringCollection

    Dim returnList As 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 Image) As Image

    Dim returnImage As 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

.NET Framework

// 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

Lägga till data i ett anpassat format

.NET

Clipboard.SetDataAsJson<T>(String, T) Använd metoden med ett anpassat formatnamn och ditt objekt.

Metoden SetDataAsJson<T>() serialiserar automatiskt dina anpassade objekt med hjälp av System.Text.Json. Det här är den rekommenderade metoden i .NET 10 och senare för lagring av anpassade typer i Urklipp, eftersom det ger typ- och säkerhetsfördelar jämfört med den äldre SetData() metoden.

Viktigt!

Den äldre SetData metoden fungerar inte längre med anpassade objekt i .NET 9 och senare på grund av borttagningen av BinaryFormatter. Använd SetDataAsJson<T>() i stället för anpassade typer.

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

        return null;
    }
}

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

        If Clipboard.ContainsData("CustomerFormat") Then
            Dim customerData As Customer = Nothing

            If Clipboard.TryGetData("CustomerFormat", customerData) Then
                Return customerData
            End If

        End If

        Return Nothing
    End Get
End Property

Klassen Customer som användes i föregående kodfragment:

// Customer class used in custom clipboard format examples.
public class Customer
{
    public string Name { get; set; }
    
    public Customer(string name)
    {
        Name = name;
    }
}

'Customer class used in custom clipboard format examples.
Public Class Customer

    Public Property Name As String

    Public Sub New(ByVal name As String)
        Me.Name = name
    End Sub

End Class

.NET Framework

Använd metoden SetData med ett anpassat formatnamn.

Du kan också använda fördefinierade formatnamn med metoden SetData. Mer information finns i 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

Klassen Customer som användes i föregående kodfragment:

[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

Lägga till data i flera format

Använd metoden Clipboard.SetDataObject och skicka in en DataObject som innehåller dina data.

.NET

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

    Customer customer = new("Customer #2112");
    ListViewItem listViewItem = new($"Customer as ListViewItem {customer.Name}");

    // Add a Customer object using the type as the format.
    data.SetDataAsJson(customer);

    // Add a ListViewItem object using a custom format name.
    data.SetDataAsJson("ListViewItemFormat", listViewItem.Text);

    Clipboard.SetDataObject(data);

    // Retrieve the data from the Clipboard.
    DataObject retrievedData = (DataObject)Clipboard.GetDataObject()!;

    if (retrievedData.GetDataPresent("ListViewItemFormat"))
    {
        if (retrievedData.TryGetData("ListViewItemFormat", out String item))
        {
            ListViewItem recreatedListViewItem = new(item);
            MessageBox.Show($"Data contains ListViewItem with text of {recreatedListViewItem.Text}");
        }
    }

    if (retrievedData.GetDataPresent(typeof(Customer)))
    {
        if (retrievedData.TryGetData(out Customer newCustomer))
        {
            MessageBox.Show($"Data contains Customer with name of {newCustomer.Name}");
        }
    }
}

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

    Dim data As New DataObject()

    Dim customer As New Customer("Customer #2112")
    Dim listViewItem As New ListViewItem($"Customer as ListViewItem {customer.Name}")

    ' Add a Customer object using the type as the format.
    data.SetDataAsJson(customer)

    ' Add a ListViewItem object using a custom format name.
    data.SetDataAsJson("ListViewItemFormat", listViewItem.Text)

    Clipboard.SetDataObject(data)

    ' Retrieve the data from the Clipboard.
    Dim retrievedData As DataObject = CType(Clipboard.GetDataObject(), DataObject)

    If retrievedData.GetDataPresent("ListViewItemFormat") Then
        Dim item As String = Nothing

        If retrievedData.TryGetData("ListViewItemFormat", item) Then
            Dim recreatedListViewItem As New ListViewItem(item)
            MessageBox.Show($"Data contains ListViewItem with text of {recreatedListViewItem.Text}")
        End If

    End If

    If retrievedData.GetDataPresent(GetType(Customer)) Then
        Dim newCustomer As Customer = Nothing

        If retrievedData.TryGetData(newCustomer) Then
            MessageBox.Show($"Data contains Customer with name of {newCustomer.Name}")
        End If

    End If

End Sub

Klassen Customer som användes i föregående kodfragment:

// Customer class used in custom clipboard format examples.
public class Customer
{
    public string Name { get; set; }
    
    public Customer(string name)
    {
        Name = name;
    }
}

'Customer class used in custom clipboard format examples.
Public Class Customer

    Public Property Name As String

    Public Sub New(ByVal name As String)
        Me.Name = name
    End Sub

End Class

.NET Framework

// 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

Klassen Customer som användes i föregående kodfragment:

[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

Se även

• Dra-och-släpp-funktioner och stöd för urklipp
• Hämta data från Urklipp
• Windows Forms urklipp och ändringar i DataObject i .NET 10