StorageFolder.GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) | getThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) method

Applies to Windows and Windows Phone

Gets an adjusted thumbnail image for the current folder, determined by the specified purpose of the thumbnail, the requested size, and the specified options.

Syntax


storageFolder.getThumbnailAsync(mode, requestedSize, options).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.

options

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 folder or file group.

Remarks

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

  • Applies to Windows Phone

The StorageFolder.GetThumbnailAsync method sometimes returns the default image of a folder. On Windows Phone, this method ignores the current theme when it returns this default image. The image returned is always the image for the dark theme; that is, the folder is transparent with a white border. If you want to return the image for the light theme, you have to create your own image that's visible on a light background. Then you have to use conditional logic to check the active theme. If the active theme is the light theme, use a method other than GetThumbnailAsync to retrieve your custom image.

Requirements

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

StorageFolder
GetThumbnailAsync(ThumbnailMode)
GetThumbnailAsync(ThumbnailMode, UInt32)

 

 

Show:
© 2014 Microsoft