Folder​Information Folder​Information Folder​Information 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, IStorageFolderQueryOperationspublic sealed class FolderInformation : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperationsPublic NotInheritable Class FolderInformation Implements IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations
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

Gets the attributes of a loaded folder.

public FileAttributes Attributes { get; }public FileAttributes Attributes { get; }Public ReadOnly Property Attributes As FileAttributes
Value
FileAttributes FileAttributes FileAttributes

The folder attributes.

Attributes

BasicProperties BasicProperties BasicProperties

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

public BasicProperties BasicProperties { get; }public BasicProperties BasicProperties { get; }Public ReadOnly Property BasicProperties As BasicProperties
Value
BasicProperties BasicProperties BasicProperties

The basic properties object.

Attributes

DateCreated DateCreated DateCreated

Gets the date that the folder was created.

public DateTime DateCreated { get; }public DateTimeOffset DateCreated { get; }Public ReadOnly Property DateCreated As DateTimeOffset
Value
DateTime DateTime DateTime

The folder creation date.

Attributes

Remarks

If the date property isn't set, this value defaults to 0 which can be translated into misleading dates in different programming languages. In JavaScript, for example, 0 translates to December 16, 1600. You should always check that this property is a real value and not 0.

DisplayName DisplayName DisplayName

Gets the user-friendly name of the StorageFolder.

public PlatForm::String DisplayName { get; }public string DisplayName { get; }Public ReadOnly Property DisplayName As string
Value
string string string

The user-friendly name of the StorageFolder.

Attributes

DisplayType DisplayType DisplayType

Gets the display type of the StorageFolder.

public PlatForm::String DisplayType { get; }public string DisplayType { get; }Public ReadOnly Property DisplayType As string
Value
string string string

The display type.

Attributes

DocumentProperties DocumentProperties DocumentProperties

Gets the document properties of the StorageFolder.

public DocumentProperties DocumentProperties { get; }public DocumentProperties DocumentProperties { get; }Public ReadOnly Property DocumentProperties As DocumentProperties
Attributes

FolderRelativeId FolderRelativeId FolderRelativeId

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

public PlatForm::String FolderRelativeId { get; }public string FolderRelativeId { get; }Public ReadOnly Property FolderRelativeId As string
Value
string string string

The folder-relative identifier.

Attributes

ImageProperties ImageProperties ImageProperties

Gets the image properties of the StorageFolder.

public ImageProperties ImageProperties { get; }public ImageProperties ImageProperties { get; }Public ReadOnly Property ImageProperties As ImageProperties
Value
ImageProperties ImageProperties ImageProperties

The image properties.

Attributes

MusicProperties MusicProperties MusicProperties

Gets the music properties associated with the StorageFolder.

public MusicProperties MusicProperties { get; }public MusicProperties MusicProperties { get; }Public ReadOnly Property MusicProperties As MusicProperties
Value
MusicProperties MusicProperties MusicProperties

The music properties.

Attributes

Name Name Name

Gets the name of the StorageFolder.

public PlatForm::String Name { get; }public string Name { get; }Public ReadOnly Property Name As string
Value
string string string

The StorageFolder name.

Attributes

Path Path Path

Gets the path of the StorageFolder.

public PlatForm::String Path { get; }public string Path { get; }Public ReadOnly Property Path As string
Value
string string string

The path.

Attributes

Properties Properties Properties

Gets an object for retrieving the properties of the StorageFolder.

public StorageItemContentProperties Properties { get; }public StorageItemContentProperties Properties { get; }Public ReadOnly Property Properties As StorageItemContentProperties
Attributes

Provider Provider Provider

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

public StorageProvider Provider { get; }public StorageProvider Provider { get; }Public ReadOnly Property Provider As StorageProvider
Value
StorageProvider StorageProvider StorageProvider

The StorageProvider object that contains info about the service that stores the current folder. The file may be stored by the local file system or by a remote service like Microsoft OneDrive.

Attributes

Thumbnail Thumbnail Thumbnail

Gets the thumbnail for the StorageFile.

public StorageItemThumbnail Thumbnail { get; }public StorageItemThumbnail Thumbnail { get; }Public ReadOnly Property Thumbnail As StorageItemThumbnail
Attributes

VideoProperties VideoProperties VideoProperties

Gets the video properties that are associated with the StorageFolder.

public VideoProperties VideoProperties { get; }public VideoProperties VideoProperties { get; }Public ReadOnly Property VideoProperties As VideoProperties
Value
VideoProperties VideoProperties VideoProperties

The video properties.

Attributes

Methods

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

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

public PlatForm::Boolean AreQueryOptionsSupported(QueryOptions queryOptions)public bool AreQueryOptionsSupported(QueryOptions queryOptions)Public Function AreQueryOptionsSupported(queryOptions As QueryOptions) As bool
Parameters
queryOptions
QueryOptions QueryOptions QueryOptions

The search query options to test.

Returns
bool bool bool

True if the folder supports the specified search query options; otherwise false.

Attributes

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

Creates a new file in the current folder.

public IAsyncOperation<StorageFile> CreateFileAsync(String desiredName)public IAsyncOperation<StorageFile> CreateFileAsync(String desiredName)Public Function CreateFileAsync(desiredName As String) As IAsyncOperation( Of StorageFile )
Parameters
desiredName
System.String System.String System.String

The name of the new file.

Returns

When this method completes successfully, it returns a StorageFile that represents the new file.

Attributes

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.

public IAsyncOperation<StorageFile> CreateFileAsync(String desiredName, CreationCollisionOption options)public IAsyncOperation<StorageFile> CreateFileAsync(String desiredName, CreationCollisionOption options)Public Function CreateFileAsync(desiredName As String, options As CreationCollisionOption) As IAsyncOperation( Of StorageFile )
Parameters
desiredName
System.String System.String System.String

The name of the new file.

options
CreationCollisionOption CreationCollisionOption CreationCollisionOption

A value that indicates what to do if the file name already exists in the current folder.

Returns

When this method completes successfully, it returns a StorageFile that represents the new file.

Attributes

CreateFileQuery() CreateFileQuery() CreateFileQuery()

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

public StorageFileQueryResult CreateFileQuery()public StorageFileQueryResult CreateFileQuery()Public Function CreateFileQuery() As StorageFileQueryResult
Returns

An object for managing the search queries and accessing the results.

Attributes

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.

public StorageFileQueryResult CreateFileQuery(CommonFileQuery query)public StorageFileQueryResult CreateFileQuery(CommonFileQuery query)Public Function CreateFileQuery(query As CommonFileQuery) As StorageFileQueryResult
Parameters
query
CommonFileQuery CommonFileQuery CommonFileQuery

A value that specifies the folder attribute to use to group the search results.

Returns

An object for managing the search queries and accessing the results.

Attributes

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.

public StorageFileQueryResult CreateFileQueryWithOptions(QueryOptions queryOptions)public StorageFileQueryResult CreateFileQueryWithOptions(QueryOptions queryOptions)Public Function CreateFileQueryWithOptions(queryOptions As QueryOptions) As StorageFileQueryResult
Parameters
queryOptions
QueryOptions QueryOptions QueryOptions

The initial query options.

Returns

An object for managing the search queries and accessing the results.

Attributes

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

Creates a new child folder of the current folder.

public IAsyncOperation<StorageFolder> CreateFolderAsync(String desiredName)public IAsyncOperation<StorageFolder> CreateFolderAsync(String desiredName)Public Function CreateFolderAsync(desiredName As String) As IAsyncOperation( Of StorageFolder )
Parameters
desiredName
System.String System.String System.String

The name of the new folder.

Returns

When this method completes successfully, it returns a StorageFolder that represents the new file.

Attributes

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.

public IAsyncOperation<StorageFolder> CreateFolderAsync(String desiredName, CreationCollisionOption options)public IAsyncOperation<StorageFolder> CreateFolderAsync(String desiredName, CreationCollisionOption options)Public Function CreateFolderAsync(desiredName As String, options As CreationCollisionOption) As IAsyncOperation( Of StorageFolder )
Parameters
desiredName
System.String System.String System.String

The name of the new folder.

options
CreationCollisionOption CreationCollisionOption CreationCollisionOption

A value that indicates what to do if the child folder already exists in the current folder.

Returns

When this method completes successfully, it returns a StorageFolder that represents the new file.

Attributes

CreateFolderQuery() CreateFolderQuery() CreateFolderQuery()

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

public StorageFolderQueryResult CreateFolderQuery()public StorageFolderQueryResult CreateFolderQuery()Public Function CreateFolderQuery() As StorageFolderQueryResult
Returns

An object for managing the search queries and accessing the results.

Attributes

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.

public StorageFolderQueryResult CreateFolderQuery(CommonFolderQuery query)public StorageFolderQueryResult CreateFolderQuery(CommonFolderQuery query)Public Function CreateFolderQuery(query As CommonFolderQuery) As StorageFolderQueryResult
Parameters
query
CommonFolderQuery CommonFolderQuery CommonFolderQuery

A value that specifies the folder attribute to use to group the search results.

Returns

An object for managing the search queries and accessing the results.

Attributes

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.

public StorageFolderQueryResult CreateFolderQueryWithOptions(QueryOptions queryOptions)public StorageFolderQueryResult CreateFolderQueryWithOptions(QueryOptions queryOptions)Public Function CreateFolderQueryWithOptions(queryOptions As QueryOptions) As StorageFolderQueryResult
Parameters
queryOptions
QueryOptions QueryOptions QueryOptions

The initial query options.

Returns

An object for managing the search queries and accessing the results.

Attributes

CreateItemQuery() CreateItemQuery() CreateItemQuery()

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

public StorageItemQueryResult CreateItemQuery()public StorageItemQueryResult CreateItemQuery()Public Function CreateItemQuery() As StorageItemQueryResult
Returns

An object for managing the search queries and accessing the results.

Attributes

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.

public StorageItemQueryResult CreateItemQueryWithOptions(QueryOptions queryOptions)public StorageItemQueryResult CreateItemQueryWithOptions(QueryOptions queryOptions)Public Function CreateItemQueryWithOptions(queryOptions As QueryOptions) As StorageItemQueryResult
Parameters
queryOptions
QueryOptions QueryOptions QueryOptions

The initial query options.

Returns

An object for managing the search queries and accessing the results.

Attributes

DeleteAsync() DeleteAsync() DeleteAsync()

Deletes the current folder.

public IAsyncAction DeleteAsync()public IAsyncAction DeleteAsync()Public Function DeleteAsync() As IAsyncAction
Returns

No object or value is returned when this method completes.

Attributes

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

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

public IAsyncAction DeleteAsync(StorageDeleteOption option)public IAsyncAction DeleteAsync(StorageDeleteOption option)Public Function DeleteAsync(option As StorageDeleteOption) As IAsyncAction
Parameters
option
StorageDeleteOption StorageDeleteOption StorageDeleteOption

A value that specifies whether to move the deleted folder to the recycle bin.

Returns

No object or value is returned when this method completes.

Attributes

GetBasicPropertiesAsync() GetBasicPropertiesAsync() GetBasicPropertiesAsync()

Retrieves the basic properties of the StorageFolder object.

public IAsyncOperation<BasicProperties> GetBasicPropertiesAsync()public IAsyncOperation<BasicProperties> GetBasicPropertiesAsync()Public Function GetBasicPropertiesAsync() As IAsyncOperation( Of BasicProperties )
Returns

When this method completes successfully, it returns a BasicProperties object.

Attributes

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

Retrieves a file from the current folder.

public IAsyncOperation<StorageFile> GetFileAsync(String name)public IAsyncOperation<StorageFile> GetFileAsync(String name)Public Function GetFileAsync(name As String) As IAsyncOperation( Of StorageFile )
Parameters
name
System.String System.String System.String

The name of the file to retrieve.

Returns

When this method completes successfully, it returns a StorageFile.

Attributes

GetFilesAsync() GetFilesAsync() GetFilesAsync()

Retrieves all files from the current folder.

public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync()public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync()Public Function GetFilesAsync() As IAsyncOperation( Of IVectorViewStorageFile )
Returns

When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.

Attributes

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

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

public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query)public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query)Public Function GetFilesAsync(query As CommonFileQuery) As IAsyncOperation( Of IVectorViewStorageFile )
Parameters
query
CommonFileQuery CommonFileQuery CommonFileQuery

The common file query.

Returns

When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.

Attributes

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.

public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetFilesAsync(query As CommonFileQuery, startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IVectorViewStorageFile )
Parameters
query
CommonFileQuery CommonFileQuery CommonFileQuery

The common file query.

startIndex
System.UInt32 System.UInt32 System.UInt32

The zero-based index of the first file in the range.

maxItemsToRetrieve
System.UInt32 System.UInt32 System.UInt32

The maximum number of files to retrieve.

Returns

When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.

Attributes

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

Retrieves the specified child folder from the current folder.

public IAsyncOperation<StorageFolder> GetFolderAsync(String name)public IAsyncOperation<StorageFolder> GetFolderAsync(String name)Public Function GetFolderAsync(name As String) As IAsyncOperation( Of StorageFolder )
Parameters
name
System.String System.String System.String

The name of the child folder to retrieve.

Returns

When this method completes successfully, it returns a StorageFolder that represents the specified child folder.

Attributes

GetFoldersAsync() GetFoldersAsync() GetFoldersAsync()

Retrieves all child folders from the current folder.

public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync()public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync()Public Function GetFoldersAsync() As IAsyncOperation( Of IVectorViewStorageFolder )
Returns

When this method completes successfully, it returns the list (type IVectorView ) of child folders. Each child folder in this list is represented by a StorageFolder object.

Attributes

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

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

public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query)public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query)Public Function GetFoldersAsync(query As CommonFolderQuery) As IAsyncOperation( Of IVectorViewStorageFolder )
Parameters
query
CommonFolderQuery CommonFolderQuery CommonFolderQuery

The common folder query.

Returns

When this method completes successfully, it returns the list (type IVectorView ) of child folders. Each child folder in this list is represented by a StorageFolder object.

Attributes

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.

public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetFoldersAsync(query As CommonFolderQuery, startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IVectorViewStorageFolder )
Parameters
query
CommonFolderQuery CommonFolderQuery CommonFolderQuery

The common folder query.

startIndex
System.UInt32 System.UInt32 System.UInt32

The zero-based index of the first child folder in the range.

maxItemsToRetrieve
System.UInt32 System.UInt32 System.UInt32

The maximum number of child folders to retrieve.

Returns

When this method completes successfully, it returns the list (type IVectorView ) of child folders. Each child folder in this list is represented by a StorageFolder object.

Attributes

GetIndexedStateAsync() GetIndexedStateAsync() GetIndexedStateAsync()

Retrieves the indexed state of the folder.

public IAsyncOperation<IndexedState> GetIndexedStateAsync()public IAsyncOperation<IndexedState> GetIndexedStateAsync()Public Function GetIndexedStateAsync() As IAsyncOperation( Of IndexedState )
Returns

When this method completes successfully, it returns an IndexedState enumeration value.

Attributes

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

Retrieves an item from the folder.

public IAsyncOperation<IStorageItem> GetItemAsync(String name)public IAsyncOperation<IStorageItem> GetItemAsync(String name)Public Function GetItemAsync(name As String) As IAsyncOperation( Of IStorageItem )
Parameters
name
System.String System.String System.String

The name of the item to retrieve.

Returns

When this method completes successfully, it returns the item (type IStorageItem ).

Attributes

GetItemsAsync() GetItemsAsync() GetItemsAsync()

Retrieves all items from the current folder.

public IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync()public IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync()Public Function GetItemsAsync() As IAsyncOperation( Of IVectorViewIStorageItem )
Returns

When this method completes successfully, it returns the list (type IVectorView ) of items.

Attributes

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

Retrieves a range of items from the current folder.

public IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)public IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetItemsAsync(startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IVectorViewIStorageItem )
Parameters
startIndex
System.UInt32 System.UInt32 System.UInt32

The zero-based index of the first item in the range.

maxItemsToRetrieve
System.UInt32 System.UInt32 System.UInt32

The maximum number of items to retrieve.

Returns

When this method completes successfully, it returns the list (type IVectorView ) of items.

Attributes

GetParentAsync() GetParentAsync() GetParentAsync()

Gets the parent folder of the current folder.

public IAsyncOperation<StorageFolder> GetParentAsync()public IAsyncOperation<StorageFolder> GetParentAsync()Public Function GetParentAsync() As IAsyncOperation( Of StorageFolder )
Returns

When this method completes, it returns the parent folder as a StorageFolder.

Attributes

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

Retrieves the thumbnail that is associated with the StorageFolder.

public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode)public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode)Public Function GetThumbnailAsync(mode As ThumbnailMode) As IAsyncOperation( Of StorageItemThumbnail )
Parameters
mode
ThumbnailMode ThumbnailMode ThumbnailMode

The thumbnail mode to retrieve.

Returns

When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Attributes

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

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

public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, UInt32 requestedSize)public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, UInt32 requestedSize)Public Function GetThumbnailAsync(mode As ThumbnailMode, requestedSize As UInt32) As IAsyncOperation( Of StorageItemThumbnail )
Parameters
mode
ThumbnailMode ThumbnailMode ThumbnailMode

The thumbnail mode to retrieve.

requestedSize
System.UInt32 System.UInt32 System.UInt32

The requested size in pixels of thumbnail to retrieve.

Returns

When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Attributes

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.

public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, UInt32 requestedSize, ThumbnailOptions options)public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, UInt32 requestedSize, ThumbnailOptions options)Public Function GetThumbnailAsync(mode As ThumbnailMode, requestedSize As UInt32, options As ThumbnailOptions) As IAsyncOperation( Of StorageItemThumbnail )
Parameters
mode
ThumbnailMode ThumbnailMode ThumbnailMode

The thumbnail mode to retrieve.

requestedSize
System.UInt32 System.UInt32 System.UInt32

The requested size in pixels of thumbnail to retrieve.

options
ThumbnailOptions ThumbnailOptions ThumbnailOptions

The thumbnail retrieval options.

Returns

When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Attributes

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

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

public PlatForm::Boolean IsCommonFileQuerySupported(CommonFileQuery query)public bool IsCommonFileQuerySupported(CommonFileQuery query)Public Function IsCommonFileQuerySupported(query As CommonFileQuery) As bool
Parameters
query
CommonFileQuery CommonFileQuery CommonFileQuery

The common file query to test.

Returns
bool bool bool

True if the folder supports the specified common file query; otherwise false.

Attributes

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

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

public PlatForm::Boolean IsCommonFolderQuerySupported(CommonFolderQuery query)public bool IsCommonFolderQuerySupported(CommonFolderQuery query)Public Function IsCommonFolderQuerySupported(query As CommonFolderQuery) As bool
Parameters
query
CommonFolderQuery CommonFolderQuery CommonFolderQuery

The common folder query to test.

Returns
bool bool bool

True if the folder supports the specified common folder query; otherwise false.

Attributes

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

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

public PlatForm::Boolean IsEqual(IStorageItem item)public bool IsEqual(IStorageItem item)Public Function IsEqual(item As IStorageItem) As bool
Parameters
item
IStorageItem IStorageItem IStorageItem

The IStorageItem object that represents the folder to compare against.

Returns
bool bool bool

Returns true if the current folder is equal to the specified folder; otherwise false.

Attributes

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

Determines whether the loaded StorageFolder is the specified type.

public PlatForm::Boolean IsOfType(StorageItemTypes type)public bool IsOfType(StorageItemTypes type)Public Function IsOfType(type As StorageItemTypes) As bool
Parameters
type
StorageItemTypes StorageItemTypes StorageItemTypes

The type of item to check against.

Returns
bool bool bool

True if the loaded StorageFolder is the specified type; otherwise false.

Attributes

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

Renames the StorageFolder.

public IAsyncAction RenameAsync(String desiredName)public IAsyncAction RenameAsync(String desiredName)Public Function RenameAsync(desiredName As String) As IAsyncAction
Parameters
desiredName
System.String System.String System.String

The new name.

Returns

No object or value is returned when this method completes.

Attributes

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.

public IAsyncAction RenameAsync(String desiredName, NameCollisionOption option)public IAsyncAction RenameAsync(String desiredName, NameCollisionOption option)Public Function RenameAsync(desiredName As String, option As NameCollisionOption) As IAsyncAction
Parameters
desiredName
System.String System.String System.String

The new name.

option
NameCollisionOption NameCollisionOption NameCollisionOption

A value that indicates what to do if a folder with desiredName already exists.

Returns

No object or value is returned when this method completes.

Attributes

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.

public IAsyncOperation<IStorageItem> TryGetItemAsync(String name)public IAsyncOperation<IStorageItem> TryGetItemAsync(String name)Public Function TryGetItemAsync(name As String) As IAsyncOperation( Of IStorageItem )
Parameters
name
System.String System.String System.String

The name (or path relative to the current folder) of the file or sub-folder to try to retrieve.

Returns

When this method completes successfully, it returns the file or folder (type IStorageItem ).

Attributes

Events

PropertiesUpdated PropertiesUpdated PropertiesUpdated

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

public event TypedEventHandler PropertiesUpdatedpublic event TypedEventHandler PropertiesUpdatedPublic Event PropertiesUpdated
Attributes

ThumbnailUpdated ThumbnailUpdated ThumbnailUpdated

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

public event TypedEventHandler ThumbnailUpdatedpublic event TypedEventHandler ThumbnailUpdatedPublic Event ThumbnailUpdated
Attributes