DefaultResolution Property

C#
Visual Basic
Objective-C
Java
C++

public double DefaultResolution {get; set;}

'Declaration

Public Property DefaultResolution As Double

'Usage

Dim instance As DocumentPages
Dim value As Double
 
instance.DefaultResolution = value
 
value = instance.DefaultResolution

public double getDefaultResolution()
public void setDefaultResolution(double value)

public:
property double DefaultResolution {
   double get();
   void set (    double value);
}

Property Value

The default resolution in dots per inch (DPI) of this document. Default value depends on how this document was created. This value cannot be less than 0.

DocumentPage.SetImage can be called to set a new raster image for the page. The page Size and Resolution will be updated from the image parameter passed. If the image passed was null, then the document uses the values of DefaultPageSize and DefaultResolution as the new Size and Resolution respectively.

DefaultResolution is also used by the methods used to convert between document units and pixels, refer to Documents Library Coordinate System for more information.

The initial values of DefaultPageSize and DefaultResolution is as follows:

If this Document was originally created from an existing document file or URL using DocumentFactory.LoadFromFile, DocumentFactory.LoadFromUri, DocumentFactory.LoadFromUriAsync or DocumentFactory.LoadFromStream, then the values are updating based on the original document. The internal parsing code will usually use the size and resolution of the first page found in the document.
If this Document was created using DocumentFactory.Create, then the values are uninitialized (DefaultPageSize is 0,0 and DefaultResolution is 0) and the user must update them to the desired values after the document is created.

For an example, refer to DefaultPageSize.

Target Platforms

Reference

DocumentPages Class
DocumentPages Members