Artikel
11/18/2011

MultiScaleImage Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Enables users to open a multi-resolution image, which can be zoomed in on and panned across.

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.UIElement
      System.Windows.FrameworkElement
        System.Windows.Controls.MultiScaleImage

Namespace: System.Windows.Controls
Assembly: System.Windows (in System.Windows.dll)

Syntax

'Declaration
Public NotInheritable Class MultiScaleImage _
    Inherits FrameworkElement

public sealed class MultiScaleImage : FrameworkElement

<MultiScaleImage .../>

The MultiScaleImage type exposes the following members.

Constructors

	Name	Description
	MultiScaleImage	Initializes a new instance of the MultiScaleImage class.

Top

Properties

	Name	Description
	ActualHeight	Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
	ActualWidth	Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
	AllowDownloading	Gets or sets a value that indicates whether downloading is permitted by this MultiScaleImage.
	AllowDrop	Gets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.)
	AspectRatio	Gets the aspect ratio of the image used as the source of the MultiScaleImage. The aspect ratio is the width of the image divided by its height.
	BlurFactor	Gets or sets the extent that data is blurred while rendering.
	CacheMode	Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
	Clip	Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
	Cursor	Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
	DataContext	Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
	DesiredSize	Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
	Effect	Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
	FlowDirection	Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
	Height	Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
	HorizontalAlignment	Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.)
	IsDownloading	Gets a value that indicates whether the image is still downloading.
	IsHitTestVisible	Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
	IsIdle	Gets a value that indicates whether Deep Zoom is done downloading, decoding, blending, and animating (if springs are being used) images.
	Language	Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
	Margin	Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
	MaxHeight	Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
	MaxWidth	Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
	MinHeight	Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
	MinWidth	Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
	Name	Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.)
	Opacity	Gets or sets the degree of the object's opacity. (Inherited from UIElement.)
	OpacityMask	Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
	OriginalPixelHeight	Gets the original height of the image used as the source of the MultiScaleImage.
	OriginalPixelWidth	Gets the original width of the image used as the source of the MultiScaleImage.
	Parent	Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
	Projection	Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
	RenderSize	Gets the final render size of a UIElement. (Inherited from UIElement.)
	RenderTransform	Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
	RenderTransformOrigin	Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
	Resources	Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.)
	SkipLevels	Gets or sets a value that indicates levels to be skipped while loading a MultiScaleImage.
	Source	Gets or sets the MultiScaleTileSource object that is used as the source for the MultiScaleImage.
	Style	Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
	SubImages	Gets the collection of MultiScaleSubImage objects within the multiresolution image that is used by the MultiScaleImage.
	Tag	Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
	Triggers	Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
	UseLayoutRounding	Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.)
	UseSprings	Gets or sets a value that indicates whether the MultiScaleImage uses spring animations.
	VerticalAlignment	Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.)
	ViewportOrigin	Gets or sets the top-left corner of the area of the image to be displayed.
	ViewportWidth	Gets or sets the width of the area of the image displayed.
	Visibility	Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.)
	Width	Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)

Top

Methods

	Name	Description
	AddHandler	Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
	Arrange	Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.)
	ArrangeOverride	Provides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
	CaptureMouse	Sets mouse capture to a UIElement. (Inherited from UIElement.)
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	ElementToLogicalPoint	Gets a point with logical coordinates (values between 0 and 1) from a point of the MultiScaleImage.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	FindName	Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
	GetAnimationBaseValue	Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
	GetBindingExpression	Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
	InvalidateArrange	Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
	InvalidateMeasure	Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
	LogicalToElementPoint	Gets a point with pixel coordinates relative to the MultiScaleImage from a logical point (values between 0 and 1).
	Measure	Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.)
	MeasureOverride	Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnApplyTemplate	When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks. (Inherited from FrameworkElement.)
	OnCreateAutomationPeer	When implemented in a derived class, returns class-specific AutomationPeer implementations for the Silverlight automation infrastructure. (Inherited from UIElement.)
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	ReleaseMouseCapture	Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
	RemoveHandler	Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
	SetBinding	Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
	SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TransformToVisual	Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
	UpdateLayout	Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)
	ZoomAboutLogicalPoint	Enables a user to zoom in on a point of the MultiScaleImage.

Top

Events

	Name	Description
	BindingValidationError	Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
	DataContextChanged	Occurs when the data context for this element changes. (Inherited from FrameworkElement.)
	DoubleTap	Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
	DragEnter	Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
	DragLeave	Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
	DragOver	Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
	Drop	Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
	GotFocus	Occurs when a UIElement receives focus. (Inherited from UIElement.)
	Hold	Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
	ImageFailed	Occurs if the download of a tile times out or fails for another reason.
	ImageOpenFailed	Occurs if the first piece of metadata used to open the image fails. If this event occurs no parts of the image will open successfully.
	ImageOpenSucceeded	Occurs when the first piece of metadata that is needed to load the rest of the tiles opens.
	KeyDown	Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
	KeyUp	Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
	LayoutUpdated	Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.)
	Loaded	Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
	LostFocus	Occurs when a UIElement loses focus. (Inherited from UIElement.)
	LostMouseCapture	Occurs when the UIElement loses mouse capture. (Inherited from UIElement.)
	ManipulationCompleted	Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
	ManipulationDelta	Occurs when the input device changes position during a manipulation. (Inherited from UIElement.)
	ManipulationStarted	Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
	MediaCommand	Occurs when a button is pressed on a remote control. (Inherited from UIElement.)
	MotionFinished	Occurs when the zoom or pan animation ends.
	MouseEnter	Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
	MouseLeave	Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
	MouseLeftButtonDown	Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.)
	MouseLeftButtonUp	Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
	MouseMove	Occurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
	MouseRightButtonDown	Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
	MouseRightButtonUp	Occurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.)
	MouseWheel	Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
	SizeChanged	Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
	SubImageOpenFailed	Occurs when the collection of MultiScaleSubImage objects within the multiresolution image that is used by the MultiScaleImage fails to open.
	SubImageOpenSucceeded	Occurs when the collection of MultiScaleSubImage objects within the multiresolution image that is used by the MultiScaleImage opens successfully.
	Tap	Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
	TextInput	Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
	TextInputStart	Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
	TextInputUpdate	Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
	Unloaded	Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)
	ViewportChanged	Occurs when the viewport (the area of the image displayed) changes.

Top

Fields

	Name	Description
	AllowDownloadingProperty	Identifies the AllowDownloading dependency property.
	AspectRatioProperty	Identifies the AspectRatio dependency property.
	BlurFactorProperty	Identifies the BlurFactor dependency property.
	IsDownloadingProperty	Identifies the IsDownloading dependency property.
	IsIdleProperty	Identifies the IsIdle dependency property.
	OriginalPixelHeightProperty	Identifies the OriginalPixelHeight dependency property.
	OriginalPixelWidthProperty	Identifies the OriginalPixelWidth dependency property.
	SkipLevelsProperty	Identifies the SkipLevels dependency property.
	SourceProperty	Identifies the Source dependency property.
	SubImagesProperty	Identifies the SubImages dependency property.
	UseSpringsProperty	Identifies the UseSprings dependency property.
	ViewportOriginProperty	Identifies the ViewportOrigin dependency property.
	ViewportWidthProperty	Identifies the ViewportWidth dependency property.

Top

Remarks

The MultiScaleImage class is one of the key objects of Silverlight's Deep Zoom technology. MultiScaleImage is modeled after MediaElement and allows a user to open a multi-resolution image or collection of images. For information about the format, see Deep Zoom.

By default, a user cannot zoom into or pan across the image loaded by MultiScaleImage. However, MultiScaleImage includes methods to zoom and pan, which can be utilized by the developer.

By default, the image loaded by MultiScaleImage zooms (expands) onto the page when the page first loads. You can disable this behavior by setting the UseSprings property to false. However, you will probably want to set this property to true when the user begins interacting with the image.

Examples

In this simple example, the MouseEnter event is used to zoom into the middle of the image when the mouse pointer moves over the image.

Run this sample

<Grid x:Name="LayoutRoot" Background="White">
    <MultiScaleImage x:Name="MyMSI" Source="source/dzc_output.xml"  MouseEnter="MyMSI_MouseEnter" MouseLeftButtonDown="MyMSI_LeftButtonDown" 
                     ImageOpenSucceeded="MyMSI_ImageOpenSucceeded" MouseLeave="MyMSI_MouseLeave" />

</Grid>

Private Sub MyMSI_MouseEnter(ByVal sender As Object, ByVal e As MouseEventArgs)
    If MyMSI.UseSprings = False Then
        MyMSI.UseSprings = True
    End If

    ' The ZoomAboutLogicalPoint method allows you to zoom and pan
    ' in the same step. The first parameter is the zoom (3x) and the
    ' second and third parameters are the respective x and y coordinates
    ' of the logical point to zoom around.
    Me.MyMSI.ZoomAboutLogicalPoint(3, 0.5, 0.5)

End Sub

private void MyMSI_MouseEnter(object sender, MouseEventArgs e)
{
    if (MyMSI.UseSprings == false)
    {
        MyMSI.UseSprings = true;
    }

    // The ZoomAboutLogicalPoint method allows you to zoom and pan
    // in the same step. The first parameter is the zoom (3x) and the
    // second and third parameters are the respective x and y coordinates
    // of the logical point to zoom around.
    this.MyMSI.ZoomAboutLogicalPoint(3, .5, .5);

}

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Bagikan melalui