Clipboard.GetData(String) Método

Definição

Espaço de Nomes:
System.Windows.Forms
Assemblagem:
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 recuperar. Veja DataFormats para formatos pré-definidos.

Devoluções

Object

Um representando Object os dados da Área de Transferência ou null se a Área de Transferência não contiver quaisquer dados que estejam no formato especificado format ou que possam ser convertidos para esse formato.

Exceções

ExternalException

A prancheta não pôde ser limpa. Isto ocorre tipicamente quando a Prancheta está a ser usada por outro processo.

ThreadStateException

O tópico atual não está em modo apartamento single-threaded (STA). Adicione-os STAThreadAttribute ao processo da Main sua candidatura.

Exemplos

O exemplo seguinte demonstra este elemento.

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

Observações

Use o ContainsData método para determinar se a Área de Transferência contém dados no formato especificado ou num formato compatível antes de os recuperar com este método.

Se este método não conseguir encontrar dados no formato especificado, tenta converter os dados para o formato. Se os dados não puderem ser convertidos para o formato especificado, ou se os dados foram armazenados com conversão automática definida para false, este método devolve null.

Note

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

A classe Clipboard só pode ser usada em threads configurados para o modo apartamento de thread único (modo STA). 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 num formato específico.

Aplica-se a

Ver também