Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Clipboard.SetFileDropList Method

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public static void SetFileDropList(
	StringCollection filePaths
)

Parameters

filePaths
Type: System.Collections.Specialized.StringCollection

A StringCollection containing the file names.

ExceptionCondition
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.

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.

NoteNote

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.

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

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.