Click or drag to resize

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

Namespace:  Atalasoft.Imaging.Wpf
Assembly:  Atalasoft.dotImage.Wpf (in Atalasoft.dotImage.Wpf.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class ZoomMouseTool : MouseTool

The ZoomMouseTool type exposes the following members.

Constructors
  NameDescription
Public methodZoomMouseTool
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.
Public methodZoomMouseTool(ZoomToolMode)
Creates a new instance of ZoomMouseTool specifying the tool used for all mouse buttons.
Public methodZoomMouseTool(ZoomToolMode, ZoomToolMode, ZoomToolMode)
Creates a new instance of ZoomMouseTool specifying the tool to use for common mouse buttons.
Public methodZoomMouseTool(Double, Boolean, Boolean, MouseToolBehavior, Pen, Color, Brush, Boolean)
Creates a new instance of ZoomMouseTool specifying the pen, fill and common properties.
Public methodZoomMouseTool(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.
Public methodZoomMouseTool(Double, Boolean, Boolean, MouseToolBehavior, Pen, Color, Brush, Boolean, ZoomToolMode, ZoomToolMode, ZoomToolMode)
Creates a new instance of ZoomMouseTool specifying the pen, behavior and button tools.
Public methodZoomMouseTool(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.
Public methodZoomMouseTool(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
  NameDescription
Public propertyAutoZoomSelection
Gets or sets a value indicating whether the tool will automatically perform a zoom selection when an active button is pressed and dragged.
Public propertyBounds
Gets or sets the bounds used by the MouseTool.
(Inherited from MouseTool.)
Public propertyCanFreeze
Gets a value that indicates whether the object can be made unmodifiable.
(Inherited from Freezable.)
Public propertyCenterZoom
Gets or sets a value indicating whether a zoom in and zoom out will scroll the pixel clicked to the center of the viewer.
Public propertyCursor
Gets or sets the cursor for the MouseTool.
(Inherited from MouseTool.)
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyFill
Gets or sets the brush used to fill the zoom selection.
Public propertyHasAnimatedProperties
Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.
(Inherited from Animatable.)
Public propertyIsCreating
Gets a value indicating whether the mouse tool is currently being created.
(Inherited from MouseTool.)
Public propertyIsFrozen
Gets a value that indicates whether the object is currently modifiable.
(Inherited from Freezable.)
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyLeftButtonTool
Gets or sets the tool to use for a left button click.
Public propertyLineBackgroundColor
Gets or sets the color used behind the zoom selection line.
Public propertyMaintainPenThickness
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.
Public propertyMaximumZoomLevel
Gets or sets the maximum allows zoom level.
Public propertyMiddleButtonTool
Gets or sets the tool used for the middle mouse button.
Public propertyMinimumZoomLevel
Gets or sets the minimum allowed zoom level.
Public propertyPen
Gets or sets the pen to use for the zoom selection.
Public propertyRightButtonTool
Gets or sets the tool to use for the right mouse button.
Public propertySupportedMouseToolBehaviors
Gets an array of supported MouseToolBehavior values for this tool.
(Overrides MouseToolSupportedMouseToolBehaviors.)
Public propertyToolBehavior
Identifies the ToolBehavior dependency property.
(Inherited from MouseTool.)
Protected propertyViewer
Gets the AtalaImageViewer which is using the MouseTool.
(Inherited from MouseTool.)
Public propertyXButton1Tool
Gets or sets the tool used for the XButton1 mouse button.
Public propertyXButton2Tool
Gets or sets the tool used for the XButton2 mouse button.
Public propertyZoomChangePercentage
Gets or sets the percentage to change the zoom for each mouse click.
Top
Methods
  NameDescription
Public methodApplyAnimationClock(DependencyProperty, AnimationClock)
Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.
(Inherited from Animatable.)
Public methodApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)
Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.
(Inherited from Animatable.)
Public methodBeginAnimation(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.)
Public methodBeginAnimation(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.)
Public methodCheckAccess
Determines whether the calling thread has access to this DispatcherObject.
(Inherited from DispatcherObject.)
Public methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodClone
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.)
Protected methodCloneCore
Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values.
(Inherited from Freezable.)
Public methodCloneCurrentValue
Creates a modifiable clone (deep copy) of the Freezable using its current values.
(Inherited from Freezable.)
Protected methodCloneCurrentValueCore
Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values.
(Inherited from Freezable.)
Public methodCoerceValue
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.)
Protected methodConfineToImage(Point)
Returns a modified Point that is confined to the image area.
(Inherited from MouseTool.)
Protected methodConfineToImage(Rect)
Returns a Rect that is confined to the image.
(Inherited from MouseTool.)
Protected methodConfineToRenderedImage
Returns a rectangle confined to the rendered size of the image.
(Inherited from MouseTool.)
Protected methodCreateInstance
Initializes a new instance of the Freezable class.
(Inherited from Freezable.)
Protected methodCreateInstanceCore
Returns a new instance of ZoomMouseTool.
(Overrides FreezableCreateInstanceCore.)
Public methodEquals
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Makes the current object unmodifiable and sets its IsFrozen property to true.
(Inherited from Freezable.)
Protected methodFreezeCore
Makes this Animatable object unmodifiable or determines whether it can be made unmodifiable.
(Inherited from Animatable.)
Public methodGetAnimationBaseValue
Returns the non-animated value of the specified DependencyProperty.
(Inherited from Animatable.)
Public methodGetAsFrozen
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.)
Protected methodGetAsFrozenCore
Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values.
(Inherited from Freezable.)
Public methodGetCurrentValueAsFrozen
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.)
Protected methodGetCurrentValueAsFrozenCore
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.)
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Protected methodGetImagePosition(MouseButtonEventArgs, Boolean)
Returns the image position from a MouseButtonEventArgs.
(Inherited from MouseTool.)
Protected methodGetImagePosition(MouseEventArgs, Boolean)
Returns the image position from a MouseEventArgs.
(Inherited from MouseTool.)
Protected methodGetImagePosition(Point, Boolean)
Returns the image position from a point in viewer coordinates.
(Inherited from MouseTool.)
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
Protected methodHitTestCore
Called by the AtalaImageViewer to determine if a point is over the MouseTool.
(Overrides MouseToolHitTestCore(Point).)
Protected methodInvaidateVisual
Use this method to force the AtalaImageViewer to redraw itself and call the OnRender(DrawingContext) method.
(Inherited from MouseTool.)
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
Public methodIsMouseToolBehaviorSupported
Indicates if the specified MouseToolBehavior is supported by the MouseTool.
(Inherited from MouseTool.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnChanged
Called when the current Freezable object is modified.
(Inherited from Freezable.)
Protected methodOnFreezablePropertyChanged(DependencyObject, DependencyObject)
Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set.
(Inherited from Freezable.)
Protected methodOnFreezablePropertyChanged(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.)
Protected methodOnImageChanged
Called when the image in the AtalaImageViewer has changed.
(Inherited from MouseTool.)
Protected methodOnMouseDown
Called when a mouse button is pressed.
(Overrides MouseToolOnMouseDown(MouseButtonEventArgs).)
Protected methodOnMouseMove
Called when the mouse is moved over the mouse tool bounds or when dragging the tool.
(Overrides MouseToolOnMouseMove(MouseEventArgs).)
Protected methodOnMouseUp
Called when the mouse button is released.
(Overrides MouseToolOnMouseUp(MouseButtonEventArgs).)
Protected methodOnPropertyChanged
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.)
Protected methodOnRender
Called when the tool must render itself.
(Overrides MouseToolOnRender(DrawingContext).)
Protected methodOnScrollChanged
Called when the scroll position has changed.
(Inherited from MouseTool.)
Protected methodOnViewerChanged
Called when the MouseTool becomes or is removed as the active tool for the AtalaImageViewer.
(Inherited from MouseTool.)
Protected methodPerformZoom
This method applies the actual zoom change to the AtalaImageViewer.
Public methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
Protected methodReadPreamble
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.)
Protected methodSetCreatingState
Sets the value for the IsCreating property.
(Inherited from MouseTool.)
Public methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
Protected methodShouldSerializeProperty
Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.
(Inherited from DependencyObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodVerifyAccess
Enforces that the calling thread has access to this DispatcherObject.
(Inherited from DispatcherObject.)
Protected methodWritePostscript
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.)
Protected methodWritePreamble
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
  NameDescription
Public eventChanged
Occurs when the Freezable or an object it contains is modified.
(Inherited from Freezable.)
Public eventSelectionChanged
Raised when the selection has finished being modified.
Public eventSelectionChanging
Raised while the selection is being modfied to provide live feedback to the user.
Top
Fields
  NameDescription
Public fieldStatic memberAutoZoomSelectionProperty
Identifies the AutoZoomSelection dependency property.
Public fieldStatic memberCenterZoomProperty
Identifies the CenterZoom dependency property.
Public fieldStatic memberFillProperty
Identifies the Fill dependency property.
Public fieldStatic memberLeftButtonToolProperty
Identifies the LeftButtonTool dependency property.
Public fieldStatic memberLineBackgroundColorProperty
Identifies the LineBackgroundColor dependency property.
Public fieldStatic memberMaintainPenThicknessProperty
Identifies the MaintainPenThickness dependency property.
Public fieldStatic memberMaximumZoomLevelProperty
Identifies the MaximumZoomLevel dependency property.
Public fieldStatic memberMiddleButtonToolProperty
Identifies the MiddleButtonTool dependency property.
Public fieldStatic memberMinimumZoomLevelProperty
Identifies the MinimumZoomLevel dependency property.
Public fieldStatic memberPenProperty
Identifies the Pen dependency property.
Public fieldStatic memberRightButtonToolProperty
Identifies the RightButtonTool dependency property.
Public fieldStatic memberXButton1ToolProperty
Identifies the XButton1Tool dependency property.
Public fieldStatic memberXButton2ToolProperty
Identifies the XButton2Tool dependency property.
Public fieldStatic memberZoomChangePercentageProperty
Identifies the ZoomChangePercentage dependency property.
Top
Examples
 <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>
Me.Viewer.MouseTool = New ZoomMouseTool(0.2, False, False, MouseToolBehavior.ClickAndDrag, Nothing, Colors.White, Nothing, True, ZoomToolMode.ZoomSelection, ZoomToolMode.None, ZoomToolMode.None)
this.Viewer.MouseTool = new ZoomMouseTool(0.2, false, false, MouseToolBehavior.ClickAndDrag, null, Colors.White, null, true, ZoomToolMode.ZoomSelection, ZoomToolMode.None, ZoomToolMode.None);
See Also