AspectRatioCorrection Property

WinRT C#
WinRT JavaScript

public double AspectRatioCorrection {get; set;}

 get_AspectRatioCorrection();
 set_AspectRatioCorrection(value);

Property Value

The manual aspect ratio correction value. Default value is 1.

Changing the value of this property will fire the PropertyChanged and TransformChanged events.

When displaying images, sometimes it is necessary to set a manual aspect ratio correction to compensate for irregular screen resolution (pixel size). For example, if you display an image that is 100 by 100 pixels on most monitors, the image will not be an exact square on screen because most monitors have pixels that are rectangular in shape. Setting the AspectRatioCorrection value can fix this issue.

The AspectRatioCorrection is multiplied by the current vertical scale factor of the control CurrentYScaleFactor at all times regardless of the ScaleFactor and SizeMode values.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

[TestMethod]
public void AspectRatioCorrectionExample()
{
   // Get the aspect ratio correction value
   double value = _viewer.AspectRatioCorrection;
   // Flip between 1, 2 and 0.5
   if (value == 1)
   {
      _viewer.AspectRatioCorrection = 2;
      _infoLabel.Text = "Aspect ratio is set to 2. The image is displayed with twice the original height";
   }
   else if (value == 2)
   {
      _viewer.AspectRatioCorrection = 0.5;
      _infoLabel.Text = "Aspect ratio is set to 0.5. The image is displayed with half the original height";
   }
   else
   {
      _viewer.AspectRatioCorrection = 1;
      _infoLabel.Text = "Aspect ratio is set back to 1. The image is displayed with original height";
   }
}

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