Share via

Clipboard.GetData(String) Método

  • Referencia

Definición

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

Recupera datos del Portapapeles con el formato especificado.

public:
 static System::Object ^ GetData(System::String ^ format);
public static object GetData (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

Formato de los datos que se van a recuperar. Vea DataFormats para obtener los formatos predefinidos.

Devoluciones

Object

Object que representa los datos del Portapapeles o null si el Portapapeles no contiene ningún dato cuyo formato sea el del parámetro format especificado o que se pueda convertir a ese formato.

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.

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

Use el ContainsData método para determinar si el Portapapeles contiene datos en el formato especificado o un formato compatible antes de recuperarlo con este método.

Si este método no encuentra datos en el formato especificado, intenta convertir los datos al formato . Si los datos no se pueden convertir al formato especificado o si los datos se almacenaron con la conversión automática establecida falseen , este método devuelve null.

Nota

Los datos se pueden convertir a otro formato si se almacenó especificando esa conversión y si el formato solicitado es compatible con el formato almacenado. Por ejemplo, los datos almacenados como Unicode se pueden convertir en texto.

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

Use el SetData método para agregar datos al Portapapeles en un formato determinado.

Se aplica a

Consulte también