FileInformationFactory FileInformationFactory FileInformationFactory FileInformationFactory Class

Used to load information about files and folders from the results of a query and to bind these file system items to JavaScript ListView or XAML ListView and GridView controls. After information is loaded, an app can then access that information quickly using synchronous operations.

Syntax

Declaration

public sealed class FileInformationFactorypublic sealed class FileInformationFactoryPublic NotInheritable Class FileInformationFactorypublic sealed class FileInformationFactory

Constructors summary

Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result.

Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result and that specifies the requested size for thumbnails that are retrieved for the objects.

Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result, and that specifies the requested size and options for thumbnails that are retrieved for the objects.

Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result, specifies the requested size and options for thumbnails that are retrieved for the objects, and indicates whether to delay loading information.

Methods summary

Retrieves a collection of FileInformation objects that contain information about all StorageFile objects in a collection.

Retrieves a collection of FileInformation objects that contain information about a range of StorageFile objects in a collection.

Retrieves a collection of FolderInformation objects that contain information about all StorageFolder objects in a collection.

Retrieves a collection of FolderInformation objects that contain information about a range of StorageFolder objects in a collection.

Retrieves a collection of FileInformation objects that contain information about all the items in the collection.

Retrieves a collection of FileInformation objects that contain information about a range of items in a collection.

Gets a virtualized vector of IStorageItemInformation objects that can be bound to ListView or GridView controls in C#, C++, and VB.

Gets a virtualized vector of IStorageItemInformation objects that can be bound to ListView or GridView controls in C#, C++, and VB.

Gets a virtualized vector of IStorageItemInformation objects that can be bound to ListView or GridView controls in C#, C++, and VB.

Constructors

  • FileInformationFactory(IStorageQueryResultBase, ThumbnailMode)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode)

    Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result.

    public FileInformationFactory(IStorageQueryResultBase queryResult, ThumbnailMode mode)public New(IStorageQueryResultBase queryResult, ThumbnailMode mode)Public Sub New(queryResult As IStorageQueryResultBase, mode As ThumbnailMode)public FileInformationFactory(IStorageQueryResultBase queryResult, ThumbnailMode mode)

    Parameters

    Remarks

    If the query specified SetThumbnailPrefetch(ThumbnailMode, UInt32, ThumbnailOptions) options, those options are overridden by options requested in any of the @Windows.Storage.BulkAccess.FileInformationFactory.#ctor(Windows.Storage.Search.IStorageQueryResultBase,Windows.Storage.FileProperties.ThumbnailMode) constructors.

  • FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32)

    Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result and that specifies the requested size for thumbnails that are retrieved for the objects.

    public FileInformationFactory(IStorageQueryResultBase queryResult, ThumbnailMode mode, UInt32 requestedThumbnailSize)public New(IStorageQueryResultBase queryResult, ThumbnailMode mode, UInt32 requestedThumbnailSize)Public Sub New(queryResult As IStorageQueryResultBase, mode As ThumbnailMode, requestedThumbnailSize As UInt32)public FileInformationFactory(IStorageQueryResultBase queryResult, ThumbnailMode mode, UInt32 requestedThumbnailSize)

    Parameters

  • FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32, ThumbnailOptions)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32, ThumbnailOptions)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32, ThumbnailOptions)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32, ThumbnailOptions)

    Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result, and that specifies the requested size and options for thumbnails that are retrieved for the objects.

    public FileInformationFactory(IStorageQueryResultBase queryResult, ThumbnailMode mode, UInt32 requestedThumbnailSize, ThumbnailOptions thumbnailOptions)public New(IStorageQueryResultBase queryResult, ThumbnailMode mode, UInt32 requestedThumbnailSize, ThumbnailOptions thumbnailOptions)Public Sub New(queryResult As IStorageQueryResultBase, mode As ThumbnailMode, requestedThumbnailSize As UInt32, thumbnailOptions As ThumbnailOptions)public FileInformationFactory(IStorageQueryResultBase queryResult, ThumbnailMode mode, UInt32 requestedThumbnailSize, ThumbnailOptions thumbnailOptions)

    Parameters

  • FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32, ThumbnailOptions, Boolean)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32, ThumbnailOptions, Boolean)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32, ThumbnailOptions, Boolean)
    FileInformationFactory(IStorageQueryResultBase, ThumbnailMode, UInt32, ThumbnailOptions, Boolean)

    Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result, specifies the requested size and options for thumbnails that are retrieved for the objects, and indicates whether to delay loading information.

    public FileInformationFactory(IStorageQueryResultBase queryResult, ThumbnailMode mode, UInt32 requestedThumbnailSize, ThumbnailOptions thumbnailOptions, Boolean delayLoad)public New(IStorageQueryResultBase queryResult, ThumbnailMode mode, UInt32 requestedThumbnailSize, ThumbnailOptions thumbnailOptions, Boolean delayLoad)Public Sub New(queryResult As IStorageQueryResultBase, mode As ThumbnailMode, requestedThumbnailSize As UInt32, thumbnailOptions As ThumbnailOptions, delayLoad As Boolean)public FileInformationFactory(IStorageQueryResultBase queryResult, ThumbnailMode mode, UInt32 requestedThumbnailSize, ThumbnailOptions thumbnailOptions, Boolean delayLoad)

    Parameters

Methods

  • GetFilesAsync()
    GetFilesAsync()
    GetFilesAsync()
    GetFilesAsync()

    Retrieves a collection of FileInformation objects that contain information about all StorageFile objects in a collection.

    public IAsyncOperation<IVectorView<FileInformation>> GetFilesAsync()public IAsyncOperation<IVectorView<FileInformation>> GetFilesAsync()Public Function GetFilesAsync() As IAsyncOperation( Of IVectorViewFileInformation )public IAsyncOperation<IVectorView<FileInformation>> GetFilesAsync()

    Returns

  • GetFilesAsync(UInt32, UInt32)
    GetFilesAsync(UInt32, UInt32)
    GetFilesAsync(UInt32, UInt32)
    GetFilesAsync(UInt32, UInt32)

    Retrieves a collection of FileInformation objects that contain information about a range of StorageFile objects in a collection.

    public IAsyncOperation<IVectorView<FileInformation>> GetFilesAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)public IAsyncOperation<IVectorView<FileInformation>> GetFilesAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetFilesAsync(startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IVectorViewFileInformation )public IAsyncOperation<IVectorView<FileInformation>> GetFilesAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)

    Parameters

    • startIndex
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

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

    • maxItemsToRetrieve
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The maximum number of StorageFile objects to retrieve information for.

    Returns

  • GetFoldersAsync()
    GetFoldersAsync()
    GetFoldersAsync()
    GetFoldersAsync()

    Retrieves a collection of FolderInformation objects that contain information about all StorageFolder objects in a collection.

    public IAsyncOperation<IVectorView<FolderInformation>> GetFoldersAsync()public IAsyncOperation<IVectorView<FolderInformation>> GetFoldersAsync()Public Function GetFoldersAsync() As IAsyncOperation( Of IVectorViewFolderInformation )public IAsyncOperation<IVectorView<FolderInformation>> GetFoldersAsync()

    Returns

  • GetFoldersAsync(UInt32, UInt32)
    GetFoldersAsync(UInt32, UInt32)
    GetFoldersAsync(UInt32, UInt32)
    GetFoldersAsync(UInt32, UInt32)

    Retrieves a collection of FolderInformation objects that contain information about a range of StorageFolder objects in a collection.

    public IAsyncOperation<IVectorView<FolderInformation>> GetFoldersAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)public IAsyncOperation<IVectorView<FolderInformation>> GetFoldersAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetFoldersAsync(startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IVectorViewFolderInformation )public IAsyncOperation<IVectorView<FolderInformation>> GetFoldersAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)

    Parameters

    • startIndex
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

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

    • maxItemsToRetrieve
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The maximum number of StorageFolder objects to retrieve information for.

    Returns

  • GetItemsAsync()
    GetItemsAsync()
    GetItemsAsync()
    GetItemsAsync()

    Retrieves a collection of FileInformation objects that contain information about all the items in the collection.

    public IAsyncOperation<IVectorView<IStorageItemInformation>> GetItemsAsync()public IAsyncOperation<IVectorView<IStorageItemInformation>> GetItemsAsync()Public Function GetItemsAsync() As IAsyncOperation( Of IVectorViewIStorageItemInformation )public IAsyncOperation<IVectorView<IStorageItemInformation>> GetItemsAsync()

    Returns

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

    Retrieves a collection of FileInformation objects that contain information about a range of items in a collection.

    public IAsyncOperation<IVectorView<IStorageItemInformation>> GetItemsAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)public IAsyncOperation<IVectorView<IStorageItemInformation>> GetItemsAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetItemsAsync(startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IVectorViewIStorageItemInformation )public IAsyncOperation<IVectorView<IStorageItemInformation>> GetItemsAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)

    Parameters

    • startIndex
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

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

    • maxItemsToRetrieve
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The maximum number of items to retrieve information for.

    Returns

  • GetVirtualizedFilesVector()
    GetVirtualizedFilesVector()
    GetVirtualizedFilesVector()
    GetVirtualizedFilesVector()

    Gets a virtualized vector of IStorageItemInformation objects that can be bound to ListView or GridView controls in C#, C++, and VB.

    public object GetVirtualizedFilesVector()public object GetVirtualizedFilesVector()Public Function GetVirtualizedFilesVector() As objectpublic object GetVirtualizedFilesVector()

    Returns

    Remarks

    A virtualized vector can return null for some items before it populates their value.

  • GetVirtualizedFoldersVector()
    GetVirtualizedFoldersVector()
    GetVirtualizedFoldersVector()
    GetVirtualizedFoldersVector()

    Gets a virtualized vector of IStorageItemInformation objects that can be bound to ListView or GridView controls in C#, C++, and VB.

    public object GetVirtualizedFoldersVector()public object GetVirtualizedFoldersVector()Public Function GetVirtualizedFoldersVector() As objectpublic object GetVirtualizedFoldersVector()

    Returns

  • GetVirtualizedItemsVector()
    GetVirtualizedItemsVector()
    GetVirtualizedItemsVector()
    GetVirtualizedItemsVector()

    Gets a virtualized vector of IStorageItemInformation objects that can be bound to ListView or GridView controls in C#, C++, and VB.

    public object GetVirtualizedItemsVector()public object GetVirtualizedItemsVector()Public Function GetVirtualizedItemsVector() As objectpublic object GetVirtualizedItemsVector()

    Returns

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.Storage.BulkAccess.dll