Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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

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

Syntax


storageFile.getScaledImageAsThumbnailAsync(mode, requestedSize).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.

requestedSize

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.

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 (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 (operating system)

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)
GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

 

 

Show:
© 2015 Microsoft