ThumbnailOptions enumeration

Describes the behavior used to retrieve and adjust thumbnails, including the size and quality of the image and how quickly the thumbnail image is retrieved.

Syntax


var value = Windows.Storage.FileProperties.ThumbnailOptions.none;

Attributes

[Flags()]
[Version(0x06020000)]

Members

The ThumbnailOptions enumeration has these members.

MemberValueDescription
None | none0

No options.

ReturnOnlyIfCached | returnOnlyIfCached1

Retrieve a thumbnail only if it is cached or embedded in the file.

ResizeThumbnail | resizeThumbnail2

Scale the thumbnail to the requested size.

UseCurrentScale | useCurrentScale4

Default. Increase requested size based on the Pixels Per Inch (PPI) of the display.

Remarks

This enum is used when you get a thumbnail image by calling one of the getThumbnailAsync method overloads like storageFile.getThumbnailAsync(mode, requestedSize, options). The thumbnail image that is returned is represented by a storageItemThumbnail object.

Requirements (device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

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.FileProperties
Windows::Storage::FileProperties [C++]

Metadata

Windows.winmd

See also

storageItemThumbnail class
ThumbnailMode enum
Windows.Storage.storageFile.getThumbnailAsync(mode, requestedSize, options) method

 

 

Show:
© 2015 Microsoft