Clipboard.SetText Метод

Определение

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

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

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

Перегрузки

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

SetText(String)

Исходный код:

Clipboard.cs

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

Note

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

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

• TextDataFormat
• ContainsText
• GetText

SetText(String, TextDataFormat)

Исходный код:

Clipboard.cs

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

Note

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

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

• TextDataFormat
• ContainsText
• GetText