Clipboard.ContainsText Метод

Определение

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

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Показывает, имеются ли в буфере обмена текстовые данные.

Перегрузки

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

ContainsText()

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

public:
 static bool ContainsText();

public static bool ContainsText ();

static member ContainsText : unit -> bool

Public Shared Function ContainsText () As Boolean

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

Boolean

Значение true, если в буфере обмена имеются текстовые данные; в противном случае — значение false.

Исключения

ExternalException

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

ThreadStateException

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

Примеры

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

// 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 формате.

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

Примечание

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

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

• TextDataFormat
• Text
• UnicodeText
• GetText
• SetText

ContainsText(TextDataFormat)

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

public:
 static bool ContainsText(System::Windows::Forms::TextDataFormat format);

public static bool ContainsText (System.Windows.Forms.TextDataFormat format);

static member ContainsText : System.Windows.Forms.TextDataFormat -> bool

Public Shared Function ContainsText (format As TextDataFormat) As Boolean

Параметры

format

TextDataFormat

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

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

Boolean

Значение true, если в буфере обмена имеются текстовые данные в значении, заданном для format; в противном случае — значение false.

Исключения

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

Комментарии

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

Примечание

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

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

• TextDataFormat
• GetText
• SetText