StorageFolder.GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) | getScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) method

Applies to Windows and Windows Phone

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail, the requested size, and the specified options


storageFolder.getScaledImageAsThumbnailAsync(mode, requestedSize, options).done( /* Your success and error handlers */ );



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.


Type: Number [JavaScript] | System.UInt32 [.NET] | uint32 [C++]

The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the requestedSize as a guide and tries to scale the thumbnail image without reducing the quality of the image.

If Windows can't find a thumbnail image that it can scale to meet the requested size, a larger thumbnail might be returned. If no larger thumbnail is available, a thumbnail image that is smaller than the requested size might be returned.


Type: ThumbnailOptions

The enum value that describes the desired behavior to use to retrieve the thumbnail image. The specified behavior might affect the size and/or quality of the image and how quickly the thumbnail image is retrieved.

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 item.


Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]


Windows::Storage [C++]



See also

GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32)



© 2014 Microsoft. All rights reserved.