ScrollMode Property

WinRT C#
WinRT JavaScript

public ImageViewerScrollMode ScrollMode {get; set;}

 get_ScrollMode();
 set_ScrollMode(value);

Property Value

The scroll mode. The default value is ImageViewerScrollMode.Auto.

Changing the value of this property will fire the PropertyChanged and TransformChanged events.

The size of the image in the viewer might become larger or smaller than the control size depending on the value of the current transform (ImageSize, ScaleFactor, AspectRatioCorrection, RotateAngle and SizeMode). In this case, the control might be required to show or hide scrollbars and determine how to handle panning.

As in the case of any scrolling model, the value of the current scroll offset and the size of the maximum scroll area should be available to query and change. These are stored in the ScrollOffset and ScrollRange properties of this control.

The value of RestrictHiddenScrollMode determines what to do when the user tries to pan the image outside the maximum scroll area (ScrollRange).

You can use the value of ScrollMode to determine how the control handles the scrollbars:

Value	Description
ImageViewerScrollMode.Auto	This instructs the control to use actual platform scrollbars. The viewer will show and hide the scrollbars depending on the transformation value. This is the default behavior. The value of RestrictHiddenScrollMode is not used in this case and the user cannot pan outside the maximum scroll area. You can manually scroll and pan the image from 0,0 to the maximum allowed (ScrollRange) by using ScrollOffset or ScrollBy.
ImageViewerScrollMode.Hidden	This instructs the control not enable scrolling without the use of actual scrollbars. The viewer will not show the scrollbars no matter what the transformation value is. You can still manually scroll and pan the image from 0,0 to the maximum allowed (ScrollRange) by using ScrollOffset or ScrollBy.
ImageViewerScrollMode.Disabled	This instructs the viewer to disable scrolling completely. Scrollbars will never be visible regardless of the current transformation and any values set into ScrollOffset or passed to ScrollBy will be ignored.

The value of RestrictHiddenScrollMode controls what happens if the user tries to scroll or pan outside the range. When the value of RestrictHiddenScrollMode is true (the default), the user cannot scroll/pan outside the maximum range. This works just like RestrictHiddenScrollMode.Auto but without visible scrollbars. If the value of RestrictHiddenScrollMode is set to false, then the user is allowed unlimited panning and scrolling, any value in ScrollOffset or ScrollBy can be used (negative values, very large values). This might be useful in some situation like a mapping or medical application.

Note: Changing the value of ScrollMode might affect the value of ScrollOffset. For example, if the scroll mode is ImageViewerScrollMode.Hidden with RestrictHiddenScrollMode set to false and the user has panned the image outside the maximum scrolling area, which is legal in this case. Now, if ScrollMode is set to ImageViewerScrollMode.Auto, the scroll offset cannot be outside the maximum scrolling area, and the viewer will change the value of ScrollOffset to the closest legal value for the current mode. This is also applicable when the user changes the value of RestrictHiddenScrollMode from false back to true.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

[TestMethod]
public void ScrollModeExample()
{
   // Loop through the ImageViewerScrollMode options
   ImageViewerScrollMode scrollMode = _viewer.ScrollMode;
   if(scrollMode == ImageViewerScrollMode.Auto)
      scrollMode = ImageViewerScrollMode.Hidden;
   else if(scrollMode == ImageViewerScrollMode.Hidden)
      scrollMode = ImageViewerScrollMode.Disabled;
   else if(scrollMode == ImageViewerScrollMode.Disabled)
      scrollMode = ImageViewerScrollMode.Auto;

   // Show the values in the label
   string[] controlScrollModeNames = { "Auto", "Hidden", "Disabled" };

   _infoLabel.Text = controlScrollModeNames[(int)scrollMode];

   // Set the new values in _viewer
   _viewer.ScrollMode = scrollMode;
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ImageViewer Class
ImageViewer Members