scrollOffset Property

Summary

Scroll offset value.

Syntax

JavaScript Syntax

Object.defineProperty(ImageViewer.prototype, 'scrollOffset', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

scrollOffset: LeadPointD;

Property Value

The current scroll offset value. The default value is 0,0.

Remarks

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

When the value of ScrollMode is ControlScrollMode.Auto, then the value of ScrollOffset contains the current scrollbars offset. When the user clicks and drags on the scrollbars, the value of ScrollOffset (and the scrollbars thumbs) changes accordingly. The minimum value allowed is 0,0 (top-left) and the maximum value allowed is stored in MaximumScrollSize (setting ScrollOffset to MaximumScrollSize will cause the viewer to scroll the view to the bottom-right corner. You can manually pan the image by setting a value in ScrollOffset or calling ScrollBy.

When the value of ScrollMode is ControlScrollMode.Hidden, then the value of ScrollOffset contains the virtual scroll (pan) offset, you can pan the image by changing the value of ScrollOffset or calling ScrollBy. If the value of RestrictScroll is true, then the minimum and maximum scroll values are the same as the case above. If the value of RestrictScroll is false, then there is no minimum and maximum scroll ranges, you are allowed to set ScrollOffset to any value. 0,0 and MaximumScrollSize will still be the values to use if you want to either scroll the image to top-left or right-bottom.