Clipboard.GetData(String) Método

Definição

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

Recupera dados da Área de Transferência no formato especificado.

public:
 static System::Object ^ GetData(System::String ^ format);
public static object GetData(string format);
static member GetData : string -> obj
Public Shared Function GetData (format As String) As Object

Parâmetros

format
String

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

Retornos

Object

Uma Object representação dos dados da Área de Transferência ou null se a Área de Transferência não contiver dados especificados format ou que possam ser convertidos nesse formato.

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.

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

Use o ContainsData método para determinar se a Área de Transferência contém dados no formato especificado ou um formato compatível antes de recuperá-lo com esse método.

Se esse método não conseguir encontrar dados no formato especificado, ele tentará converter os dados no formato. Se os dados não puderem ser convertidos no formato especificado ou se os dados tiverem sido armazenados com conversão automática definida como false, esse método retornará null.

Note

Os dados poderão ser convertidos em outro formato se forem armazenados especificando se a conversão é permitida e se o formato solicitado for compatível com o formato armazenado. Por exemplo, os dados armazenados como Unicode podem ser convertidos em texto.

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.

Use o SetData método para adicionar dados à Área de Transferência em um formato específico.

Aplica-se a

Confira também