FilePickerFileTypesOrderedMap FilePickerFileTypesOrderedMap FilePickerFileTypesOrderedMap FilePickerFileTypesOrderedMap FilePickerFileTypesOrderedMap Class

Definition

Represents a collection of display names mapped to the associated file types (extensions). Each element in this collection maps a display name to a corresponding collection of file name extensions. The key is a single string, the value is a list/vector of strings representing one or more extension choices.

public : sealed class FilePickerFileTypesOrderedMap : IIterable<IKeyValuePair<Platform::String, IVector<Platform::String>>>, IMap<Platform::String, IVector<Platform::String>>
struct winrt::Windows::Storage::Pickers::FilePickerFileTypesOrderedMap : IIterable<IKeyValuePair<Platform::String, IVector<Platform::String>>>, IMap<Platform::String, IVector<Platform::String>>
public sealed class FilePickerFileTypesOrderedMap : IEnumerable<KeyValuePair<String, IList<String>>>, IDictionary<String, IList<String>>
Public NotInheritable Class FilePickerFileTypesOrderedMap Implements IEnumerable<KeyValuePair<String, IList<String>>>, IDictionary<String, IList<String>>
// This class does not provide a public constructor.
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 to add file type choices with a display name.

FileSavePicker savePicker = new FileSavePicker();
savePicker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary;
// Dropdown of file types the user can save the file as
savePicker.FileTypeChoices.Add("Plain Text", new List<string>() { ".txt" });
// Default file name if the user does not type one in or select a file to replace
savePicker.SuggestedFileName = "New Document";
// Create the picker object and set options
var savePicker = new Windows.Storage.Pickers.FileSavePicker();
savePicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.documentsLibrary;
// Dropdown of file types the user can save the file as
savePicker.fileTypeChoices.insert("Plain Text", [".txt"]);
// Default file name if the user does not type one in or select a file to replace
savePicker.suggestedFileName = "New Document";

Remarks

Instances of the FilePickerFileTypesOrderedMap class supply the value for the FileSavePicker.FileTypeChoices property. By strict typing, the FileTypeChoices property takes a generic map where the value is a generic vector of strings. But the FilePickerFileTypesOrderedMap class implements this combination of interfaces as a concrete class, so you should always use an FilePickerFileTypesOrderedMap object for a FileTypeChoices value.

The key for an entry in a FilePickerFileTypesOrderedMap is a string that represents a friendly-name/displayname classification of what a file type is intended for. For example, "Plain Text" is an appropriate key for a FilePickerFileTypesOrderedMap where one of the associated file type extensions is ".txt".One display name as a classification of file types might have multiple file types that support it. For example, a display name of "HTML page" could be saved either with ".htm" or ".html" extension. That is why the value of each entry in a FilePickerFileTypesOrderedMap is an ordered list (vector) of strings, displayed in the UI in the order that you place the extensions in the vector.

Collection member lists

For JavaScript, FilePickerFileTypesOrderedMap supports using an index to access items.

Properties

Item[TKey] Item[TKey] Item[TKey] Item[TKey] Item[TKey]

Gets or sets the element with the specified key.

Keys Keys Keys Keys Keys

Gets an System.Collections.Generic.ICollection`1 containing the keys of the System.Collections.Generic.IDictionary`2.

Size Size Size Size Size

Gets the number of items in the mapped collection of display names and associated file types.

Values Values Values Values Values

Gets an System.Collections.Generic.ICollection`1 containing the values in the System.Collections.Generic.IDictionary`2.

Methods

Add(TKey, TValue) Add(TKey, TValue) Add(TKey, TValue) Add(TKey, TValue) Add(TKey, TValue)

Adds an element with the provided key and value to the System.Collections.Generic.IDictionary`2.

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

Removes all display names and associated file name extensions from the collection.

ContainsKey(TKey) ContainsKey(TKey) ContainsKey(TKey) ContainsKey(TKey) ContainsKey(TKey)

Determines whether the System.Collections.Generic.IDictionary`2 contains an element with the specified key.

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

Retrieves an iterator that iterates through the display names and associated file types in the collection.

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

Returns an enumerator that iterates through the collection.

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

Returns an immutable view of the collection of display names and associated file types.

HasKey(String) HasKey(String) HasKey(String) HasKey(String) HasKey(String)

Determines whether the mapped collection of display names and associated file types contains the specified key.

Insert(String, IVector<String>) Insert(String, IVector<String>) Insert(String, IVector<String>) Insert(String, IVector<String>) Insert(String, IVector<String>)

Inserts or replaces an item in the mapped collection of display names and associated file types.

Lookup(String) Lookup(String) Lookup(String) Lookup(String) Lookup(String)

Returns the item at the specified key in the mapped collection of display names and associated file types.

Remove(T) Remove(T) Remove(T) Remove(T) Remove(T)

Removes the element with the specified key from the System.Collections.Generic.IDictionary`2.

Remove(String) Remove(String) Remove(String) Remove(String) Remove(String)

Removes an item from the mapped collection of display names and associated file types.

TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue)

Gets the value associated with the specified key.

See Also