Clipboard.GetText Метод

Определение

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

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Извлекает текстовые данные из буфера обмена.

Перегрузки

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

GetText()

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

public:
 static System::String ^ GetText();

public static string GetText ();

static member GetText : unit -> string

Public Shared Function GetText () As String

Возвращаемое значение

String

Текстовые данные буфера обмена или Empty, если буфер обмена не содержит данных в формате Text или UnicodeText в зависимости от операционной системы.

Исключения

ExternalException

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

ThreadStateException

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

Примеры

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

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

Используйте метод для SetText добавления текстовых данных в буфер обмена.

Примечание

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

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

• TextDataFormat
• ContainsText
• SetText

GetText(TextDataFormat)

Извлекает текстовые данные из буфера обмена в формате, указанном заданным значением TextDataFormat.

public:
 static System::String ^ GetText(System::Windows::Forms::TextDataFormat format);

public static string GetText (System.Windows.Forms.TextDataFormat format);

static member GetText : System.Windows.Forms.TextDataFormat -> string

Public Shared Function GetText (format As TextDataFormat) As String

Параметры

format

TextDataFormat

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

Возвращаемое значение

String

Текстовые данные буфера обмена или Empty, если буфер обмена не содержит данных в указанном формате.

Исключения

ExternalException

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

ThreadStateException

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

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

Используйте метод для SetText добавления текстовых данных в буфер обмена.

Примечание

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

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

• TextDataFormat
• ContainsText
• SetText