FilePickerSelectedFilesArray class (Windows)

This topic has not yet been rated - Rate this topic

Represents a collection of storage files that the user has selected by using a file picker.

Syntax


/* For information about creating or accessing this object, see Remarks. */

Attributes

VersionAttribute(NTDDI_WIN8)

Members

The FilePickerSelectedFilesArray class has these types of members:

Methods
Properties

Methods

The FilePickerSelectedFilesArray class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

Method	Description
First [C++, JavaScript]	Retrieves an iterator that iterates through the collection of StorageFile objects that represent selected files.
GetAt [C++, JavaScript]	Returns the StorageFile object at the specified index in the collection.
GetEnumerator [C#, VB]	Returns an enumerator that iterates through a collection.
GetMany [C++, JavaScript]	Retrieves the StorageFile objects that start at the specified index in the collection.
IndexOf [C++, JavaScript]	Retrieves the index of a specified StorageFile object in the collection.

Properties

The FilePickerSelectedFilesArray class has these properties.

Property	Access type	Description
Count [C#, VB]	Read-only	Gets the number of elements actually contained in the collection.
Item [C#, VB]	Read-only	Gets or sets the element at the specified index.
Size [C++, JavaScript]	Read-only	Gets the number of StorageFile objects in the collection.

Remarks

When a call to the fileOpenPicker.pickMultipleFilesAsync method completes successfully, it returns a filePickerSelectedFilesArray object that contains all the files that were picked by the user. Picked files in this array are represented by storageFile objects.

Collection member lists

For JavaScript, FilePickerSelectedFilesArray has the members shown in the member lists. In addition, FilePickerSelectedFilesArray supports a length property, members of Array.prototype, and using an index to access items.

Examples

The File picker sample demonstrates how capture the filePickerSelectedFilesArray (files in the example) of picked files after calling fileOpenPicker.pickMultipleFilesAsync.

Note You should always make sure that your app is not snapped (or that it can be unsnapped) and set file picker properties regardless of whether the user is picking a single file or multiple files.

JavaScript


openPicker.pickMultipleFilesAsync().then(function (files) {
    if (files.size > 0) {
        // Application now has read/write access to the picked file(s)
        var outputString = "Picked files:\n";
        for (var i = 0; i < files.size; i++) {
            outputString = outputString + files[i].name + "\n";
        }
        WinJS.log && WinJS.log(outputString, "sample", "status");
    } else {
        // The picker was dismissed with no selected file
        WinJS.log && WinJS.log("Operation cancelled.", "sample", "status");
    }
});

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Namespace	Windows.Storage.Pickers Windows::Storage::Pickers [C++]
Metadata	Windows.winmd

FilePickerSelectedFilesArray class