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

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

注釈

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

例外

ExternalException

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

ThreadStateException

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

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