Windows Dev Center

StorageFile.GetScaledImageAsThumbnailAsync(ThumbnailMode) | getScaledImageAsThumbnailAsync(ThumbnailMode) method

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail.

Syntax


storageFile.getScaledImageAsThumbnailAsync(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 item.

Requirements (Windows 10 device family)

Device family

Universal

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

Minimum supported server

Windows Server 2012 R2

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

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

Metadata

Windows.winmd

See also

StorageFile
GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32)
GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

 

 

Show:
© 2015 Microsoft