FilePickerSelectedFilesArray FilePickerSelectedFilesArray FilePickerSelectedFilesArray FilePickerSelectedFilesArray Class

Definition

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

public : sealed class FilePickerSelectedFilesArray : IIterable, IVectorViewpublic sealed class FilePickerSelectedFilesArray : IEnumerable, IReadOnlyListPublic NotInheritable Class FilePickerSelectedFilesArray Implements IEnumerable, IReadOnlyList// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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.

IReadOnlyList<StorageFile> files = await openPicker.PickMultipleFilesAsync();
if (files.Count > 0)
{
    StringBuilder output = new StringBuilder("Picked files:\n");
    // Application now has read/write access to the picked file(s)
    foreach (StorageFile file in files)
    {
        output.Append(file.Name + "\n");
    }
    OutputTextBlock.Text = output.ToString();
}
else
{
    OutputTextBlock.Text = "Operation cancelled.";
}
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");
    }
});

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.

Enumerating the collection in C# or Microsoft Visual Basic

FilePickerSelectedFilesArray is enumerable, so you can use language-specific syntax such as foreach in C# to enumerate the items in the collection. The compiler does the type-casting for you and you won't need to cast to IEnumerable<StorageFile> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast to IEnumerable<T> with a StorageFile constraint.

Properties

Item[Int32] Item[Int32] Item[Int32] Item[Int32]

Gets the element at the specified index in the read-only list.

This member is not implemented in C++T this[int index] { get; }ReadOnly Property Item(index As Integer) As TT this[int index] { get; }
Parameters
index

The zero-based index of the element to get.

Value
T T T T

The element at the specified index in the read-only list.

Size Size Size Size

Gets the number of StorageFile objects in the collection.

public : unsigned int Size { get; }This member is not implemented in C#This member is not implemented in VB.Net// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The number of StorageFile objects in the collection.

Methods

First() First() First() First()

Retrieves an iterator that iterates through the collection of StorageFile objects that represent selected files.

public : IIterator<StorageFile> First()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Returns

GetAt(UInt32) GetAt(UInt32) GetAt(UInt32) GetAt(UInt32)

Returns the StorageFile object at the specified index in the collection.

public : StorageFile GetAt(unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
index
unsigned int UInt32 UInt32 UInt32

The zero-based index of the object to retrieve.

Returns

The object at the specified index.

GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that iterates through the collection.

This member is not implemented in C++IEnumerator<T> GetEnumerator()Function GetEnumerator As IEnumerator(Of T)IEnumerator<T> GetEnumerator()
Returns

An enumerator that can be used to iterate through the collection.

GetMany(UInt32, StorageFile[]) GetMany(UInt32, StorageFile[]) GetMany(UInt32, StorageFile[]) GetMany(UInt32, StorageFile[])

Retrieves the StorageFile objects that start at the specified index in the collection.

public : unsigned int GetMany(unsigned int startIndex, StorageFile[] items)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
startIndex
unsigned int UInt32 UInt32 UInt32

The zero-based index of the start of the objects in the collection to return.

items
StorageFile[] StorageFile[] StorageFile[] StorageFile[]

The items in the collection that start at startIndex.

Returns
unsigned int uint uint uint

The number of items returned.

IndexOf(StorageFile, UInt32) IndexOf(StorageFile, UInt32) IndexOf(StorageFile, UInt32) IndexOf(StorageFile, UInt32)

Retrieves the index of a specified StorageFile object in the collection.

public : PlatForm::Boolean IndexOf(StorageFile value, unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
value
StorageFile StorageFile StorageFile StorageFile

The object to find in the collection.

index
unsigned int UInt32 UInt32 UInt32

The zero-based index of the object if found. Zero is returned if the object is not found.

Returns
PlatForm::Boolean bool bool bool

True if the object is found; otherwise false.

See Also