Clipboard.SetText Método

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

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

Sobrecargas

Nombre	Description
SetText(String)	Borra el Portapapeles y, a continuación, agrega datos de texto en el Text formato o UnicodeText , en función del sistema operativo.
SetText(String, TextDataFormat)	Borra el Portapapeles y, a continuación, agrega datos de texto en el formato indicado por el valor especificado TextDataFormat .

SetText(String)

Borra el Portapapeles y, a continuación, agrega datos de texto en el Text formato 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 pudo borrar el Portapapeles. Esto suele ocurrir cuando otro proceso usa el Portapapeles.

ThreadStateException

El subproceso actual no está en modo de apartamento de un solo subproceso (STA). Agregue al STAThreadAttribute método de la Main 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 en el formato UnicodeText en Windows XP Home Edition, Windows XP Professional, Windows Server 2003 y Windows 2000. De lo contrario, este método agrega datos de texto en 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 .

Note

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

Consulte también

• TextDataFormat
• ContainsText
• GetText

SetText(String, TextDataFormat)

Borra el Portapapeles y, a continuación, agrega datos de texto en el formato indicado por el valor especificado TextDataFormat .

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 TextDataFormat valores.

Excepciones

ExternalException

No se pudo borrar el Portapapeles. Esto suele ocurrir cuando otro proceso usa el Portapapeles.

ThreadStateException

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

ArgumentNullException

text es null o Empty.

InvalidEnumArgumentException

format no es un valor válido TextDataFormat .

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 .

Note

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

Consulte también

• TextDataFormat
• ContainsText
• GetText