Class ShellThumbnail

Namespace

Microsoft.WindowsAPICodePack.Shell

Assembly

Microsoft.WindowsAPICodePack.Shell.dll

Represents a thumbnail or an icon for a ShellObject.

public class ShellThumbnail

Inheritance

object

ShellThumbnail

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

AllowBiggerSize

Gets or sets a value that determines if the user can manually stretch the returned image. The default value is false.

public bool AllowBiggerSize { get; set; }

Property Value

bool

Remarks

For example, if the caller passes in 80x80 a 96x96 thumbnail could be returned. This could be used as a performance optimization if the caller will need to stretch the image themselves anyway. Note that the Shell implementation performs a GDI stretch blit. If the caller wants a higher quality image stretch, they should pass this flag and do it themselves.

Bitmap

Gets the thumbnail or icon image in System.Drawing.Bitmap format. Null is returned if the ShellObject does not have a thumbnail or icon image.

public Bitmap Bitmap { get; }

Property Value

Bitmap

BitmapSource

Gets the thumbnail or icon image in System.Windows.Media.Imaging.BitmapSource format. Null is returned if the ShellObject does not have a thumbnail or icon image.

public BitmapSource BitmapSource { get; }

Property Value

BitmapSource

CurrentSize

Gets or sets the default size of the thumbnail or icon. The default is 32x32 pixels for icons and 256x256 pixels for thumbnails.

public Size CurrentSize { get; set; }

Property Value

Size

Remarks

If the size specified is larger than the maximum size of 1024x1024 for thumbnails and 256x256 for icons, an ArgumentOutOfRangeException is thrown.

ExtraLargeBitmap

Gets the thumbnail or icon in extra large size and System.Drawing.Bitmap format.

public Bitmap ExtraLargeBitmap { get; }

Property Value

Bitmap

ExtraLargeBitmapSource

Gets the thumbnail or icon in Extra Large size and System.Windows.Media.Imaging.BitmapSource format.

public BitmapSource ExtraLargeBitmapSource { get; }

Property Value

BitmapSource

ExtraLargeIcon

Gets the thumbnail or icon in Extra Large size and System.Drawing.Icon format.

public Icon ExtraLargeIcon { get; }

Property Value

Icon

FormatOption

Gets or sets a value that determines if the current format option is thumbnail or icon, thumbnail only, or icon only. The default is thumbnail or icon.

public ShellThumbnailFormatOption FormatOption { get; set; }

Property Value

ShellThumbnailFormatOption

Icon

Gets the thumbnail or icon image in System.Drawing.Icon format. Null is returned if the ShellObject does not have a thumbnail or icon image.

public Icon Icon { get; }

Property Value

Icon

LargeBitmap

Gets the thumbnail or icon in large size and System.Drawing.Bitmap format.

public Bitmap LargeBitmap { get; }

Property Value

Bitmap

LargeBitmapSource

Gets the thumbnail or icon in large size and System.Windows.Media.Imaging.BitmapSource format.

public BitmapSource LargeBitmapSource { get; }

Property Value

BitmapSource

LargeIcon

Gets the thumbnail or icon in Large size and System.Drawing.Icon format.

public Icon LargeIcon { get; }

Property Value

Icon

MediumBitmap

Gets the thumbnail or icon in Medium size and System.Drawing.Bitmap format.

public Bitmap MediumBitmap { get; }

Property Value

Bitmap

MediumBitmapSource

Gets the thumbnail or icon in medium size and System.Windows.Media.Imaging.BitmapSource format.

public BitmapSource MediumBitmapSource { get; }

Property Value

BitmapSource

MediumIcon

Gets the thumbnail or icon in Medium size and System.Drawing.Icon format.

public Icon MediumIcon { get; }

Property Value

Icon

RetrievalOption

Gets or sets a value that determines if the current retrieval option is cache or extract, cache only, or from memory only. The default is cache or extract.

public ShellThumbnailRetrievalOption RetrievalOption { get; set; }

Property Value

ShellThumbnailRetrievalOption

SmallBitmap

Gets the thumbnail or icon in small size and System.Drawing.Bitmap format.

public Bitmap SmallBitmap { get; }

Property Value

Bitmap

SmallBitmapSource

Gets the thumbnail or icon in small size and System.Windows.Media.Imaging.BitmapSource format.

public BitmapSource SmallBitmapSource { get; }

Property Value

BitmapSource

SmallIcon

Gets the thumbnail or icon in small size and System.Drawing.Icon format.

public Icon SmallIcon { get; }

Property Value

Icon