Clipboard.SetText Método

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Borra el Portapapeles y, a continuación, le agrega datos de texto.

Sobrecargas

SetText(String)	Borra el Portapapeles y le agrega datos de texto con el formato Text o UnicodeText, en función del sistema operativo.
SetText(String, TextDataFormat)	Borra el Portapapeles y agrega datos de texto con el formato que indica el valor de TextDataFormat especificado.

SetText(String)

Borra el Portapapeles y le agrega datos de texto con el formato Text o UnicodeText, en función del sistema operativo.

public:
 static void SetText(System::String ^ text);

public static void SetText (string text);

static member SetText : string -> unit

Public Shared Sub SetText (text As String)

Parámetros

text

String

Texto que se va a agregar al Portapapeles.

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

text es null o Empty.

Ejemplos

En el ejemplo siguiente se muestra una sobrecarga del SetText método similar a esta sobrecarga.

// Demonstrates SetText, ContainsText, and GetText.
public String SwapClipboardHtmlText(String replacementHtmlText)
{
    String returnHtmlText = null;
    if (Clipboard.ContainsText(TextDataFormat.Html))
    {
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html);
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html);
    }
    return returnHtmlText;
}

' Demonstrates SetText, ContainsText, and GetText.
Public Function SwapClipboardHtmlText( _
    ByVal replacementHtmlText As String) As String

    Dim returnHtmlText As String = Nothing

    If (Clipboard.ContainsText(TextDataFormat.Html)) Then
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html)
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html)
    End If

    Return returnHtmlText

End Function

Comentarios

Este método agrega datos de texto con el UnicodeText formato en Windows XP Home Edition, Windows XP Professional, Windows Server 2003 y Windows 2000. De lo contrario, este método agrega datos de texto con el Text formato .

Para recuperar datos de texto del Portapapeles, use primero el ContainsText método para determinar si el Portapapeles contiene datos de texto antes de recuperarlos con el GetText 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.

Consulte también

• TextDataFormat
• ContainsText
• GetText

SetText(String, TextDataFormat)

Borra el Portapapeles y agrega datos de texto con el formato que indica el valor de TextDataFormat especificado.

public:
 static void SetText(System::String ^ text, System::Windows::Forms::TextDataFormat format);

public static void SetText (string text, System.Windows.Forms.TextDataFormat format);

static member SetText : string * System.Windows.Forms.TextDataFormat -> unit

Public Shared Sub SetText (text As String, format As TextDataFormat)

Parámetros

text

String

Texto que se va a agregar al Portapapeles.

format

TextDataFormat

Uno de los valores de TextDataFormat.

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

text es null o Empty.

InvalidEnumArgumentException

format no es un valor TextDataFormat válido.

Ejemplos

En el ejemplo siguiente se muestra este miembro.

// Demonstrates SetText, ContainsText, and GetText.
public String SwapClipboardHtmlText(String replacementHtmlText)
{
    String returnHtmlText = null;
    if (Clipboard.ContainsText(TextDataFormat.Html))
    {
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html);
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html);
    }
    return returnHtmlText;
}

' Demonstrates SetText, ContainsText, and GetText.
Public Function SwapClipboardHtmlText( _
    ByVal replacementHtmlText As String) As String

    Dim returnHtmlText As String = Nothing

    If (Clipboard.ContainsText(TextDataFormat.Html)) Then
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html)
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html)
    End If

    Return returnHtmlText

End Function

Comentarios

Para recuperar datos de texto del Portapapeles, use primero el ContainsText método para determinar si el Portapapeles contiene datos de texto antes de recuperarlos con el GetText 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.

Consulte también

• TextDataFormat
• ContainsText
• GetText