MultiScaleSubImage Class
Collapse the table of content
Expand the table of content

MultiScaleSubImage Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

This class holds the properties for each sub-image within the MultiScaleImage.


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

public sealed class MultiScaleSubImage : DependencyObject

The MultiScaleSubImage type exposes the following members.

Public methodMultiScaleSubImageInitializes a new instance of the MultiScaleSubImage class.

Public propertyAspectRatioGets the aspect ratio of the image used as the source of the MultiScaleSubImage. The aspect ratio is the width of the image divided by its height.
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyOpacityGets or sets the degree of the MultiScaleSubImage opacity.
Public propertyViewportOriginGets or sets the top-left corner of the area of the image to be displayed.
Public propertyViewportWidthGets or sets the width of the area of the image displayed.
Public propertyZIndexGets or sets a value that represents the z-order rendering behavior of the MultiScaleSubImage. Z-order determines the relative rendering order of objects (which object is on top of which other objects).

Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public fieldStatic memberAspectRatioPropertyIdentifies the AspectRatio dependency property.
Public fieldStatic memberOpacityPropertyIdentifies the Opacity dependency property.
Public fieldStatic memberViewportOriginPropertyIdentifies the ViewportOrigin dependency property.
Public fieldStatic memberViewportWidthPropertyIdentifies the ViewportWidth dependency property.
Public fieldStatic memberZIndexPropertyIdentifies the ZIndex dependency property.

If you want to work with a set of individual images, for example, programmatically move individual images around the screen or filter your images, you will want to use a collection of images rather than a single high-resolution image. There are two basic things you need to do to do this:

  1. You need to export your images as a collection rather than a single image. You can do this in Deep Zoom Composer. Just make sure to check the "Create Collection" checkbox when you export your composition. Images within the collection you export are called "sub images".

  2. You can access the sub images in a MultiScaleImage (individual MultiScaleSubImage objects) you created in step 1 by using the SubImages property.

XAML usage for this class is technically possible but is not shown, because a XAML usage does not serve a purpose in any existing Windows Phone content model. The subimages are the result of processing of an image set by a tool, and are not created in pure markup. Typically, you interact with this class by getting the value of MultiScaleImage.SubImages. It is possible to apply a XAML defined style to MultiScaleImage properties.

The following example shows how to get a list of sub images in a MultiScaleSubImage.

private List<MultiScaleSubImage> RandomizedListOfImages()
    List<MultiScaleSubImage> imageList = new List<MultiScaleSubImage>();
    Random ranNum = new Random();

    // Store List of sub images.
    foreach (MultiScaleSubImage subImage in MyMSI.SubImages)

    return imageList;

The following example allows you to rearrange images in a grid pattern by manipulating all the MultiScaleSubImage objects in the collection. Tap on the "Randomize Images" button to see the effect.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

© 2017 Microsoft