DefaultRasterResolution Property

Summary

The default resolution to use when loading raster file formats that do not have a resolution.

Syntax

C++/CLI

Python

public static int DefaultRasterResolution { get; set; }

public:  
   static property Int32 DefaultRasterResolution 
   { 
      Int32 get() 
      void set(Int32 value) 
   }

DefaultRasterResolution # get and set (DocumentFactory)

Property Value

Resolution to use when loading raster file formats that do not have a resolution. The default value is 96.

Remarks

Raster file formats, such as TIFF, JPEG, PNG, and BMP usually have a resolution value stored in the image file itself. Therefore, this property is not used for such files. Instead, the resolution is parsed from the image data and is set in the values described below.

If the raster file does not have a resolution value stored or is set to 0, then the DocumentFactory will use the value of DefaultRasterResolution instead.

DocumentFactory sets this value initially and every time it changes in the CodecsLoadOptions.Resolution value of RasterCodecsTemplate as follows:

DocumentFactory.Options.Load.Resolution = DocumentFactory.DefaultRasterResolution;

Whether the resolution was read from the file or is not found and the default value is picked, the resolution value will then be used by the following:

DocumentPages.DefaultResolution
DocumentPage.Resolution
The resolution (XResolution and YResolution) of the RasterImage returned by DocumentPage.GetImage
The resolution of the SvgDocument returned by DocumentPage.GetSvg
The DocumentViewer uses the resolution to calculate the logical size of the page to view on the screen.

Requirements

Target Platforms

Reference

DocumentFactory Class

DocumentFactory Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies