Clipboard.SetDataObject Método

Definição

Namespace:

System.Windows

Assembly:

PresentationCore.dll

Armazena um objeto de dados especificado na Área de Transferência do sistema.

Sobrecargas

SetDataObject(Object)	Insere um objeto de dados não persistentes especificado na área de transferência do sistema.
SetDataObject(Object, Boolean)	Coloca um objeto de dados especificado na área de transferência do sistema e aceita um parâmetro booliano que indica se o objeto de dados deve ser deixado na área de transferência quando o aplicativo é encerrado.

SetDataObject(Object)

Insere um objeto de dados não persistentes especificado na área de transferência do sistema.

public:
 static void SetDataObject(System::Object ^ data);

[System.Security.SecurityCritical]
public static void SetDataObject (object data);

public static void SetDataObject (object data);

[<System.Security.SecurityCritical>]
static member SetDataObject : obj -> unit

static member SetDataObject : obj -> unit

Public Shared Sub SetDataObject (data As Object)

Parâmetros

data

Object

Um objeto de dados (um objeto que implementa IDataObject) para colocar na área de transferência do sistema.

Atributos

SecurityCriticalAttribute

Exceções

ArgumentNullException

data é null.

ExternalException

Ocorreu um erro ao acessar a Área de Transferência. Os detalhes da exceção incluirão um HResult que identifica o erro específico, consulte ErrorCode.

Comentários

Por padrão, os dados colocados na Área de Transferência do sistema com SetDataObject eles são desmarcados automaticamente da Área de Transferência quando o aplicativo é encerrado.

Observação

O comportamento padrão de limpar a Área de Transferência na saída do aplicativo pode ser diferente de outras implementações, o que pode deixar os dados na Área de Transferência na saída do aplicativo em vez de desmarcar por padrão. Use a SetDataObject sobrecarga e especifique o copy parâmetro como true se você não quisesse que os dados sejam limpos da Área de Transferência na saída do aplicativo.

DataObject fornece uma implementação básica da IDataObject interface.

Confira também

• GetDataObject()

SetDataObject(Object, Boolean)

Coloca um objeto de dados especificado na área de transferência do sistema e aceita um parâmetro booliano que indica se o objeto de dados deve ser deixado na área de transferência quando o aplicativo é encerrado.

public:
 static void SetDataObject(System::Object ^ data, bool copy);

[System.Security.SecurityCritical]
public static void SetDataObject (object data, bool copy);

public static void SetDataObject (object data, bool copy);

[<System.Security.SecurityCritical>]
static member SetDataObject : obj * bool -> unit

static member SetDataObject : obj * bool -> unit

Public Shared Sub SetDataObject (data As Object, copy As Boolean)

Parâmetros

data

Object

Um objeto de dados (um objeto que implementa IDataObject) para colocar na área de transferência do sistema.

copy

Boolean

true para deixar os dados na Área de Transferência do sistema quando o aplicativo é encerrado, false para limpar os dados da Área de Transferência do sistema quando o aplicativo é encerrado.

Atributos

SecurityCriticalAttribute

Exceções

ArgumentNullException

data é null.

ExternalException

Ocorreu um erro ao acessar a Área de Transferência. Os detalhes da exceção incluirão um HResult que identifica o erro específico, consulte ErrorCode.

Exemplos

O exemplo a seguir demonstra o uso desse método.

               // For this example, the data to be placed on the clipboard is a simple
               // string.
               string textData = "I want to put this string on the clipboard.";
               // The example will enable auto-conversion of data for this data object.
               bool autoConvert = true;

               // Create a new data object, specifying the data format, data to encapsulate, and enabling
               // auto-conversion services.
               DataObject data = new DataObject(DataFormats.UnicodeText, (Object)textData, autoConvert);
               
               // If the data to be copied is supposed to be persisted after the application ends, 
               // then set the second parameter of SetDataObject to true.
               if(persistentData)
               {
                   // Place the persisted data on the clipboard.
                   Clipboard.SetDataObject(data, true);
               }
               else
               {
                   // Place the non-persisted data on the clipboard.
                   Clipboard.SetDataObject(data, false);
               }

               // If you keep a copy of the source data object, you can use the IsCurrent method to see if
               // the data object is still on the clipboard.
               bool isOriginalDataObject = Clipboard.IsCurrent(data);

' For this example, the data to be placed on the clipboard is a simple
' string.
Dim textData As String = "I want to put this string on the clipboard."
' The example will enable auto-conversion of data for this data object.
Dim autoConvert As Boolean = True

' Create a new data object, specifying the data format, data to encapsulate, and enabling
' auto-conversion services.
Dim data As New DataObject(DataFormats.UnicodeText, CType(textData, Object), autoConvert)

' If the data to be copied is supposed to be persisted after the application ends, 
' then set the second parameter of SetDataObject to true.
If persistentData Then
    ' Place the persisted data on the clipboard.
    Clipboard.SetDataObject(data, True)
Else
    ' Place the non-persisted data on the clipboard.
    Clipboard.SetDataObject(data, False)
End If

' If you keep a copy of the source data object, you can use the IsCurrent method to see if
' the data object is still on the clipboard.
Dim isOriginalDataObject As Boolean = Clipboard.IsCurrent(data)

Comentários

DataObject fornece uma implementação básica da IDataObject interface. IsCurrent determina o objeto de dados colocado anteriormente na área de transferência pela última SetDataObject chamada.

Confira também

• GetDataObject()