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: Single Thread Apartment) モードになっていません。 アプリケーションの Main メソッドに STAThreadAttribute を追加してください。

例

次の例では、このオーバーロードに 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

注釈

このメソッドは、Windows XP Home Edition、Windows XP Professional、Windows Server 2003、Windows 2000 の形式で UnicodeText テキスト データを返します。 それ以外の場合、このメソッドは形式のテキスト データを 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 値のいずれか 1 つ。

戻り値

String

クリップボードのテキスト データ。指定した形式のデータがクリップボードに含まれていない場合は Empty。

例外

ExternalException

クリップボードをクリアできませんでした。 この例外は、通常、クリップボードが別のプロセスで使用されている場合に発生します。

ThreadStateException

現在のスレッドがシングル スレッド アパートメント (STA: Single Thread Apartment) モードになっていません。 アプリケーションの Main メソッドに STAThreadAttribute を追加してください。

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