ZoomMouseTool Class

This tool is used to zoom in and out of an image by either clicking a mouse button or selecting an area of the image which will be zoomed to fit in the viewer.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        System.Windows.Media.AnimationAnimatable
          Atalasoft.Imaging.WpfMouseTool
            Atalasoft.Imaging.WpfZoomMouseTool

Namespace: Atalasoft.Imaging.Wpf
Assembly: Atalasoft.dotImage.Wpf (in Atalasoft.dotImage.Wpf.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public class ZoomMouseTool : MouseTool

Public Class ZoomMouseTool
	Inherits MouseTool

The ZoomMouseTool type exposes the following members.

Constructors

	Name	Description
	ZoomMouseTool	Creates a new instance of ZoomMouseTool in which the left mouse button is for zooming in and the right button is used for zooming out.
	ZoomMouseTool(ZoomToolMode)	Creates a new instance of ZoomMouseTool specifying the tool used for all mouse buttons.
	ZoomMouseTool(ZoomToolMode, ZoomToolMode, ZoomToolMode)	Creates a new instance of ZoomMouseTool specifying the tool to use for common mouse buttons.
	ZoomMouseTool(Double, Boolean, Boolean, MouseToolBehavior, Pen, Color, Brush, Boolean)	Creates a new instance of ZoomMouseTool specifying the pen, fill and common properties.
	ZoomMouseTool(Double, Boolean, Double, Double, Boolean, MouseToolBehavior, Pen, Color, Brush, Boolean)	Creates a new instance of ZoomMouseTool specifying the pen, tool behavior and zoom level parameters.
	ZoomMouseTool(Double, Boolean, Boolean, MouseToolBehavior, Pen, Color, Brush, Boolean, ZoomToolMode, ZoomToolMode, ZoomToolMode)	Creates a new instance of ZoomMouseTool specifying the pen, behavior and button tools.
	ZoomMouseTool(Double, Boolean, Double, Double, Boolean, MouseToolBehavior, Pen, Color, Brush, Boolean, ZoomToolMode)	Creates a new instance of ZoomMouseTool specifying the pen, tool behavior, zoom level parameters and tool used for all buttons.
	ZoomMouseTool(Double, Boolean, Double, Double, Boolean, MouseToolBehavior, Pen, Color, Brush, Boolean, ZoomToolMode, ZoomToolMode, ZoomToolMode, ZoomToolMode, ZoomToolMode)	Creates a new instance of ZoomMouseTool specifying all of its property values.

Top

Properties

	Name	Description
	AutoZoomSelection	Gets or sets a value indicating whether the tool will automatically perform a zoom selection when an active button is pressed and dragged.
	Bounds	Gets or sets the bounds used by the MouseTool. (Inherited from MouseTool.)
	CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
	CenterZoom	Gets or sets a value indicating whether a zoom in and zoom out will scroll the pixel clicked to the center of the viewer.
	Cursor	Gets or sets the cursor for the MouseTool. (Inherited from MouseTool.)
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	Fill	Gets or sets the brush used to fill the zoom selection.
	HasAnimatedProperties	Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
	IsCreating	Gets a value indicating whether the mouse tool is currently being created. (Inherited from MouseTool.)
	IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
	LeftButtonTool	Gets or sets the tool to use for a left button click.
	LineBackgroundColor	Gets or sets the color used behind the zoom selection line.
	MaintainPenThickness	Gets or sets a value indicating whether the thickness of the zoom selection pen is rendered at the same size or scaled along with the image zoom value.
	MaximumZoomLevel	Gets or sets the maximum allows zoom level.
	MiddleButtonTool	Gets or sets the tool used for the middle mouse button.
	MinimumZoomLevel	Gets or sets the minimum allowed zoom level.
	Pen	Gets or sets the pen to use for the zoom selection.
	RightButtonTool	Gets or sets the tool to use for the right mouse button.
	SupportedMouseToolBehaviors	Gets an array of supported MouseToolBehavior values for this tool. (Overrides MouseToolSupportedMouseToolBehaviors.)
	ToolBehavior	Identifies the ToolBehavior dependency property. (Inherited from MouseTool.)
	Viewer	Gets the AtalaImageViewer which is using the MouseTool. (Inherited from MouseTool.)
	XButton1Tool	Gets or sets the tool used for the XButton1 mouse button.
	XButton2Tool	Gets or sets the tool used for the XButton2 mouse button.
	ZoomChangePercentage	Gets or sets the percentage to change the zoom for each mouse click.

Top

Methods

	Name	Description
	ApplyAnimationClock(DependencyProperty, AnimationClock)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
	ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
	CheckAccess	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone	Creates a modifiable clone of this Animatable, making deep copies of this object's values. When copying this object's dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. (Inherited from Animatable.)
	CloneCore	Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)
	CloneCurrentValue	Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable.)
	CloneCurrentValueCore	Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from Freezable.)
	CoerceValue	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
	ConfineToImage(Point)	Returns a modified Point that is confined to the image area. (Inherited from MouseTool.)
	ConfineToImage(Rect)	Returns a Rect that is confined to the image. (Inherited from MouseTool.)
	ConfineToRenderedImage	Returns a rectangle confined to the rendered size of the image. (Inherited from MouseTool.)
	CreateInstance	Initializes a new instance of the Freezable class. (Inherited from Freezable.)
	CreateInstanceCore	Returns a new instance of ZoomMouseTool. (Overrides FreezableCreateInstanceCore.)
	Equals	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Freeze	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	FreezeCore	Makes this Animatable object unmodifiable or determines whether it can be made unmodifiable. (Inherited from Animatable.)
	GetAnimationBaseValue	Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
	GetAsFrozen	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetAsFrozenCore	Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)
	GetCurrentValueAsFrozen	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetCurrentValueAsFrozenCore	Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. (Inherited from Freezable.)
	GetHashCode	Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
	GetImagePosition(MouseButtonEventArgs, Boolean)	Returns the image position from a MouseButtonEventArgs. (Inherited from MouseTool.)
	GetImagePosition(MouseEventArgs, Boolean)	Returns the image position from a MouseEventArgs. (Inherited from MouseTool.)
	GetImagePosition(Point, Boolean)	Returns the image position from a point in viewer coordinates. (Inherited from MouseTool.)
	GetLocalValueEnumerator	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	HitTestCore	Called by the AtalaImageViewer to determine if a point is over the MouseTool. (Overrides MouseToolHitTestCore(Point).)
	InvaidateVisual	Use this method to force the AtalaImageViewer to redraw itself and call the OnRender(DrawingContext) method. (Inherited from MouseTool.)
	InvalidateProperty	Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
	IsMouseToolBehaviorSupported	Indicates if the specified MouseToolBehavior is supported by the MouseTool. (Inherited from MouseTool.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnChanged	Called when the current Freezable object is modified. (Inherited from Freezable.)
	OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable.)
	OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable.)
	OnImageChanged	Called when the image in the AtalaImageViewer has changed. (Inherited from MouseTool.)
	OnMouseDown	Called when a mouse button is pressed. (Overrides MouseToolOnMouseDown(MouseButtonEventArgs).)
	OnMouseMove	Called when the mouse is moved over the mouse tool bounds or when dragging the tool. (Overrides MouseToolOnMouseMove(MouseEventArgs).)
	OnMouseUp	Called when the mouse button is released. (Overrides MouseToolOnMouseUp(MouseButtonEventArgs).)
	OnPropertyChanged	Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable.)
	OnRender	Called when the tool must render itself. (Overrides MouseToolOnRender(DrawingContext).)
	OnScrollChanged	Called when the scroll position has changed. (Inherited from MouseTool.)
	OnViewerChanged	Called when the MouseTool becomes or is removed as the active tool for the AtalaImageViewer. (Inherited from MouseTool.)
	PerformZoom	This method applies the actual zoom change to the AtalaImageViewer.
	ReadLocalValue	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	ReadPreamble	Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable.)
	SetCreatingState	Sets the value for the IsCreating property. (Inherited from MouseTool.)
	SetCurrentValue	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	ShouldSerializeProperty	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	VerifyAccess	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
	WritePostscript	Raises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable.)
	WritePreamble	Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable.)

Top

Events

	Name	Description
	Changed	Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
	SelectionChanged	Raised when the selection has finished being modified.
	SelectionChanging	Raised while the selection is being modfied to provide live feedback to the user.

Top

Fields

	Name	Description
	AutoZoomSelectionProperty	Identifies the AutoZoomSelection dependency property.
	CenterZoomProperty	Identifies the CenterZoom dependency property.
	FillProperty	Identifies the Fill dependency property.
	LeftButtonToolProperty	Identifies the LeftButtonTool dependency property.
	LineBackgroundColorProperty	Identifies the LineBackgroundColor dependency property.
	MaintainPenThicknessProperty	Identifies the MaintainPenThickness dependency property.
	MaximumZoomLevelProperty	Identifies the MaximumZoomLevel dependency property.
	MiddleButtonToolProperty	Identifies the MiddleButtonTool dependency property.
	MinimumZoomLevelProperty	Identifies the MinimumZoomLevel dependency property.
	PenProperty	Identifies the Pen dependency property.
	RightButtonToolProperty	Identifies the RightButtonTool dependency property.
	XButton1ToolProperty	Identifies the XButton1Tool dependency property.
	XButton2ToolProperty	Identifies the XButton2Tool dependency property.
	ZoomChangePercentageProperty	Identifies the ZoomChangePercentage dependency property.

Top

Examples

Copy

 <Window x:Class="WpfControlsDemo.Window1"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:atala="clr-namespace:Atalasoft.Imaging.Wpf;assembly=Atalasoft.dotImage.Wpf"
    Title="WPF Controls Demo" Height="565" Width="756"
    Background="White"
    >
  <Grid>
    <atala:AtalaImageViewer Name="Viewer">
      <atala:AtalaImageViewer.MouseTool>
        <atala:ZoomMouseTool ZoomChangePercentage="0.2" LeftButtonTool="ZoomSelection"/>
      </atala:AtalaImageViewer.MouseTool>
    </atala:AtalaImageViewer>
  </Grid>
</Window>

Copy

Me.Viewer.MouseTool = New ZoomMouseTool(0.2, False, False, MouseToolBehavior.ClickAndDrag, Nothing, Colors.White, Nothing, True, ZoomToolMode.ZoomSelection, ZoomToolMode.None, ZoomToolMode.None)

Copy

this.Viewer.MouseTool = new ZoomMouseTool(0.2, false, false, MouseToolBehavior.ClickAndDrag, null, Colors.White, null, true, ZoomToolMode.ZoomSelection, ZoomToolMode.None, ZoomToolMode.None);

Reference

Atalasoft.Imaging.Wpf Namespace