FolderInformation FolderInformation FolderInformation FolderInformation FolderInformation Class

Definition

Provides synchronous access to the properties exposed off StorageFolder and lets an app perform asynchronous management operations such as copy, delete, move, and rename.

public : sealed class FolderInformation : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations
struct winrt::Windows::Storage::BulkAccess::FolderInformation : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations
public sealed class FolderInformation : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations
Public NotInheritable Class FolderInformation Implements IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations
// 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)

Remarks

Note

Although it's not attributed with marshalling_behavior(agile), this class can be treated as agile. For more info, see Threading and Marshaling (C++/CX).

You can retrieve a list of FolderInformation objects by calling one of the FileInformationFactory.GetFoldersAsync methods.

Properties

Attributes Attributes Attributes Attributes Attributes

Gets the attributes of a loaded folder.

BasicProperties BasicProperties BasicProperties BasicProperties BasicProperties

Gets an object that contains the basic properties information of the folder.

DateCreated DateCreated DateCreated DateCreated DateCreated

Gets the date that the folder was created.

DisplayName DisplayName DisplayName DisplayName DisplayName

Gets the user-friendly name of the StorageFolder.

DisplayType DisplayType DisplayType DisplayType DisplayType

Gets the display type of the StorageFolder.

DocumentProperties DocumentProperties DocumentProperties DocumentProperties DocumentProperties

Gets the document properties of the StorageFolder.

FolderRelativeId FolderRelativeId FolderRelativeId FolderRelativeId FolderRelativeId

Gets the identifier that uniquely identifies the StorageFolder relative to other items in the same folder.

ImageProperties ImageProperties ImageProperties ImageProperties ImageProperties

Gets the image properties of the StorageFolder.

MusicProperties MusicProperties MusicProperties MusicProperties MusicProperties

Gets the music properties associated with the StorageFolder.

Name Name Name Name Name

Gets the name of the StorageFolder.

Path Path Path Path Path

Gets the path of the StorageFolder.

Properties Properties Properties Properties Properties

Gets an object for retrieving the properties of the StorageFolder.

Provider Provider Provider Provider Provider

Gets the StorageProvider object that contains info about the service that stores the current folder.

Thumbnail Thumbnail Thumbnail Thumbnail Thumbnail

Gets the thumbnail for the StorageFile.

VideoProperties VideoProperties VideoProperties VideoProperties VideoProperties

Gets the video properties that are associated with the StorageFolder.

Methods

AreQueryOptionsSupported(QueryOptions) AreQueryOptionsSupported(QueryOptions) AreQueryOptionsSupported(QueryOptions) AreQueryOptionsSupported(QueryOptions) AreQueryOptionsSupported(QueryOptions)

Retrieves a value that indicates whether the folder supports the specified search query options.

CreateFileAsync(String) CreateFileAsync(String) CreateFileAsync(String) CreateFileAsync(String) CreateFileAsync(String)

Creates a new file in the current folder.

CreateFileAsync(String, CreationCollisionOption) CreateFileAsync(String, CreationCollisionOption) CreateFileAsync(String, CreationCollisionOption) CreateFileAsync(String, CreationCollisionOption) CreateFileAsync(String, CreationCollisionOption)

Creates a new file in the current folder, and specifies what to do if a file with the same name already exists in the current folder.

CreateFileQuery() CreateFileQuery() CreateFileQuery() CreateFileQuery() CreateFileQuery()

Creates an object for performing filtered search queries for StorageFile in the current folder.

CreateFileQuery(CommonFileQuery) CreateFileQuery(CommonFileQuery) CreateFileQuery(CommonFileQuery) CreateFileQuery(CommonFileQuery) CreateFileQuery(CommonFileQuery)

Creates an object for performing filtered search queries for StorageFile objects in the current folder. Search results are grouped based on the specified file attribute.

CreateFileQueryWithOptions(QueryOptions) CreateFileQueryWithOptions(QueryOptions) CreateFileQueryWithOptions(QueryOptions) CreateFileQueryWithOptions(QueryOptions) CreateFileQueryWithOptions(QueryOptions)

Creates an object used to perform filtered search queries for StorageFile objects in the folder. The object is initialized with the specified query options.

CreateFolderAsync(String) CreateFolderAsync(String) CreateFolderAsync(String) CreateFolderAsync(String) CreateFolderAsync(String)

Creates a new child folder of the current folder.

CreateFolderAsync(String, CreationCollisionOption) CreateFolderAsync(String, CreationCollisionOption) CreateFolderAsync(String, CreationCollisionOption) CreateFolderAsync(String, CreationCollisionOption) CreateFolderAsync(String, CreationCollisionOption)

Creates a new child folder of the current folder, and specifies what to do if a folder with the same name already exists in the current folder.

CreateFolderQuery() CreateFolderQuery() CreateFolderQuery() CreateFolderQuery() CreateFolderQuery()

Creates an object for performing filtered search queries for child StorageFolder objects of the current folder.

CreateFolderQuery(CommonFolderQuery) CreateFolderQuery(CommonFolderQuery) CreateFolderQuery(CommonFolderQuery) CreateFolderQuery(CommonFolderQuery) CreateFolderQuery(CommonFolderQuery)

Creates an object for performing filtered search queries for child StorageFolder objects of the current folder. Search results are grouped based on the specified folder attribute.

CreateFolderQueryWithOptions(QueryOptions) CreateFolderQueryWithOptions(QueryOptions) CreateFolderQueryWithOptions(QueryOptions) CreateFolderQueryWithOptions(QueryOptions) CreateFolderQueryWithOptions(QueryOptions)

Creates an object used to perform filtered search queries for child StorageFolder objects of the current folder. The object is initialized with the specified query options.

CreateItemQuery() CreateItemQuery() CreateItemQuery() CreateItemQuery() CreateItemQuery()

Creates an object used to perform filtered search queries for items in the folder.

CreateItemQueryWithOptions(QueryOptions) CreateItemQueryWithOptions(QueryOptions) CreateItemQueryWithOptions(QueryOptions) CreateItemQueryWithOptions(QueryOptions) CreateItemQueryWithOptions(QueryOptions)

Creates an object used to perform filtered search queries for items in the folder. The object is initialized with the specified query options.

DeleteAsync() DeleteAsync() DeleteAsync() DeleteAsync() DeleteAsync()

Deletes the current folder.

DeleteAsync(StorageDeleteOption) DeleteAsync(StorageDeleteOption) DeleteAsync(StorageDeleteOption) DeleteAsync(StorageDeleteOption) DeleteAsync(StorageDeleteOption)

Deletes the current folder, optionally moving the deleted folder to the recycle bin.

GetBasicPropertiesAsync() GetBasicPropertiesAsync() GetBasicPropertiesAsync() GetBasicPropertiesAsync() GetBasicPropertiesAsync()

Retrieves the basic properties of the StorageFolder object.

GetFileAsync(String) GetFileAsync(String) GetFileAsync(String) GetFileAsync(String) GetFileAsync(String)

Retrieves a file from the current folder.

GetFilesAsync() GetFilesAsync() GetFilesAsync() GetFilesAsync() GetFilesAsync()

Retrieves all files from the current folder.

GetFilesAsync(CommonFileQuery) GetFilesAsync(CommonFileQuery) GetFilesAsync(CommonFileQuery) GetFilesAsync(CommonFileQuery) GetFilesAsync(CommonFileQuery)

Retrieves files from the current folder based on a common folder query.

GetFilesAsync(CommonFileQuery, UInt32, UInt32) GetFilesAsync(CommonFileQuery, UInt32, UInt32) GetFilesAsync(CommonFileQuery, UInt32, UInt32) GetFilesAsync(CommonFileQuery, UInt32, UInt32) GetFilesAsync(CommonFileQuery, UInt32, UInt32)

Retrieves a range of files from the current folder based on a common file query.

GetFolderAsync(String) GetFolderAsync(String) GetFolderAsync(String) GetFolderAsync(String) GetFolderAsync(String)

Retrieves the specified child folder from the current folder.

GetFoldersAsync() GetFoldersAsync() GetFoldersAsync() GetFoldersAsync() GetFoldersAsync()

Retrieves all child folders from the current folder.

GetFoldersAsync(CommonFolderQuery) GetFoldersAsync(CommonFolderQuery) GetFoldersAsync(CommonFolderQuery) GetFoldersAsync(CommonFolderQuery) GetFoldersAsync(CommonFolderQuery)

Retrieves child folders from the current folder based on a common folder query.

GetFoldersAsync(CommonFolderQuery, UInt32, UInt32) GetFoldersAsync(CommonFolderQuery, UInt32, UInt32) GetFoldersAsync(CommonFolderQuery, UInt32, UInt32) GetFoldersAsync(CommonFolderQuery, UInt32, UInt32) GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)

Retrieves a range of child folders from the current folder based on a common folder query.

GetIndexedStateAsync() GetIndexedStateAsync() GetIndexedStateAsync() GetIndexedStateAsync() GetIndexedStateAsync()

Retrieves the indexed state of the folder.

GetItemAsync(String) GetItemAsync(String) GetItemAsync(String) GetItemAsync(String) GetItemAsync(String)

Retrieves an item from the folder.

GetItemsAsync() GetItemsAsync() GetItemsAsync() GetItemsAsync() GetItemsAsync()

Retrieves all items from the current folder.

GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32)

Retrieves a range of items from the current folder.

GetParentAsync() GetParentAsync() GetParentAsync() GetParentAsync() GetParentAsync()

Gets the parent folder of the current folder.

GetThumbnailAsync(ThumbnailMode) GetThumbnailAsync(ThumbnailMode) GetThumbnailAsync(ThumbnailMode) GetThumbnailAsync(ThumbnailMode) GetThumbnailAsync(ThumbnailMode)

Retrieves the thumbnail that is associated with the StorageFolder.

GetThumbnailAsync(ThumbnailMode, UInt32) GetThumbnailAsync(ThumbnailMode, UInt32) GetThumbnailAsync(ThumbnailMode, UInt32) GetThumbnailAsync(ThumbnailMode, UInt32) GetThumbnailAsync(ThumbnailMode, UInt32)

Retrieves the thumbnail that is associated with the StorageFolder, scaling it to the specified size.

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

Retrieves the thumbnail that is associated with the StorageFolder, based on the specified options.

IsCommonFileQuerySupported(CommonFileQuery) IsCommonFileQuerySupported(CommonFileQuery) IsCommonFileQuerySupported(CommonFileQuery) IsCommonFileQuerySupported(CommonFileQuery) IsCommonFileQuerySupported(CommonFileQuery)

Retrieves a value that indicates whether the current folder supports the specified common file query.

IsCommonFolderQuerySupported(CommonFolderQuery) IsCommonFolderQuerySupported(CommonFolderQuery) IsCommonFolderQuerySupported(CommonFolderQuery) IsCommonFolderQuerySupported(CommonFolderQuery) IsCommonFolderQuerySupported(CommonFolderQuery)

Retrieves a value that indicates whether the current folder supports the specified common folder query.

IsEqual(IStorageItem) IsEqual(IStorageItem) IsEqual(IStorageItem) IsEqual(IStorageItem) IsEqual(IStorageItem)

Indicates whether the current folder is equal to the specified folder.

IsOfType(StorageItemTypes) IsOfType(StorageItemTypes) IsOfType(StorageItemTypes) IsOfType(StorageItemTypes) IsOfType(StorageItemTypes)

Determines whether the loaded StorageFolder is the specified type.

RenameAsync(String) RenameAsync(String) RenameAsync(String) RenameAsync(String) RenameAsync(String)

Renames the StorageFolder.

RenameAsync(String, NameCollisionOption) RenameAsync(String, NameCollisionOption) RenameAsync(String, NameCollisionOption) RenameAsync(String, NameCollisionOption) RenameAsync(String, NameCollisionOption)

Renames the StorageFolder, and specifies what to do if a folder with the same name already exists.

TryGetItemAsync(String) TryGetItemAsync(String) TryGetItemAsync(String) TryGetItemAsync(String) TryGetItemAsync(String)

Try to get a specific file or sub-folder from the current folder using the name of the file or folder to get.

Events

PropertiesUpdated PropertiesUpdated PropertiesUpdated PropertiesUpdated PropertiesUpdated

Occurs when one or more of the StorageFolder 's properties is updated.

ThumbnailUpdated ThumbnailUpdated ThumbnailUpdated ThumbnailUpdated ThumbnailUpdated

Fires when the StorageFolder 's thumbnail is updated or a better quality thumbnail is available.

See Also