FileExtensionVector FileExtensionVector FileExtensionVector FileExtensionVector Class

Definition

Represents a random-access collection of file name extensions.

public sealed class FileExtensionVectorpublic sealed class FileExtensionVectorPublic NotInheritable Class FileExtensionVectorpublic sealed class FileExtensionVector
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Collection member lists

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

Enumerating the collection in C# or Microsoft Visual Basic

A FileExtensionVector 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<String> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast to IEnumerable<T> with a String constraint.

Examples

The File picker sample demonstrates how to specify the file types that the user can see and pick from in the file picker.

FileOpenPicker openPicker = new FileOpenPicker();
openPicker.ViewMode = PickerViewMode.Thumbnail;
openPicker.SuggestedStartLocation = PickerLocationId.PicturesLibrary;
openPicker.FileTypeFilter.Add(".jpg");
openPicker.FileTypeFilter.Add(".jpeg");
openPicker.FileTypeFilter.Add(".png");
// Create the picker object and set options
var openPicker = new Windows.Storage.Pickers.FileOpenPicker();
openPicker.viewMode = Windows.Storage.Pickers.PickerViewMode.thumbnail;
openPicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.picturesLibrary;
// Users expect to have a filtered view of their folders depending on the scenario.
// For example, when choosing a documents folder, restrict the filetypes to documents for your application.
openPicker.fileTypeFilter.replaceAll([".png", ".jpg", ".jpeg"]);
FileOpenPicker openPicker = new FileOpenPicker();
openPicker.ViewMode = PickerViewMode.List;
openPicker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary;
openPicker.FileTypeFilter.Add("*");
var openPicker = new Windows.Storage.Pickers.FileOpenPicker();
openPicker.viewMode = Windows.Storage.Pickers.PickerViewMode.list;
openPicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.documentsLibrary;
openPicker.fileTypeFilter.replaceAll(["*"]);

Properties

Size Size Size Size

Gets the number of file name extensions in the collection.

public uint Size { get; }public uint Size { get; }Public ReadOnly Property Size As uintpublic uint Size { get; }
Value
uint uint uint uint

The number of file name extensions.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Methods

Append(String) Append(String) Append(String) Append(String)

Appends a file name extension to the end of the collection.

public void Append(String value)public void Append(String value)Public Function Append(value As String) As voidpublic void Append(String value)
Parameters
value
System.String System.String System.String System.String

The file name extension to append.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Clear() Clear() Clear() Clear()

Removes all file name extensions from the collection.

public void Clear()public void Clear()Public Function Clear() As voidpublic void Clear()
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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

Retrieves an iterator that iterates through the file name extensions in the collection.

public IIterator<string> First()public IIterator<string> First()Public Function First() As IIterator( Of string )public IIterator<string> First()
Returns

The iterator.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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

Retrieves the file name extension at the specified index in the collection.

public string GetAt(UInt32 index)public string GetAt(UInt32 index)Public Function GetAt(index As UInt32) As stringpublic string GetAt(UInt32 index)
Parameters
index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The zero-based index of the file name extension to retrieve.

Returns
string string string string

The file name extension at the specified index.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetMany(UInt32, String[]) GetMany(UInt32, String[]) GetMany(UInt32, String[]) GetMany(UInt32, String[])

Retrieves the file name extensions that start at the specified index in the collection.

public uint GetMany(UInt32 startIndex, String[] items)public uint GetMany(UInt32 startIndex, String[] items)Public Function GetMany(startIndex As UInt32, items As String[]) As uintpublic uint GetMany(UInt32 startIndex, String[] items)
Parameters
startIndex
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The zero-based index of the start of the file name extensions in the collection to retrieve.

items
System.String[] System.String[] System.String[] System.String[]

The file name extensions in the collection that start at startIndex.

Returns
uint uint uint uint

The number of items retrieved.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetView() GetView() GetView() GetView()

Retrieves an immutable view of the collection of file name extensions.

public IVectorView<string> GetView()public IVectorView<string> GetView()Public Function GetView() As IVectorView( Of string )public IVectorView<string> GetView()
Returns

The view of the collection.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

IndexOf(String, UInt32) IndexOf(String, UInt32) IndexOf(String, UInt32) IndexOf(String, UInt32)

Retrieves the index of a specified file name extension in the collection.

public bool IndexOf(String value, UInt32 index)public bool IndexOf(String value, UInt32 index)Public Function IndexOf(value As String, index As UInt32) As boolpublic bool IndexOf(String value, UInt32 index)
Parameters
value
System.String System.String System.String System.String

The file name extension to find in the collection.

index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The zero-based index of the file name extension if found. This parameter is set to zero if the file name extension is not found.

Returns
bool bool bool bool

True if the file name extension is found; otherwise FALSE.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

InsertAt(UInt32, String) InsertAt(UInt32, String) InsertAt(UInt32, String) InsertAt(UInt32, String)

Inserts a file name extension into a collection at a specified index.

public void InsertAt(UInt32 index, String value)public void InsertAt(UInt32 index, String value)Public Function InsertAt(index As UInt32, value As String) As voidpublic void InsertAt(UInt32 index, String value)
Parameters
index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

Zero-based index of the location at which to insert the file name extension.

value
System.String System.String System.String System.String

The file name extension to insert.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32)

Removes the file name extension at the specified index in the collection.

public void RemoveAt(UInt32 index)public void RemoveAt(UInt32 index)Public Function RemoveAt(index As UInt32) As voidpublic void RemoveAt(UInt32 index)
Parameters
index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The zero-based index of the file name extension to remove.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

RemoveAtEnd() RemoveAtEnd() RemoveAtEnd() RemoveAtEnd()

Removes the last file name extension from the collection.

public void RemoveAtEnd()public void RemoveAtEnd()Public Function RemoveAtEnd() As voidpublic void RemoveAtEnd()
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

ReplaceAll(String[]) ReplaceAll(String[]) ReplaceAll(String[]) ReplaceAll(String[])

Replaces all file name extensions in the collection with the specified file name extensions.

public void ReplaceAll(String[] items)public void ReplaceAll(String[] items)Public Function ReplaceAll(items As String[]) As voidpublic void ReplaceAll(String[] items)
Parameters
items
System.String[] System.String[] System.String[] System.String[]

The collection of file name extensions to put in the vector.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetAt(UInt32, String) SetAt(UInt32, String) SetAt(UInt32, String) SetAt(UInt32, String)

Sets the file name extension at the specified index of the collection.

public void SetAt(UInt32 index, String value)public void SetAt(UInt32 index, String value)Public Function SetAt(index As UInt32, value As String) As voidpublic void SetAt(UInt32 index, String value)
Parameters
index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The zero-based index of the location at which to set the file name extension.

value
System.String System.String System.String System.String

The file name extension.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)