FolderInformation class
Provides synchronous access to the properties exposed off StorageFolder and lets an app perform asynchronous management operations such as copy, delete, move, and rename.
Syntax
/* For information about creating or accessing this object, see Remarks. */
Attributes
- MarshalingBehaviorAttribute(Agile)
- VersionAttribute(NTDDI_WIN8)
Members
The FolderInformation class has these types of members:
Events
The FolderInformation class has these events.
| Event | Description |
|---|---|
| PropertiesUpdated | Occurs when one or more of the StorageFolder's properties is updated. |
| ThumbnailUpdated | Fires when the StorageFolder's thumbnail is updated or a better quality thumbnail is available. |
Methods
The FolderInformation class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.
| Method | Description |
|---|---|
| AreQueryOptionsSupported | Retrieves a value that indicates whether the folder supports the specified search query options. |
| CreateFileAsync(String) | Creates a new file in the current folder. |
| 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() | Creates an object for performing filtered search queries for StorageFile in the current folder. |
| 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 | 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) | Creates a new child folder of the current folder. |
| 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() | Creates an object for performing filtered search queries for child StorageFolder objects of the current folder. |
| 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 | 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 | Creates an object used to perform filtered search queries for items in the folder. |
| CreateItemQueryWithOptions | Creates an object used to perform filtered search queries for items in the folder. The object is initialized with the specified query options. |
| DeleteAsync() | Deletes the current folder. |
| DeleteAsync(StorageDeleteOption) | Deletes the current folder, optionally moving the deleted folder to the recycle bin. |
| GetBasicPropertiesAsync | Retrieves the basic properties of the StorageFolder object. |
| GetFileAsync | Retrieves a file from the current folder. |
| GetFilesAsync() | Retrieves all files from the current folder. |
| GetFilesAsync(CommonFileQuery) | Retrieves files from the current folder based on a common folder query. |
| GetFilesAsync(CommonFileQuery, UInt32, UInt32) | Retrieves a range of files from the current folder based on a common file query. |
| GetFolderAsync | Retrieves the specified child folder from the current folder. |
| GetFoldersAsync() | Retrieves all child folders from the current folder. |
| GetFoldersAsync(CommonFolderQuery) | Retrieves child folders from the current folder based on a common folder query. |
| GetFoldersAsync(CommonFolderQuery, UInt32, UInt32) | Retrieves a range of child folders from the current folder based on a common folder query. |
| GetIndexedStateAsync | Retrieves the indexed state of the folder. |
| GetItemAsync | Retrieves an item from the folder. |
| GetItemsAsync() | Retrieves all items from the current folder. |
| GetItemsAsync(UInt32, UInt32) | Retrieves a range of items from the current folder. |
| GetThumbnailAsync(ThumbnailMode) | Retrieves the thumbnail that is associated with the StorageFolder. |
| GetThumbnailAsync(ThumbnailMode, UInt32) | Retrieves the thumbnail that is associated with the StorageFolder, scaling it to the specified size. |
| GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) | Retrieves the thumbnail that is associated with the StorageFolder, based on the specified options. |
| IsCommonFileQuerySupported | Retrieves a value that indicates whether the current folder supports the specified common file query. |
| IsCommonFolderQuerySupported | Retrieves a value that indicates whether the current folder supports the specified common folder query. |
| IsOfType | Determines whether the loaded StorageFolder is the specified type. |
| RenameAsync(String) | Renames the StorageFolder. |
| RenameAsync(String, NameCollisionOption) | Renames the StorageFolder, and specifies what to do if a folder with the same name already exists. |
Properties
The FolderInformation class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets the attributes of a loaded folder. | |
| Read-only | Gets an object that contains the basic properties information of the folder. | |
| Read-only | Gets the date that the folder was created. | |
| Read-only | Gets the user-friendly name of the StorageFolder. | |
| Read-only | Gets the display type of the StorageFolder. | |
| Read-only | Gets the document properties of the StorageFolder. | |
| Read-only | Gets the identifier that uniquely identifies the StorageFolder relative to other items in the same folder. | |
| Read-only | Gets the image properties of the StorageFolder. | |
| Read-only | Gets the music properties associated with the StorageFolder. | |
| Read-only | Gets the name of the StorageFolder. | |
| Read-only | Gets the path of the StorageFolder. | |
| Read-only | Gets an object for retrieving the properties of the StorageFolder. | |
| Read-only | Gets the thumbnail for the StorageFile. | |
| Read-only | Gets the video properties that are associated with the StorageFolder. |
Remarks
You can retrieve a list of FolderInformation objects by calling one of the FileInformationFactory.GetFoldersAsync methods.
Requirements
|
Minimum supported client | Windows 8 [Windows Store apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [Windows Store apps only] |
|
Namespace |
|
|
Metadata |
|
See also
Build date: 12/4/2012
