Clipboard.SetFileDropList(StringCollection) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Clears the Clipboard and then adds a collection of file names in the FileDrop format.

public:
 static void SetFileDropList(System::Collections::Specialized::StringCollection ^ filePaths);

public static void SetFileDropList (System.Collections.Specialized.StringCollection filePaths);

static member SetFileDropList : System.Collections.Specialized.StringCollection -> unit

Public Shared Sub SetFileDropList (filePaths As StringCollection)

Parameters

filePaths: StringCollection

A StringCollection containing the file names.

Exceptions

ExternalException

The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.

ThreadStateException

The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.

ArgumentNullException

filePaths is null.

ArgumentException

filePaths does not contain any strings.

-or-

At least one of the strings in filePaths is Empty, contains only white space, contains one or more invalid characters as defined by InvalidPathChars, is null, contains a colon (:), or exceeds the system-defined maximum length.

See the InnerException property of the ArgumentException for more information.

Examples

The following example demonstrates this member.

// 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;
}

' 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

Remarks

A file drop list is a collection of strings containing path information for files.

A file drop list is stored on the Clipboard as a String array. This method converts filePaths to a String array before adding it to the Clipboard.

To retrieve a file drop list from the Clipboard, first use the ContainsFileDropList method to determine whether the Clipboard contains data in that format before retrieving it with the GetFileDropList method.

Note

The Clipboard class can only be used in threads set to single thread apartment (STA) mode. To use this class, ensure that your Main method is marked with the STAThreadAttribute attribute.

Applies to