IStorageItemProperties.GetThumbnailAsync(ThumbnailMode, UInt32) method

Applies to Windows and Windows Phone

Retrieves an adjusted thumbnail image for the item, determined by the purpose of the thumbnail and the requested size.

Syntax


IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(
  ThumbnailMode mode, 
  uint requestedSize
)

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

Remarks

In Windows 8, the GetThumbnailAsync method has just one immersive monitor at a time that can show the Windows Store app user interface. In Windows 8.1, the Windows Store app user interface can appear on multiple monitors, with the option to show a single app on multiple monitors simultaneously. For scaling, consider multiple scale factors at once.

In Windows 8.1, the GetThumbnailAsync method can return any size thumbnail. Therefore, apps that display local pictures should call this method to get the scaled image they want to display. This ensures that apps benefit from all cache and performance optimizations, including a special mechanism to obtain thumbnails from the cloud without downloading the full file.

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

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

IStorageItemProperties
GetThumbnailAsync(ThumbnailMode)
GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

 

 

Show:
© 2014 Microsoft