ThumbnailOptions Enum

Definition

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.

This enumeration supports a bitwise combination of its member values.

public enum class ThumbnailOptions
/// [System.Flags]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class ThumbnailOptions
[System.Flags]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum ThumbnailOptions
var value = Windows.Storage.FileProperties.ThumbnailOptions.none
Public Enum ThumbnailOptions
Inheritance
ThumbnailOptions
Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Fields

Name Value Description
None 0

No options.

ReturnOnlyIfCached 1

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

ResizeThumbnail 2

Scale the thumbnail to the requested size.

UseCurrentScale 4

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

Remarks

This enumeration 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.

Applies to

See also