Clipboard.SetData(String, Object) Método

  • Referencia

Definición

Espacio de nombres:
System.Windows.Forms
Ensamblado:
System.Windows.Forms.dll

Borra el Portapapeles y, a continuación, agrega los datos en el formato especificado.

public:
 static void SetData(System::String ^ format, System::Object ^ data);
public static void SetData (string format, object data);
static member SetData : string * obj -> unit
Public Shared Sub SetData (format As String, data As Object)

Parámetros

format
String

Formato de los datos que se va a establecer. Vea DataFormats para obtener los formatos predefinidos.

data
Object

Object que representa los datos que se van a agregar.

Excepciones

ExternalException

No se ha podido vaciar el Portapapeles. Esto ocurre normalmente cuando otro proceso utiliza el Portapapeles.

ThreadStateException

El subproceso actual no está en el modo de contenedor uniproceso (STA). Agregue STAThreadAttribute al método Main de la aplicación.

ArgumentNullException

data es null.

Ejemplos

En el ejemplo siguiente se muestra este miembro.

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

Comentarios

Si no conoce el formato de la aplicación de destino, puede almacenar datos en varios formatos mediante este método.

Los datos almacenados mediante este método se pueden convertir a un formato compatible cuando se recupera.

Para recuperar datos del Portapapeles en un formato determinado, use primero el ContainsData método para determinar si el Portapapeles contiene datos en ese formato antes de recuperarlos con el GetData método .

Nota:

La clase Clipboard solo se puede usar en subprocesos establecidos en modo de subprocesamiento controlado simple (STA). Para usar esta clase, asegúrese de que el método Main está marcado con el atributo STAThreadAttribute.

Se aplica a

Consulte también