Clipboard.GetFileDropList Clipboard.GetFileDropList Clipboard.GetFileDropList Clipboard.GetFileDropList Method

Definition

Retrieves a collection of file names from the Clipboard.

public:
 static System::Collections::Specialized::StringCollection ^ GetFileDropList();
public static System.Collections.Specialized.StringCollection GetFileDropList ();
static member GetFileDropList : unit -> System.Collections.Specialized.StringCollection
Public Shared Function GetFileDropList () As StringCollection

Returns

A StringCollection containing file names or null if the Clipboard does not contain any data that is in the FileDrop format or can be converted to that format.

Exceptions

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

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

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 this array to a StringCollection and returns the collection.

Use the ContainsFileDropList method to determine whether the Clipboard contains a file drop list before retrieving it with this method.

Use the SetFileDropList method to add a file drop list to the Clipboard.

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.

Security

UIPermission
for access to the system Clipboard. Associated enumeration: AllClipboard

Applies to

See also