ThumbnailMode Enum

  • Reference

Definition

Namespace:
Windows.Storage.FileProperties
Edit

Describes the purpose of the thumbnail to determine how to adjust the thumbnail image to retrieve.

public enum class ThumbnailMode
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class ThumbnailMode
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum ThumbnailMode
var value = Windows.Storage.FileProperties.ThumbnailMode.picturesView
Public Enum ThumbnailMode
Inheritance
Enum
ThumbnailMode
Attributes
ContractVersionAttribute

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
PicturesView 0

To display previews of picture files.

  • Default, preferred size: Medium, preferably at least 190 pixels (if the image size is 190 x 130)
  • Aspect ratio: Uniform, wide aspect ratio of about .7 (190 x 130 if the preferred size is 190)
VideosView 1

To display previews of video files.

  • Default, preferred size: Medium, preferably at least 190 pixels (if the video size is 190 x 130)
  • Aspect ratio: Uniform, wide aspect ratio of about .7 (190 x 130 if the requested size is 190)
MusicView 2

To display previews of music files.

  • Default, preferred size: Small, preferably at least 40 x 40 pixels
  • Aspect ratio: Uniform, square aspect ratio
DocumentsView 3

To display previews of document files.

  • Default, preferred size: Small, preferably at least 40 x 40 pixels
  • Aspect ratio: Uniform, square aspect ratio
ListView 4

To display previews of files (or other items) in a list.

  • Default, preferred size: Small, preferably at least 40 x 40 pixels
  • Aspect ratio: Uniform, square aspect ratio
SingleItem 5

To display a preview of any single item (like a file, folder, or file group).

  • Default, preferred size: Large, at least 256 pixels on the longest side
  • Aspect ratio: Variable, uses the original aspect ratio of the file

Remarks

Windows uses the default, preferred size as a guide to scale the thumbnail image without reducing the quality of the image. It does not guarantee the size of the thumbnail image that is retrieved.

Using thumbnail modes

Use this enumeration to determine the thumbnail image you get when you call one of the getThumbnailAsync methods. These methods return the thumbnail image as a storageItemThumbnail object.

For example, you can get a thumbnail image to preview a video file by calling storageFile.GetThumbnailAsync(ThumbnailMode) and specifying the videoView thumbnail mode.

To help you decide which mode you should use, see Guidelines and checklist for thumbnails.

Applies to

See also