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.

IStorageItemProperties.GetThumbnailAsync(ThumbnailMode) method

Applies to Windows and Windows Phone

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

Syntax


IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(
  ThumbnailMode mode
)

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.

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

 

 

Show:
© 2014 Microsoft