IsResolutionsSupported Property

Summary

Determines whether this document supports loading images using different resolutions.

Syntax

C++

Java

public virtual bool IsResolutionsSupported {get;}

Public Overridable ReadOnly Property IsResolutionsSupported() As Boolean 
   Get

public:  
   virtual property bool IsResolutionsSupported 
   { 
      bool get() 
   }

public boolean isResolutionsSupported()

Property Value

true if this document supports loading images using different resolutions (DPI); otherwise, false.

Remarks

Use the DocumentPage.GetImage(resolution) method to obtain the raster image version of a page. It accepts a resolution property that can be used to get the image at any resolution, if supported.

Document format types such as Microsoft Word and Adobe Acrobat do not contain a physical pixel size and can be loaded at any resolution value, such as 72, 96, 150, 200, 300, 600, etc. You can use DocumentPage.GetImage(resolution) to load the raster image at any desired value.

Raster format types such as TIFF, PNG, and JPEG have a physical size and can only be loaded at that specific size (of course, you can re-size them later, or change the resolution value if desired using the RasterCodecs object).

IsResolutionsSupported determines whether the current LEADDocument supports loading the image at different resolutions (is a document format type), and will return true for Word or PDF documents and false for TIFF, PNG and JPEG images.

If IsResolutionsSupported is false, then the value of resolution passed to DocumentPage.GetImage(resolution) is ignored.

Note that if this is a virtual document with children, then the value of this property will true if any of the child documents reports true, and will be false if the document has no children or if all the children report false.

Example

For an example, refer to DocumentPage.GetImage(resolution).

Requirements

Target Platforms

Reference

DocumentImages Class

DocumentImages Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3