ThumbnailPixelSize Property

Summary

Size to use when getting the thumbnail image of a page.

Syntax

C++

Java

public LeadSize ThumbnailPixelSize { get; set; }

Public Property ThumbnailPixelSize() As LeadSize 
   Get 
   Set

public:  
   property LeadSize^ ThumbnailPixelSize 
   { 
      LeadSize^ get() 
      void set(LeadSize^ value) 
   }

public LeadSize getThumbnailPixelSize() 
public void setThumbnailPixelSize(LeadSize value)

Property Value

The size to use in pixels when getting the thumbnail image of a page. Default value is 128 by 128 pixels.

Remarks

ThumbnailPixelSize is used by DocumentPage.GetThumbnailImage to calculate the size of the raster image returned as a thumbnail of the page.

The actual size is calculated to be the maximum value that fits inside ThumbnailPixelSize while keeping the aspect ratio, for example, if ThumbnailPixelSize is 128 by 128 and the page size is 2000 by 1000 pixels then the returned thumbnail image size is 128 by 64 pixels.

Note that setting this property to a value will update the same value in each child document.

Example

For an example, refer to DocumentPage.GetThumbnailImage

Requirements

Target Platforms