DefaultDocumentResolution Property

Summary

The default resolution to use when loading document file formats.

Syntax

C++/CLI

Python

public static int DefaultDocumentResolution { get; set; }

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

DefaultDocumentResolution # get and set (DocumentFactory)

Property Value

Resolution to use when loading document file formats. The default value is 300.

Remarks

Document file formats, such as PDF, DOCX, and TXT, do not have a resolution. Therefore, this property is always used when using the document factory to load such files.

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

DocumentFactory.RasterCodecsTemplate.Options.RasterizeDocument.Load.Resolution = DocumentFactory.DefaultDocumentResolution;

This 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.