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, IStorageFolderQueryOperationspublic sealed class FolderInformation : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperationsPublic NotInheritable Class FolderInformation Implements IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations// You can use this class in JavaScript.
- Attributes
| 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
Gets the attributes of a loaded folder.
public : FileAttributes Attributes { get; }public FileAttributes Attributes { get; }Public ReadOnly Property Attributes As FileAttributes// You can use this property in JavaScript.
The folder attributes.
BasicProperties 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// You can use this property in JavaScript.
The basic properties object.
DateCreated 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// You can use this property in JavaScript.
- Value
- DateTime DateTimeOffset DateTimeOffset DateTimeOffset
The folder creation date.
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 DisplayName
Gets the user-friendly name of the StorageFolder.
public : PlatForm::String DisplayName { get; }public string DisplayName { get; }Public ReadOnly Property DisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The user-friendly name of the StorageFolder.
DisplayType 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// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The display type.
DocumentProperties DocumentProperties DocumentProperties DocumentProperties
Gets the document properties of the StorageFolder.
public : DocumentProperties DocumentProperties { get; }public DocumentProperties DocumentProperties { get; }Public ReadOnly Property DocumentProperties As DocumentProperties// You can use this property in JavaScript.
The document properties.
FolderRelativeId 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// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The folder-relative identifier.
ImageProperties ImageProperties ImageProperties ImageProperties
Gets the image properties of the StorageFolder.
public : ImageProperties ImageProperties { get; }public ImageProperties ImageProperties { get; }Public ReadOnly Property ImageProperties As ImageProperties// You can use this property in JavaScript.
The image properties.
MusicProperties 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// You can use this property in JavaScript.
The music properties.
Name Name Name Name
Gets the name of the StorageFolder.
public : PlatForm::String Name { get; }public string Name { get; }Public ReadOnly Property Name As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The StorageFolder name.
Path Path Path Path
Gets the path of the StorageFolder.
public : PlatForm::String Path { get; }public string Path { get; }Public ReadOnly Property Path As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The path.
Properties 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// You can use this property in JavaScript.
- Value
- StorageItemContentProperties StorageItemContentProperties StorageItemContentProperties StorageItemContentProperties
The object for retrieving StorageFolder properties.
Provider 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// You can use this property in JavaScript.
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.
Thumbnail Thumbnail Thumbnail Thumbnail
Gets the thumbnail for the StorageFile.
public : StorageItemThumbnail Thumbnail { get; }public StorageItemThumbnail Thumbnail { get; }Public ReadOnly Property Thumbnail As StorageItemThumbnail// You can use this property in JavaScript.
The thumbnail.
VideoProperties 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// You can use this property in JavaScript.
The video properties.
Methods
AreQueryOptionsSupported(QueryOptions) 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// You can use this method in JavaScript.
- queryOptions
- QueryOptions QueryOptions QueryOptions QueryOptions
The search query options to test.
True if the folder supports the specified search query options; otherwise false.
CreateFileAsync(String) CreateFileAsync(String) CreateFileAsync(String) CreateFileAsync(String)
Creates a new file in the current folder.
public : IAsyncOperation<StorageFile> CreateFileAsync(PlatForm::String desiredName)public IAsyncOperation<StorageFile> CreateFileAsync(String desiredName)Public Function CreateFileAsync(desiredName As String) As IAsyncOperation( Of StorageFile )// You can use this method in JavaScript.
- desiredName
- PlatForm::String String String String
The name of the new file.
When this method completes successfully, it returns a StorageFile that represents the new file.
- See Also
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.
public : IAsyncOperation<StorageFile> CreateFileAsync(PlatForm::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 )// You can use this method in JavaScript.
- desiredName
- PlatForm::String String String String
The name of the new file.
- options
- CreationCollisionOption CreationCollisionOption CreationCollisionOption CreationCollisionOption
A value that indicates what to do if the file name already exists in the current folder.
When this method completes successfully, it returns a StorageFile that represents the new file.
- See Also
CreateFileQuery() 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// You can use this method in JavaScript.
An object for managing the search queries and accessing the results.
- See Also
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.
public : StorageFileQueryResult CreateFileQuery(CommonFileQuery query)public StorageFileQueryResult CreateFileQuery(CommonFileQuery query)Public Function CreateFileQuery(query As CommonFileQuery) As StorageFileQueryResult// You can use this method in JavaScript.
A value that specifies the folder attribute to use to group the search results.
An object for managing the search queries and accessing the results.
- See Also
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.
public : StorageFileQueryResult CreateFileQueryWithOptions(QueryOptions queryOptions)public StorageFileQueryResult CreateFileQueryWithOptions(QueryOptions queryOptions)Public Function CreateFileQueryWithOptions(queryOptions As QueryOptions) As StorageFileQueryResult// You can use this method in JavaScript.
- queryOptions
- QueryOptions QueryOptions QueryOptions QueryOptions
The initial query options.
An object for managing the search queries and accessing the results.
CreateFolderAsync(String) CreateFolderAsync(String) CreateFolderAsync(String) CreateFolderAsync(String)
Creates a new child folder of the current folder.
public : IAsyncOperation<StorageFolder> CreateFolderAsync(PlatForm::String desiredName)public IAsyncOperation<StorageFolder> CreateFolderAsync(String desiredName)Public Function CreateFolderAsync(desiredName As String) As IAsyncOperation( Of StorageFolder )// You can use this method in JavaScript.
- desiredName
- PlatForm::String String String String
The name of the new folder.
When this method completes successfully, it returns a StorageFolder that represents the new file.
- See Also
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.
public : IAsyncOperation<StorageFolder> CreateFolderAsync(PlatForm::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 )// You can use this method in JavaScript.
- desiredName
- PlatForm::String String String String
The name of the new folder.
- options
- CreationCollisionOption CreationCollisionOption CreationCollisionOption CreationCollisionOption
A value that indicates what to do if the child folder already exists in the current folder.
When this method completes successfully, it returns a StorageFolder that represents the new file.
- See Also
CreateFolderQuery() 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// You can use this method in JavaScript.
An object for managing the search queries and accessing the results.
- See Also
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.
public : StorageFolderQueryResult CreateFolderQuery(CommonFolderQuery query)public StorageFolderQueryResult CreateFolderQuery(CommonFolderQuery query)Public Function CreateFolderQuery(query As CommonFolderQuery) As StorageFolderQueryResult// You can use this method in JavaScript.
A value that specifies the folder attribute to use to group the search results.
An object for managing the search queries and accessing the results.
- See Also
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.
public : StorageFolderQueryResult CreateFolderQueryWithOptions(QueryOptions queryOptions)public StorageFolderQueryResult CreateFolderQueryWithOptions(QueryOptions queryOptions)Public Function CreateFolderQueryWithOptions(queryOptions As QueryOptions) As StorageFolderQueryResult// You can use this method in JavaScript.
- queryOptions
- QueryOptions QueryOptions QueryOptions QueryOptions
The initial query options.
An object for managing the search queries and accessing the results.
CreateItemQuery() 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// You can use this method in JavaScript.
An object for managing the search queries and accessing the results.
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.
public : StorageItemQueryResult CreateItemQueryWithOptions(QueryOptions queryOptions)public StorageItemQueryResult CreateItemQueryWithOptions(QueryOptions queryOptions)Public Function CreateItemQueryWithOptions(queryOptions As QueryOptions) As StorageItemQueryResult// You can use this method in JavaScript.
- queryOptions
- QueryOptions QueryOptions QueryOptions QueryOptions
The initial query options.
An object for managing the search queries and accessing the results.
DeleteAsync() DeleteAsync() DeleteAsync() DeleteAsync()
Deletes the current folder.
public : IAsyncAction DeleteAsync()public IAsyncAction DeleteAsync()Public Function DeleteAsync() As IAsyncAction// You can use this method in JavaScript.
No object or value is returned when this method completes.
- See Also
DeleteAsync(StorageDeleteOption) 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// You can use this method in JavaScript.
A value that specifies whether to move the deleted folder to the recycle bin.
No object or value is returned when this method completes.
- See Also
GetBasicPropertiesAsync() 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 )// You can use this method in JavaScript.
When this method completes successfully, it returns a BasicProperties object.
- See Also
GetFileAsync(String) GetFileAsync(String) GetFileAsync(String) GetFileAsync(String)
Retrieves a file from the current folder.
public : IAsyncOperation<StorageFile> GetFileAsync(PlatForm::String name)public IAsyncOperation<StorageFile> GetFileAsync(String name)Public Function GetFileAsync(name As String) As IAsyncOperation( Of StorageFile )// You can use this method in JavaScript.
- name
- PlatForm::String String String String
The name of the file to retrieve.
When this method completes successfully, it returns a StorageFile.
GetFilesAsync() GetFilesAsync() GetFilesAsync() GetFilesAsync()
Retrieves all files from the current folder.
public : IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync()public IAsyncOperation<IReadOnlyList<StorageFile>> GetFilesAsync()Public Function GetFilesAsync() As IAsyncOperation( Of IReadOnlyListStorageFile )// You can use this method in JavaScript.
When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.
GetFilesAsync(CommonFileQuery) 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<IReadOnlyList<StorageFile>> GetFilesAsync(CommonFileQuery query)Public Function GetFilesAsync(query As CommonFileQuery) As IAsyncOperation( Of IReadOnlyListStorageFile )// You can use this method in JavaScript.
The common file query.
When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.
- See Also
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.
public : IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query, unsigned int startIndex, unsigned int maxItemsToRetrieve)public IAsyncOperation<IReadOnlyList<StorageFile>> GetFilesAsync(CommonFileQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetFilesAsync(query As CommonFileQuery, startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IReadOnlyListStorageFile )// You can use this method in JavaScript.
The common file query.
- startIndex
- unsigned int UInt32 UInt32 UInt32
The zero-based index of the first file in the range.
- maxItemsToRetrieve
- unsigned int UInt32 UInt32 UInt32
The maximum number of files to retrieve.
When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.
- See Also
GetFolderAsync(String) GetFolderAsync(String) GetFolderAsync(String) GetFolderAsync(String)
Retrieves the specified child folder from the current folder.
public : IAsyncOperation<StorageFolder> GetFolderAsync(PlatForm::String name)public IAsyncOperation<StorageFolder> GetFolderAsync(String name)Public Function GetFolderAsync(name As String) As IAsyncOperation( Of StorageFolder )// You can use this method in JavaScript.
- name
- PlatForm::String String String String
The name of the child folder to retrieve.
When this method completes successfully, it returns a StorageFolder that represents the specified child folder.
GetFoldersAsync() GetFoldersAsync() GetFoldersAsync() GetFoldersAsync()
Retrieves all child folders from the current folder.
public : IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync()public IAsyncOperation<IReadOnlyList<StorageFolder>> GetFoldersAsync()Public Function GetFoldersAsync() As IAsyncOperation( Of IReadOnlyListStorageFolder )// You can use this method in JavaScript.
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.
GetFoldersAsync(CommonFolderQuery) 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<IReadOnlyList<StorageFolder>> GetFoldersAsync(CommonFolderQuery query)Public Function GetFoldersAsync(query As CommonFolderQuery) As IAsyncOperation( Of IReadOnlyListStorageFolder )// You can use this method in JavaScript.
The common folder query.
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.
- See Also
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.
public : IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query, unsigned int startIndex, unsigned int maxItemsToRetrieve)public IAsyncOperation<IReadOnlyList<StorageFolder>> GetFoldersAsync(CommonFolderQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetFoldersAsync(query As CommonFolderQuery, startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IReadOnlyListStorageFolder )// You can use this method in JavaScript.
The common folder query.
- startIndex
- unsigned int UInt32 UInt32 UInt32
The zero-based index of the first child folder in the range.
- maxItemsToRetrieve
- unsigned int UInt32 UInt32 UInt32
The maximum number of child folders to retrieve.
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.
- See Also
GetIndexedStateAsync() 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 )// You can use this method in JavaScript.
When this method completes successfully, it returns an IndexedState enumeration value.
GetItemAsync(String) GetItemAsync(String) GetItemAsync(String) GetItemAsync(String)
Retrieves an item from the folder.
public : IAsyncOperation<IStorageItem> GetItemAsync(PlatForm::String name)public IAsyncOperation<IStorageItem> GetItemAsync(String name)Public Function GetItemAsync(name As String) As IAsyncOperation( Of IStorageItem )// You can use this method in JavaScript.
- name
- PlatForm::String String String String
The name of the item to retrieve.
When this method completes successfully, it returns the item (type IStorageItem ).
GetItemsAsync() GetItemsAsync() GetItemsAsync() GetItemsAsync()
Retrieves all items from the current folder.
public : IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync()public IAsyncOperation<IReadOnlyList<IStorageItem>> GetItemsAsync()Public Function GetItemsAsync() As IAsyncOperation( Of IReadOnlyListIStorageItem )// You can use this method in JavaScript.
When this method completes successfully, it returns the list (type IVectorView ) of items.
- See Also
GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32)
Retrieves a range of items from the current folder.
public : IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync(unsigned int startIndex, unsigned int maxItemsToRetrieve)public IAsyncOperation<IReadOnlyList<IStorageItem>> GetItemsAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetItemsAsync(startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IReadOnlyListIStorageItem )// You can use this method in JavaScript.
- startIndex
- unsigned int UInt32 UInt32 UInt32
The zero-based index of the first item in the range.
- maxItemsToRetrieve
- unsigned int UInt32 UInt32 UInt32
The maximum number of items to retrieve.
When this method completes successfully, it returns the list (type IVectorView ) of items.
- See Also
GetParentAsync() 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 )// You can use this method in JavaScript.
When this method completes, it returns the parent folder as a StorageFolder.
GetThumbnailAsync(ThumbnailMode) 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 )// You can use this method in JavaScript.
The thumbnail mode to retrieve.
When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.
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.
public : IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, unsigned int requestedSize)public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, UInt32 requestedSize)Public Function GetThumbnailAsync(mode As ThumbnailMode, requestedSize As UInt32) As IAsyncOperation( Of StorageItemThumbnail )// You can use this method in JavaScript.
The thumbnail mode to retrieve.
- requestedSize
- unsigned int UInt32 UInt32 UInt32
The requested size in pixels of thumbnail to retrieve.
When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.
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.
public : IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, unsigned int 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 )// You can use this method in JavaScript.
The thumbnail mode to retrieve.
- requestedSize
- unsigned int UInt32 UInt32 UInt32
The requested size in pixels of thumbnail to retrieve.
The thumbnail retrieval options.
When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.
- See Also
IsCommonFileQuerySupported(CommonFileQuery) 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// You can use this method in JavaScript.
The common file query to test.
True if the folder supports the specified common file query; otherwise false.
IsCommonFolderQuerySupported(CommonFolderQuery) 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// You can use this method in JavaScript.
The common folder query to test.
True if the folder supports the specified common folder query; otherwise false.
IsEqual(IStorageItem) 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// You can use this method in JavaScript.
The IStorageItem object that represents the folder to compare against.
Returns true if the current folder is equal to the specified folder; otherwise false.
IsOfType(StorageItemTypes) 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// You can use this method in JavaScript.
The type of item to check against.
True if the loaded StorageFolder is the specified type; otherwise false.
RenameAsync(String) RenameAsync(String) RenameAsync(String) RenameAsync(String)
Renames the StorageFolder.
public : IAsyncAction RenameAsync(PlatForm::String desiredName)public IAsyncAction RenameAsync(String desiredName)Public Function RenameAsync(desiredName As String) As IAsyncAction// You can use this method in JavaScript.
- desiredName
- PlatForm::String String String String
The new name.
No object or value is returned when this method completes.
- See Also
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.
public : IAsyncAction RenameAsync(PlatForm::String desiredName, NameCollisionOption option)public IAsyncAction RenameAsync(String desiredName, NameCollisionOption option)Public Function RenameAsync(desiredName As String, option As NameCollisionOption) As IAsyncAction// You can use this method in JavaScript.
- desiredName
- PlatForm::String String String String
The new name.
A value that indicates what to do if a folder with desiredName already exists.
No object or value is returned when this method completes.
- See Also
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.
public : IAsyncOperation<IStorageItem> TryGetItemAsync(PlatForm::String name)public IAsyncOperation<IStorageItem> TryGetItemAsync(String name)Public Function TryGetItemAsync(name As String) As IAsyncOperation( Of IStorageItem )// You can use this method in JavaScript.
- name
- PlatForm::String String String String
The name (or path relative to the current folder) of the file or sub-folder to try to retrieve.
When this method completes successfully, it returns the file or folder (type IStorageItem ).
Events
PropertiesUpdated PropertiesUpdated PropertiesUpdated PropertiesUpdated
Occurs when one or more of the StorageFolder 's properties is updated.
public : event TypedEventHandler PropertiesUpdated<IStorageItemInformation, object>public event TypedEventHandler PropertiesUpdated<IStorageItemInformation, object>Public Event PropertiesUpdated<IStorageItemInformation, object>// You can use this event in JavaScript.
ThumbnailUpdated ThumbnailUpdated ThumbnailUpdated ThumbnailUpdated
Fires when the StorageFolder 's thumbnail is updated or a better quality thumbnail is available.
public : event TypedEventHandler ThumbnailUpdated<IStorageItemInformation, object>public event TypedEventHandler ThumbnailUpdated<IStorageItemInformation, object>Public Event ThumbnailUpdated<IStorageItemInformation, object>// You can use this event in JavaScript.