Clipboard.SetDataObject Método

Definición

Espacio de nombres:

System.Windows

Ensamblado:

PresentationCore.dll

Almacena un objeto de datos especificado en el Portapapeles del sistema.

Sobrecargas

SetDataObject(Object)	Coloca un objeto de datos no persistente especificado en el Portapapeles del sistema.
SetDataObject(Object, Boolean)	Coloca un objeto de datos especificado en el Portapapeles del sistema y acepta un parámetro de tipo booleano que indica si el objeto de datos se debe quedar en el Portapapeles al salir de la aplicación.

SetDataObject(Object)

Coloca un objeto de datos no persistente especificado en el Portapapeles del sistema.

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

public static void SetDataObject (object data);

static member SetDataObject : obj -> unit

Public Shared Sub SetDataObject (data As Object)

Parámetros

data

Object

Objeto de datos (objeto que implementa IDataObject) que se va a colocar en el Portapapeles del sistema.

Excepciones

ArgumentNullException

data es null.

ExternalException

Error al obtener acceso al Portapapeles. Los detalles de la excepción incluirán un HResult que identifique el error concreto; vea ErrorCode.

Comentarios

De forma predeterminada, los datos colocados en el Portapapeles del sistema con SetDataObject se borran automáticamente del Portapapeles cuando se cierra la aplicación.

Nota:

El comportamiento predeterminado de borrar el Portapapeles en la salida de la aplicación podría diferir de otras implementaciones, lo que podría dejar los datos en el Portapapeles en la salida de la aplicación en lugar de borrarlo de forma predeterminada. Use la SetDataObject sobrecarga y especifique el copy parámetro como true si no desea borrar los datos del Portapapeles en la salida de la aplicación.

DataObject proporciona una implementación básica de la IDataObject interfaz.

Consulte también

• GetDataObject()

SetDataObject(Object, Boolean)

Coloca un objeto de datos especificado en el Portapapeles del sistema y acepta un parámetro de tipo booleano que indica si el objeto de datos se debe quedar en el Portapapeles al salir de la aplicación.

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

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

static member SetDataObject : obj * bool -> unit

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

Parámetros

data

Object

Objeto de datos (objeto que implementa IDataObject) que se va a colocar en el Portapapeles del sistema.

copy

Boolean

Es true para dejar los datos en el Portapapeles del sistema al salir de la aplicación; es false para borrarlos al salir de la aplicación.

Excepciones

ArgumentNullException

data es null.

ExternalException

Error al obtener acceso al Portapapeles. Los detalles de la excepción incluirán un HResult que identifique el error concreto; vea ErrorCode.

Ejemplos

En el ejemplo siguiente se muestra el uso de este 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)

Comentarios

DataObject proporciona una implementación básica de la IDataObject interfaz. IsCurrent determina el objeto de datos colocado anteriormente en el Portapapeles por la última SetDataObject llamada.

Consulte también

• GetDataObject()