Clipboard.SetFileDropList メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Clipboard.SetFileDropList メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

ファイル名のコレクションを FileDrop 形式でクリップボードに追加します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Shared Sub SetFileDropList
 ( _
    filePaths As StringCollection _
)

Visual Basic (使用法)

Dim filePaths As StringCollection

Clipboard.SetFileDropList(filePaths)

public static void SetFileDropList
 (
    StringCollection filePaths
)

C++

public:
static void SetFileDropList (
    StringCollection^ filePaths
)

public static void SetFileDropList
 (
    StringCollection filePaths
)

JScript

public static function SetFileDropList
 (
    filePaths : StringCollection
)

パラメータ

filePaths: ファイル名を含んだ StringCollection。

例外

例外の種類	条件
ExternalException	クリップボードをクリアできませんでした。この例外は、通常、クリップボードが別のプロセスで使用されている場合に発生します。
ThreadStateException	現在のスレッドがシングルスレッドアパートメント (STA: Single Thread Apartment) モードになっていません。アプリケーションの Main メソッドに STAThreadAttribute を追加してください。
ArgumentNullException	filePaths が null 参照 (Visual Basic では Nothing) です。
ArgumentException	filePaths に文字列が含まれていません。または filePaths の文字列の少なくとも 1 つが Empty であるか、空白だけが含まれているか、InvalidPathChars で定義された無効な文字が 1 つ以上含まれています。あるいは、null 参照 (Visual Basic では Nothing) であるか、コロン (:) が含まれているか、システム定義の最大長を超過しています。詳細については、ArgumentException の InnerException プロパティのトピックを参照してください。

解説

ファイルドロップリストとは、ファイルへのパス情報を含んだ文字列のコレクションです。

ファイルドロップリストは、String 配列としてクリップボードに格納されます。このメソッドは、filePaths をクリップボードに追加する前に、String 配列に変換します。

クリップボードからファイルドロップリストを取得するには、GetFileDropList メソッドを使用してそのデータを取得する前に、まず ContainsFileDropList メソッドを使用してその形式のデータがクリップボードに含まれているかどうかを確認します。

メモ
Clipboard クラスは、シングルスレッドアパートメント (STA: Single Thread Apartment) モードに設定されているスレッドでだけ使用できます。このクラスを使用するには、Main メソッドが確実に STAThreadAttribute 属性でマークされているようにします。

使用例

このメンバの使用例を次に示します。

Visual Basic

' Demonstrates SetFileDropList, ContainsFileDroList, and GetFileDropList
Public Function SwapClipboardFileDropList(ByVal
 replacementList _
    As System.Collections.Specialized.StringCollection) _
    As System.Collections.Specialized.StringCollection

    Dim returnList As System.Collections.Specialized.StringCollection
 _
        = Nothing

    If Clipboard.ContainsFileDropList() Then

        returnList = Clipboard.GetFileDropList()
        Clipboard.SetFileDropList(replacementList)
    End If

    Return returnList

End Function

// Demonstrates SetFileDropList, ContainsFileDroList, and GetFileDropList
public System.Collections.Specialized.StringCollection
    SwapClipboardFileDropList(
    System.Collections.Specialized.StringCollection replacementList)
{
    System.Collections.Specialized.StringCollection returnList = null;
    if (Clipboard.ContainsFileDropList())
    {
        returnList = Clipboard.GetFileDropList();
        Clipboard.SetFileDropList(replacementList);
    }
    return returnList;
}

.NET Framework のセキュリティ