Clipboard.SetText Метод

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Очищает буфер обмена и добавляет в него текстовые данные.

Перегрузки

SetText(String)	Очищает буфер обмена и добавляет и добавляет текстовые данныев формате Text или UnicodeText в зависимости от операционной системы.
SetText(String, TextDataFormat)	Очищает буфер обмена и добавляет текстовые данные в формате, указанном заданным значением TextDataFormat.

SetText(String)

Очищает буфер обмена и добавляет и добавляет текстовые данныев формате Text или UnicodeText в зависимости от операционной системы.

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)

Параметры

text

String

Текст, добавляемый в буфер обмена.

Исключения

ExternalException

Не удалось очистить буфер обмена. Обычно это происходит, когда буфер обмена используется другим процессом.

ThreadStateException

Текущий поток не выполняется в режиме апартмента с одним потоком (STA). Добавьте STAThreadAttribute в метод Main своего приложения.

ArgumentNullException

text имеет значение null или Empty.

Примеры

В следующем примере показана перегрузка SetText метода , похожая на эту перегрузку.

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

Комментарии

Этот метод добавляет текстовые UnicodeText данные в формате в Windows XP Home Edition, Windows XP Professional, Windows Server 2003 и Windows 2000. В противном случае этот метод добавляет текстовые данные в Text формате .

Чтобы получить текстовые данные из буфера обмена, сначала используйте ContainsText метод , чтобы определить, содержит ли буфер обмена текстовые данные, прежде чем получать их с GetText помощью метода .

Примечание

Класс Clipboard можно использовать только в потоках в режиме контейнера с одним потоком (STA). Чтобы использовать этот класс, убедитесь, что метод Main отмечен атрибутом STAThreadAttribute.

См. также раздел

• TextDataFormat
• ContainsText
• GetText

SetText(String, TextDataFormat)

Очищает буфер обмена и добавляет текстовые данные в формате, указанном заданным значением 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)

Параметры

text

String

Текст, добавляемый в буфер обмена.

format

TextDataFormat

Одно из значений перечисления TextDataFormat.

Исключения

ExternalException

Не удалось очистить буфер обмена. Обычно это происходит, когда буфер обмена используется другим процессом.

ThreadStateException

Текущий поток не выполняется в режиме апартмента с одним потоком (STA). Добавьте STAThreadAttribute в метод Main своего приложения.

ArgumentNullException

text имеет значение null или Empty.

InvalidEnumArgumentException

format не является допустимым значением TextDataFormat.

Примеры

В следующем примере показан этот элемент.

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

Комментарии

Чтобы получить текстовые данные из буфера обмена, сначала используйте ContainsText метод , чтобы определить, содержит ли буфер обмена текстовые данные, прежде чем получать их с GetText помощью метода .

Примечание

Класс Clipboard можно использовать только в потоках в режиме контейнера с одним потоком (STA). Чтобы использовать этот класс, убедитесь, что метод Main отмечен атрибутом STAThreadAttribute.

См. также раздел

• TextDataFormat
• ContainsText
• GetText