GetThumbnailAsync(ThumbnailMode) | getThumbnailAsync(ThumbnailMode) method

StorageFile.GetThumbnailAsync(ThumbnailMode) | getThumbnailAsync(ThumbnailMode) method

Retrieves an adjusted thumbnail image for the file, determined by the purpose of the thumbnail.

Syntax


storageFile.getThumbnailAsync(mode).done( /* Your success and error handlers */ );

Parameters

mode

Type: ThumbnailMode

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted.

For guidance about choosing the best thumbnail mode, see Guidelines and checklist for thumbnails.

Return value

Type: IAsyncOperation<StorageItemThumbnail>

When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or null if there is no thumbnail image associated with the file.

Remarks

For guidance about choosing the best thumbnail mode, see Guidelines and checklist for thumbnails.

Note  In Windows Phone Store apps, the StorageFile.GetThumbnailAsync method returns the default icon for a music file instead of the expected icon. This happens when you call the StorageFile.GetThumbnailAsync method with a ThumbnailMode value of MusicView.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Storage
Windows::Storage [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Storage
Windows::Storage [C++]

Metadata

Windows.winmd

See also

Reference
GetThumbnailAsync(ThumbnailMode, UInt32)
GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)
StorageFile
ThumbnailMode

 

 

Show:
© 2016 Microsoft