←Select platform

SizeMode Enumeration

Summary

Determines how the control displays the image and the automatic adjustments of the display rectangles.

Syntax

C++

public enum SizeMode : System.Enum, System.IComparable, System.IConvertible, System.IFormattable

Public Enum SizeMode  
   Inherits System.Enum 
   Implements System.IComparable, System.IConvertible, System.IFormattable

public enum class SizeMode : public System.Enum, System.IComparable, System.IConvertible, System.IFormattable

Members

Value	Member	Description
0	Normal	Normal, no sizing.
1	Fit	Fit the image into the viewing area while maintaining the aspect ratio. If the image size is smaller than the viewing area, no resizing is done.
2	FitAlways	Always fit the image into the viewing area while maintaining the aspect ratio even if the image size is smaller than the viewing area.
3	FitWidth	Fit the image width to be the size of the width of the viewing area while maintaining the aspect ratio.
4	Stretch	Fit the image to fill the viewing area. Aspect ratio might not be maintained.

Remarks

The SizeMode enumeration is used as the value for the following properties:

By setting these properties to one of the SizeMode enumeration, the control will use the base class FrameworkElement.MeasureOverride to determine how to fit the image in the viewing area.

When using the Normal size mode with the ImageViewer or RasterImageViewer controls; vertical or horizontal scrollbars may become visible and functional if the image size becomes greater than the viewing area. The image size is determined by the image physical pixel width and height and the values of the UseDpi/> and ScaleFactor properties. The AspectRatioCorrection will also play a role in determining the image size of its value is other than 1. The viewing area size is determined from the current pixel size of the control client area.

When the using the Fit, FitAlways, FitWidth and Stretch size modes; the value of ScaleFactor will always be reset back to 1 and will not be used. Instead, use the read only CurrentXScaleFactor and CurrentYScaleFactor properties to get the actual scale factors used. Note that AspectRatioCorrection will still be used. In the case of FitWidth size mode; vertical scroll might become visible and functional if the image height becomes greater than the viewing area.

Example

For XAML example, refer to SizeMode.

For C#/VB examples, refer to SizeMode.

Requirements

Target Platforms

See Also