Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
YResolution Property
See Also 
Leadtools.Codecs Namespace > CodecsRasterizeDocumentLoadOptions Class : YResolution Property



Gets or sets the vertical resolution to use when rasterization document files.

Syntax

Visual Basic (Declaration) 
Public Property YResolution As Integer
Visual Basic (Usage)Copy Code
Dim instance As CodecsRasterizeDocumentLoadOptions
Dim value As Integer
 
instance.YResolution = value
 
value = instance.YResolution
C# 
public int YResolution {get; set;}
C++/CLI 
public:
property int YResolution {
   int get();
   void set (int value);
}

Return Value

An Int32 value that indicates the vertical resolution to use when rasterization document files such as PDF and XPS. The default value is 0, which means use the current screen resolution.

Example

For an example, refer to CodecsRasterizeDocumentLoadOptions.

Remarks

The resolution controls the pixel density of the result raster image. For example, if you specify 8.5 by 11 inches page width and height and a resolution of 96, the result image will have a pixel width and height of (8.5 * 96 = 816) and (11 * 96 = 1056) pixels. This is suitable for viewing at a 1005 by 11 inch document, this results in a raster image size if T:Leadtools.RasterImage is loaded, the image resolution set in RasterImage.XResolution:P:Leadtools.RasterImage.XResolution and RasterImage.YResolution:P:Leadtools.RasterImage.YResolution will be the same as P:Leadtools.Codecs.CodecsRasterizeDocumentLoadOptions.XResolution and P:Leadtools.Codecs.CodecsRasterizeDocumentLoadOptions.YResolution

The horizontal resolution is specified in P:Leadtools.Codecs.CodecsRasterizeDocumentLoadOptions.XResolution For most normal usage, the value of P:Leadtools.Codecs.CodecsRasterizeDocumentLoadOptions.XResolution and P:Leadtools.Codecs.CodecsRasterizeDocumentLoadOptions.YResolution

If the value of CodecsRasterizeDocumentLoadOptions.Enabled:P:Leadtools.Codecs.CodecsRasterizeDocumentLoadOptions.Enabled is set to true, then P:Leadtools.Codecs.CodecsRasterizeDocumentLoadOptions.XResolution and P:Leadtools.Codecs.CodecsRasterizeDocumentLoadOptions.YResolution will be used instead of the following propertiesCodecsPdfLoadOptions.XResolution:P:Leadtools.Codecs.CodecsPdfLoadOptions.XResolution and CodecsPdfLoadOptions.YResolution:P:Leadtools.Codecs.CodecsPdfLoadOptions.YResolution

  • When loading XPS documents
  • CodecsXpsLoadOptions.Resolution:P:Leadtools.Codecs.CodecsXpsLoadOptions.Resolution
  • When loading RTF documents
  • CodecsRtfLoadOptions.XResolution:P:Leadtools.Codecs.CodecsRtfLoadOptions.XResolution and CodecsRtfLoadOptions.YResolution:P:Leadtools.Codecs.CodecsRtfLoadOptions.YResolution%

    Requirements

    Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

    See Also