SourceDpiY Property (ImageViewer)

public int SourceDpiY {get; set;}

'Declaration
 
Public Property SourceDpiY As Integer

'Usage
 
Dim instance As ImageViewer
Dim value As Integer
 
instance.SourceDpiY = value
 
value = instance.SourceDpiY

public int SourceDpiY {get; set;}

 get_SourceDpiY();
 set_SourceDpiY(value);  

public:
property int SourceDpiY {
   int get();
   void set (    int value);
}

Property Value

The control will automatically extracts the horizontal and vertical resolution of the image in Source when a new image is set and put them in the SourceDpiX and SourceDpiY properties.

The values of SourceDpiX, SourceDpiY, ScreenDpiX and ScreenDpiY are used when calculating how to display the image if the value of UseDpi is set to true.

For example, a typical A4 document image is 8.5 by 11 inches. Which could be 2550 by 3300 pixels if the image has a resolution of 300 by 300. Most document viewer applications will try to display this image in its original size. i.e. the image will take 8.5 inches of screen horizontal space and 11 inches of screen vertical space. Without using the UseDpi property of this control, you are required to do the calculations yourself as follows:

            control.UseDpi = false;
            control.ScaleFactor = screenResolution / imageResolution;
            

In the case of the image above, this will be 96 (typical screen resolution) divided by 300. Or, you can set the UseDpi value to true and the control will use the above formula internally keeping the ScaleFactor set to 1 as follows:

            control.UseDpi = true;
            control.ScaleFactor = 1;
            

This code will produce the same result as the previous one.

The control will automatically set the ScreenDpiX and ScreenDpiY to the current screen resolution, also the SourceDpiX and SourceDpiY will be obtained from the current image set in Source. You can change these values if required for manual calculations.

For XAML example, refer to ImageViewer.

For C#/VB examples, refer to ImageViewer.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ImageViewer Class
ImageViewer Members