Clipboard.SetData(String, Object) Método

Definição

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Limpa a Área de Transferência e adiciona dados no formato especificado.

public:
 static void SetData(System::String ^ format, System::Object ^ data);
public static void SetData(string format, object data);
static member SetData : string * obj -> unit
Public Shared Sub SetData (format As String, data As Object)

Parâmetros

format
String

O formato dos dados a serem definidos. Consulte DataFormats os formatos predefinidos.

data
Object

Um Object que representa os dados a serem adicionados.

Exceções

ExternalException

Não foi possível limpar a área de transferência. Isso normalmente ocorre quando a Área de Transferência está sendo usada por outro processo.

ThreadStateException

O thread atual não está no modo STA (apartamento de thread único). Adicione o STAThreadAttribute método do Main aplicativo.

ArgumentNullException

data é null.

Exemplos

O exemplo a seguir demonstra esse membro.

// Demonstrates SetData, ContainsData, and GetData.
public Object SwapClipboardFormattedData(String format, Object data)
{
    Object returnObject = null;
    if (Clipboard.ContainsData(format))
    {
        returnObject = Clipboard.GetData(format);
        Clipboard.SetData(format, data);
    }
    return returnObject;
}

' Demonstrates SetData, ContainsData, and GetData.
Public Function SwapClipboardFormattedData( _
    ByVal format As String, ByVal data As Object) As Object

    Dim returnObject As Object = Nothing

    If (Clipboard.ContainsData(format)) Then
        returnObject = Clipboard.GetData(format)
        Clipboard.SetData(format, data)
    End If

    Return returnObject

End Function

Comentários

Se você não souber o formato do aplicativo de destino, poderá armazenar dados em vários formatos usando esse método.

Os dados armazenados usando esse método podem ser convertidos em um formato compatível quando recuperados.

Para recuperar dados da Área de Transferência em um formato específico, primeiro use o ContainsData método para determinar se a Área de Transferência contém dados nesse formato antes de recuperá-los com o GetData método.

Note

A classe Clipboard só pode ser usada em threads configurados no modo STA (Single Thread Apartment). Para usar essa classe, verifique se o método Main está marcado com o atributo STAThreadAttribute.

Aplica-se a

Confira também