←Select platform

ImageViewer Class Members

Summary

The following tables list the members exposed by ImageViewer.

Public Constructors

	Name	Description
	ImageViewer	Initializes a new ImageViewer with explicit parameters.

Public Methods

	Name	Description
	BeginUpdate	Stops the viewer from being updated if any change is applied. This is useful to increase the control's speed efficiency.
	CenterAtPoint	Centers the image display at the specified point.
	ConvertPoint	Converts the specified point from one CoordinateType to another.
	ConvertRect	Converts the specified rectangle from one CoordinateType to another.
	EndUpdate	Use this method to indicate that updates to the ImageViewer are complete.
	GetTransform	Gets the current transformation matrix used for displaying the image with or without DPI scaling.
	ImageControlRectangle	Gets the location and size of the image in the viewer in control coordinates.
	Invalidate	Invalidates the entire surface of the control and causes the control to be redrawn.
	OnImageChanged	Raises the ImageChanged event.
	OnTransformChanged	Raises the TransformChanged event.
	ScrollBy	Scrolls the image by the specified amount.
	Zoom	Zooms or changes the size mode of the image inside the viewer.
	ZoomToRect	Zooms the image to the specified rectangle.

Protected Methods

	Name	Description
	BeginScroll	Indicates that the ImageViewer should stop obtaining the value of the auto scrollbar location.
	EndScroll	Starts the ImageViewer obtaining the value of the auto scrollbar location again.
	OnImageError	Raises the ImageError event.
	OnPropertyChanged	Raises the PropertyChanged event.
	OnScrollChanged	Raises the ScrollChanged event.
	OnWorkingInteractiveModeChanged	Raises the WorkingInteractiveModeChanged event.

Public Properties

	Name	Description
	AllowAutoDrop	Gets or sets a value that indicates if the viewer handles drop events automatically.
	AspectRatioCorrection	Gets or sets the manual aspect ratio correction value
	ControlSize	Gets the control size.
	CurrentScaleFactor	Gets or sets the current scale factor for the image display.
	CurrentXScaleFactor	Gets the actual value of the horizontal scale factor for the image display.
	CurrentYScaleFactor	Gets the actual value of the vertical scale factor for the image display.
	DefaultInteractiveMode	Gets or sets the ImageViewerInteractiveMode that the viewer control should use to process default input events.
	DefaultZoomOrigin	Gets the origin of the default zoom point for current horizontal and vertical alignment, in control coordinates.
	EnableDpiCorrection	Gets or sets a value that indicates whether the viewer should view images with non-uniform DPI with the correct aspect ratio.
	Flip	Gets or sets a value which determines if the ImageViewer will display the image flipped vertically.
	HasImage	Gets a value that indicates if the viewer currently has an image.
	HorizontalScrollHeight	Gets the height of the horizontal scrollbar.
	ImageControlCenter	Gets the location of the center of the image, in control coordinates.
	ImageDpiX	Gets or sets the horizontal resolution in dots/inch (or DPI) of the image.
	ImageDpiY	Gets or sets the vertical resolution in dots/inch (or DPI) of the image.
	ImageHorizontalAlignment	Gets or sets a value that indicates the horizontal alignment for the image in this control.
	ImageSize	Gets or sets the size of the image in the viewer.
	ImageVerticalAlignment	Gets or sets a value that indicates the vertical alignment for the image in this control.
	InteractiveModeCanvas	Gets the interactive mode canvas.
	InteractiveService	Gets or sets the InteractiveService for this viewer control.
	MouseWheelInteractiveMode	Gets or sets the ImageViewerInteractiveMode that the viewer control should use to process mouse wheel events.
	NewImageResetOptions	Gets or sets a value that determines which properties to reset when a new image is set into the viewer.
	OwnerDraw	Gets or sets a value that indicates whether the viewer should draw an image on its canvas or not.
	RealImageSize	Gets the real width and height of the image.
	ResizeOnRotate	Gets or sets a value that indicates whether the viewer should change the size of the scrolling area when the image is rotated.
	RestrictHiddenScrollMode	Gets or sets a value that indicates whether scrolling or panning the image outside the maximum range is allowed.
	Reverse	Gets or sets a value which determines if the ImageViewer will display the image reversed horizontally.
	RotateAngle	Gets or sets the value of the rotation angle to use when displaying the image.
	ScaleFactor	Gets or sets the scale factor used to display the image.
	ScreenDpiX	Gets or sets the current screen horizontal resolution in dots per inch (or DPI).
	ScreenDpiY	Gets or sets the current screen vertical resolution in dots/inch (or DPI).
	ScrollMode	Gets or sets a value that determines how the control handles scrollbars when the current transformation results in the image being larger than the container.
	ScrollOffset	Gets or sets the scroll offset value.
	ScrollRange	Gets the size of the current maximum scroll area.
	SizeMode	Gets or sets a value that determines how the control displays the image and the adjusts the display automatically.
	TouchInteractiveMode	Gets or sets the ImageViewerInteractiveMode that the viewer control should use to process touch input events.
	Transform	Gets the current transformation matrix used for displaying the image.
	UseDpi	Gets or sets a value that indicates whether the control must account for the physical resolution of the image when calculating the display properties.
	VerticalScrollWidth	Gets the width of the vertical scrollbar.
	WorkingInteractiveMode	Gets the ImageViewerInteractiveMode that the viewer control is currently using to process input events.

Protected Properties

	Name	Description
	CanScroll	Gets a value that determines if the ImageViewer can obtain the value of the auto scrollbar location.
	CanUpdate	Gets a value that determines if the ImageViewer currently will update the image viewing transform and invalidate the display when changes are made to the control's properties or to the image.

Public Events

	Name	Description
	ImageChanged	Occurs when the image in the viewer changes.
	ImageError	Occurs if any error occurred inside the actual ImageSource object.
	PropertyChanged	Occurs when a property value in this ImageViewer changes.
	ScrollChanged	Occurs when the value of ScrollOffset changes.
	TransformChanged	Occurs when the Transform property changes.
	WorkingInteractiveModeChanged	Occurs when the WorkingInteractiveMode property changes.

Public Fields

	Name	Description
	AllowAutoDropProperty	Identifies the AllowAutoDrop dependency property.
	AspectRatioCorrectionProperty	Identifies the AspectRatioCorrection dependency property.
	DefaultInteractiveModeProperty	Identifies the DefaultInteractiveMode dependency property.
	EnableDpiCorrectionProperty	Identifies the EnableDpiCorrection dependency property.
	FlipProperty	Identifies the Flip dependency property.
	ImageDpiXProperty	Identifies the ImageDpiX dependency property.
	ImageDpiYProperty	Identifies the ImageDpiY dependency property.
	ImageHorizontalAlignmentProperty	Identifies the ImageHorizontalAlignment dependency property.
	ImageSizeProperty	Identifies the ImageSize dependency property.
	ImageVerticalAlignmentProperty	Identifies the ImageVerticalAlignment dependency property.
	InteractiveServiceProperty	Identifies the InteractiveService dependency property.
	MaximumScaleFactor	The maximum value for the ScaleFactor property (1000).
	MinimumScaleFactor	The minimum value for the ScaleFactor property (0.001).
	MouseWheelInteractiveModeProperty	Identifies the MouseWheelInteractiveMode dependency property.
	NewImageResetOptionsProperty	Identifies the NewImageResetOptions dependency property.
	OwnerDrawProperty	Identifies the OwnerDraw dependency property.
	RestrictHiddenScrollModeProperty	Identifies the RestrictHiddenScrollMode dependency property.
	ReverseProperty	Identifies the Reverse dependency property.
	RotateAngleProperty	Identifies the RotateAngle dependency property.
	ScaleFactorProperty	Identifies the ScaleFactor dependency property.
	ScreenDpiXProperty	Identifies the ScreenDpiX dependency property.
	ScreenDpiYProperty	Identifies the ScreenDpiY dependency property.
	ScrollModeProperty	Identifies the ScrollMode dependency property.
	ScrollOffsetProperty	Identifies the ScrollOffset dependency property.
	SizeModeProperty	Identifies the SizeMode dependency property.
	Source	The actual ImageSource image object
	SourceProperty	Identifies the Source dependency property.
	TouchInteractiveModeProperty	Identifies the TouchInteractiveMode dependency property.
	UseDpiProperty	Identifies the UseDpi dependency property.