Clipboard Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Fornece métodos para colocar dados e recuperar dados do sistema Clipboard. Esta classe não pode ser herdada.
public ref class Clipboard sealed
public sealed class Clipboard
type Clipboard = class
Public NotInheritable Class Clipboard
- Herança
-
Clipboard
Exemplos
O exemplo de código seguinte utiliza Clipboard métodos para colocar dados e recuperá-los da Área de Transferência do sistema. Este código assume button1, button2, textBox1, e textBox2 foram criados e colocados no formulário.
O button1_Click método chama SetDataObject para pegar no texto selecionado da caixa de texto e colocá-lo na Prancheta do sistema.
O button2_Click método chama GetDataObject para recuperar dados do Clipboard do sistema. O código usa IDataObject e DataFormats para extrair os dados retornados e apresenta os dados em textBox2.
private:
void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
// Takes the selected text from a text box and puts it on the clipboard.
if ( !textBox1->SelectedText->Equals( "" ) )
{
Clipboard::SetDataObject( textBox1->SelectedText );
}
else
{
textBox2->Text = "No text selected in textBox1";
}
}
void button2_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
// Declares an IDataObject to hold the data returned from the clipboard.
// Retrieves the data from the clipboard.
IDataObject^ iData = Clipboard::GetDataObject();
// Determines whether the data is in a format you can use.
if ( iData->GetDataPresent( DataFormats::Text ) )
{
// Yes it is, so display it in a text box.
textBox2->Text = (String^)(iData->GetData( DataFormats::Text ));
}
else
{
// No it is not.
textBox2->Text = "Could not retrieve data off the clipboard.";
}
}
private void button1_Click(object sender, System.EventArgs e) {
// Takes the selected text from a text box and puts it on the clipboard.
if(textBox1.SelectedText != "")
Clipboard.SetDataObject(textBox1.SelectedText);
else
textBox2.Text = "No text selected in textBox1";
}
private void button2_Click(object sender, System.EventArgs e) {
// Declares an IDataObject to hold the data returned from the clipboard.
// Retrieves the data from the clipboard.
IDataObject iData = Clipboard.GetDataObject();
// Determines whether the data is in a format you can use.
if(iData.GetDataPresent(DataFormats.Text)) {
// Yes it is, so display it in a text box.
textBox2.Text = (String)iData.GetData(DataFormats.Text);
}
else {
// No it is not.
textBox2.Text = "Could not retrieve data off the clipboard.";
}
}
Private Sub button1_Click(sender As Object, e As System.EventArgs)
' Takes the selected text from a text box and puts it on the clipboard.
If textBox1.SelectedText <> "" Then
Clipboard.SetDataObject(textBox1.SelectedText)
Else
textBox2.Text = "No text selected in textBox1"
End If
End Sub
Private Sub button2_Click(sender As Object, e As System.EventArgs)
' Declares an IDataObject to hold the data returned from the clipboard.
' Retrieves the data from the clipboard.
Dim iData As IDataObject = Clipboard.GetDataObject()
' Determines whether the data is in a format you can use.
If iData.GetDataPresent(DataFormats.Text) Then
' Yes it is, so display it in a text box.
textBox2.Text = CType(iData.GetData(DataFormats.Text), String)
Else
' No it is not.
textBox2.Text = "Could not retrieve data off the clipboard."
End If
End Sub
Observações
Para uma lista de formatos pré-definidos a usar com a Clipboard classe, veja a DataFormats classe.
Pedido SetDataObject para colocar dados na Prancheta, substituindo o seu conteúdo atual. Para colocar uma cópia persistente dos dados na Prancheta, defina o copy parâmetro para true.
Note
Para colocar dados na Área de Transferência em vários formatos, use a DataObject classe ou uma IDataObject implementação. Coloque os dados na Área de Transferência em múltiplos formatos para maximizar a possibilidade de uma aplicação-alvo, cujos requisitos de formato pode não conhecer, conseguir recuperar os dados com sucesso.
Chamar GetDataObject para recuperar dados da Prancheta. Os dados são devolvidos como um objeto que implementa a IDataObject interface. Use os métodos especificados por IDataObject campos e para DataFormats extrair os dados do objeto. Se não souber o formato dos dados que recuperou, chame o GetFormats método da IDataObject interface para obter uma lista de todos os formatos em que os dados estão armazenados. Depois chama o GetData método da IDataObject interface e especifica um formato que a tua aplicação possa usar.
A Clipboard classe fornece métodos adicionais que facilitam o trabalho com o sistema Clipboard. Chama o Clear método para remover todos os dados da Área de Transferência. Para adicionar dados de um determinado formato ao Clipboard, substituindo os dados existentes, chame o método Format apropriadoSet, como SetText, ou chame o SetData método para especificar o formato. Para recuperar dados de um determinado formato da Área de Transferências, primeiro chame o método Formato apropriado Contains (como ContainsText) para determinar se a Área de Transferência contém dados nesse formato, e depois chame o método Formato apropriado Get (como GetText) para recuperar os dados se a Área de Transferência os conter. Para especificar o formato nestas operações, chame os ContainsData métodos e GetData em vez disso.
Note
Todas as aplicações baseadas em Windows partilham a Área de Transferência do sistema, pelo que o conteúdo está sujeito a alterações quando muda para outra aplicação.
Um objeto deve ser serializável para ser colocado na área de transferência. Se passar um objeto não serializável para um método Clipboard, o método falhará sem lançar uma exceção. Consulte System.Runtime.Serialization para mais informações sobre serialização. Se a sua aplicação de destino exigir um formato de dados muito específico, os cabeçalhos adicionados aos dados no processo de serialização podem impedir que a aplicação reconheça os seus dados. Para preservar o formato dos seus dados, adicione os seus dados como um Byte array para um MemoryStream e passe para MemoryStream o SetData método.
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.
Podem ser necessárias considerações especiais ao usar o formato de metaficheiro com a Área de Transferências. Devido a uma limitação na implementação atual da classe DataObject, o formato de metaficheiro usado pelo .NET Framework pode não ser reconhecido por aplicações que utilizam um formato de metaficheiro mais antigo. Neste caso, deve interoperar com as interfaces de programação de aplicações (APIs) do Win32 Clipboard.
Métodos
| Name | Description |
|---|---|
| Clear() |
Remove todos os dados da Área de Transferência. |
| ContainsAudio() |
Indica se há dados na Área de Transferência no WaveAudio formato. |
| ContainsData(String) |
Indica se existem dados na Área de Transferência que estão no formato especificado ou se podem ser convertidos para esse formato. |
| ContainsFileDropList() |
Indica se há dados na Área de Transferência que estão nesse FileDrop formato ou se podem ser convertidos para esse formato. |
| ContainsImage() |
Indica se há dados na Área de Transferência que estão nesse Bitmap formato ou se podem ser convertidos para esse formato. |
| ContainsText() |
Indica se há dados na Área de Transferência no Text formato ou, UnicodeText dependendo do sistema operativo. |
| ContainsText(TextDataFormat) |
Indica se há dados de texto na Área de Transferência no formato indicado pelo valor especificado TextDataFormat . |
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| GetAudioStream() |
Recupera um fluxo de áudio da Área de Transferência. |
| GetData(String) |
Recupera dados da Área de Transferência no formato especificado. |
| GetDataObject() |
Recupera os dados que estão atualmente na Prancheta do sistema. |
| GetFileDropList() |
Recupera uma coleção de nomes de ficheiros do Clipboard. |
| GetHashCode() |
Serve como função de hash predefinida. (Herdado de Object) |
| GetImage() |
Recupera uma imagem da Prancheta. |
| GetText() |
Recupera dados de texto do Clipboard no Text formato ou, UnicodeText dependendo do sistema operativo. |
| GetText(TextDataFormat) |
Recupera dados de texto do Clipboard no formato indicado pelo valor especificado TextDataFormat . |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| SetAudio(Byte[]) |
Limpa a Área de Transferência e depois adiciona um Byte array no WaveAudio formato depois de o converter para um Stream. |
| SetAudio(Stream) |
Limpa a prancheta e depois adiciona um Stream no WaveAudio formato. |
| SetData(String, Object) |
Limpa a Área de Transferência e depois adiciona dados no formato especificado. |
| SetDataObject(Object, Boolean, Int32, Int32) |
Limpa a Área de Transferência e depois tenta colocar os dados nela no número especificado de vezes e com o atraso especificado entre tentativas, deixando opcionalmente os dados na Área de Transferência após a conclusão da aplicação. |
| SetDataObject(Object, Boolean) |
Limpa a Área de Transferência e depois coloca os dados nela e especifica se os dados devem permanecer após a conclusão da aplicação. |
| SetDataObject(Object) |
Limpa a Área de Transferência e depois coloca nela dados não persistentes. |
| SetFileDropList(StringCollection) |
Limpa a prancheta e depois adiciona uma coleção de nomes de ficheiros no FileDrop formato. |
| SetImage(Image) |
Limpa a prancheta e depois adiciona um Image no Bitmap formato. |
| SetText(String, TextDataFormat) |
Limpa a Área de Transferência e depois adiciona dados de texto no formato indicado pelo valor especificado TextDataFormat . |
| SetText(String) |
Limpa a área de transferência e depois adiciona dados de texto no Text formato ou, UnicodeText dependendo do sistema operativo. |
| ToString() |
Devolve uma cadeia que representa o objeto atual. (Herdado de Object) |