ScrollViewer Class

SystemObject
  DigitalRune.GameGameObject
    DigitalRune.Game.UI.ControlsUIControl
      DigitalRune.Game.UI.ControlsContentControl
        DigitalRune.Game.UI.ControlsScrollViewer

public class ScrollViewer : ContentControl

Public Class ScrollViewer
	Inherits ContentControl

public ref class ScrollViewer : public ContentControl

type ScrollViewer =  
    class
        inherit ContentControl
    end

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

Top

	Name	Description
	Arrange	Positions child elements and determines a size for a control. (Inherited from UIControl.)
	BringIntoView	Attempts to bring this element into view, within any scrollable regions it is contained within. (Inherited from UIControl.)
	Equals	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 it is reclaimed by garbage collection. (Inherited from Object.)
	Focus	Moves the input focus to this control. (Inherited from UIControl.)
	GetControl	Gets a control by name from the visual subtree of this control. (Inherited from UIControl.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValueT(Int32)	Gets the value of the property with the given ID. (Inherited from GameObject.)
	GetValueT(String)	Gets the value of the property with the given name. (Inherited from GameObject.)
	GetValueT(GamePropertyMetadataT)	Gets the value of the property with the given metadata. (Inherited from GameObject.)
	HitTest	Tests if a position is over a control. (Inherited from ContentControl.)
	InvalidateArrange	Invalidates the arrange state (layout) for the control. (Inherited from UIControl.)
	InvalidateMeasure	Invalidates the measurement state (layout) for the control. (Inherited from UIControl.)
	InvalidateVisual	Invalidates the cached RenderData. (Inherited from UIControl.)
	Load	Loads the content of the game object. (Inherited from GameObject.)
	Measure	Updates the DesiredWidth and DesiredHeight of the control. (Inherited from UIControl.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NewFrame	Tells the game object to prepare itself for the next time step. (Inherited from GameObject.)
	OnArrange	Called by Arrange(Vector2F, Vector2F) to arrange the visual children. (Overrides ContentControlOnArrange(Vector2F, Vector2F).)
	OnContentChanged	Called when the Content was exchanged. (Inherited from ContentControl.)
	OnHandleInput	Called when the control should handle device input. (Overrides UIControlOnHandleInput(InputContext).)
	OnLoad	Called when the game object should load its content. (Overrides UIControlOnLoad.)
	OnMeasure	Called by Measure(Vector2F) to compute the control-specific desired size. (Overrides ContentControlOnMeasure(Vector2F).)
	OnPropertyChanged(PropertyChangedEventArgs)	Raises the PropertyChanged event. (Inherited from GameObject.)
	OnPropertyChangedT(GamePropertyT, T, T)	Is called after a game object property was changed. (Inherited from GameObject.)
	OnPropertyChangedT(GamePropertyT, T, T)	Is called after a game object property was changed. (Inherited from UIControl.)
	OnRender	Called when the control and its visual children should be rendered. (Inherited from UIControl.)
	OnTemplateChanged	Raises the TemplateChanged event. (Inherited from ContentControl.)
	OnUnload	Called when the game object should unload its content. (Overrides UIControlOnUnload.)
	OnUpdate	Called when the game object should be updated. (Overrides UIControlOnUpdate(TimeSpan).)
	Render	Renders the control (including visual children). (Inherited from UIControl.)
	SetValueT(Int32, T)	Sets the value of the property with the given ID. (Inherited from GameObject.)
	SetValueT(String, T)	Sets the value of the property with the given name. (Inherited from GameObject.)
	SetValueT(GamePropertyMetadataT, T)	Set the value of the property for the given metadata. (Inherited from GameObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unload	Unloads the content of the game object. (Inherited from GameObject.)
	Update	Updates this game object. (Inherited from GameObject.)
	UpdateLayout	Ensures that all visual child controls of this element are properly updated for layout. (Inherited from UIControl.)

Top

	Name	Description
	GetAncestors	Gets the ancestors of the control in the visual tree. (Defined by UIHelper.)
	GetDescendants	Overloaded. Gets the descendants of the control in the visual tree using a depth-first search. (Defined by UIHelper.)
	GetDescendants(Boolean)	Overloaded. Gets the descendants of the control in the visual tree using either a depth-first or a breadth-first search. (Defined by UIHelper.)
	GetLeaves	Gets the leaves of the control in the visual tree. (Defined by UIHelper.)
	GetRoot	Returns the root control of the visual tree. (Defined by UIHelper.)
	GetSelfAndAncestors	Gets the control and its ancestors in the visual tree. (Defined by UIHelper.)
	GetSubtree	Overloaded. Gets the subtree (the given control and all of its descendants in the visual tree) using a depth-first search. (Defined by UIHelper.)
	GetSubtree(Boolean)	Overloaded. Gets the subtree (the given control and all of its descendants in the visual tree) using either a depth-first or a breadth-first search. (Defined by UIHelper.)

Top

	Name	Description
	HorizontalOffsetPropertyId	The ID of the HorizontalOffset game object property.
	HorizontalScrollBarStylePropertyId	The ID of the HorizontalScrollBarStyle game object property.
	HorizontalScrollBarVisibilityPropertyId	The ID of the HorizontalScrollBarVisibility game object property.
	VerticalOffsetPropertyId	The ID of the VerticalOffset game object property.
	VerticalScrollBarStylePropertyId	The ID of the VerticalScrollBarStyle game object property.
	VerticalScrollBarVisibilityPropertyId	The ID of the VerticalScrollBarVisibility game object property.

Top

	Name	Description
	ActualBounds	Gets the actual bounding rectangle of the control (defined by ActualX, ActualY, ActualWidth and ActualHeight). (Inherited from UIControl.)
	ActualHeight	Gets the actual height of the control (computed in Arrange(Vector2F, Vector2F)). (Inherited from UIControl.)
	ActualIsEnabled	Gets a value indicating whether this control is actually enabled, taking into account the IsEnabled flag and the state of the VisualParent. (Inherited from UIControl.)
	ActualIsVisible	Gets a value indicating whether this control is actually visible, taking into account the IsVisible flag and the state of the VisualParent. (Inherited from UIControl.)
	ActualWidth	Gets the actual width of the control (computed in Arrange(Vector2F, Vector2F)). (Inherited from UIControl.)
	ActualX	Gets the actual X position of the top left corner of the control's bounds in screen coordinates (computed in Arrange(Vector2F, Vector2F)). (Inherited from UIControl.)
	ActualY	Gets the actual Y position of the top left corner of the control's bounds in screen coordinates (computed in Arrange(Vector2F, Vector2F)). (Inherited from UIControl.)
	AllowedPlayer	Gets or sets the LogicalPlayerIndex from which input is accepted. (Inherited from UIControl.)
	AutoUnfocus	Gets or sets a value indicating whether this control clears the focus when the mouse clicks another control than the currently focused control. This is a game object property. (Inherited from UIControl.)
	Background	Gets or sets the background color. This is a game object property. (Inherited from UIControl.)
	ClipContent	Gets or sets a value indicating whether the Content is clipped to the ContentBounds or whether the Content can draw outside the ContentBounds. This is a game object property. (Inherited from ContentControl.)
	Content	Gets or sets the content. (Inherited from ContentControl.)
	ContentBounds	Gets the content bounds that define where the Content is drawn. (Overrides ContentControlContentBounds.)
	ContentStyle	Gets or sets the style that is applied to the Content. This is a game object property. (Inherited from ContentControl.)
	ContextMenu	Gets or sets the context menu that should pop up when the control is right-clicked (tap-and-hold on Windows Phone 7). (Inherited from UIControl.)
	Cursor	Gets or sets the mouse cursor that should be displayed when the mouse is over this control. (Inherited from UIControl.)
	DesiredHeight	Gets the desired height (including Margin) (which is computed in Measure(Vector2F)). (Inherited from UIControl.)
	DesiredWidth	Gets the desired width (including Margin) (which is computed in Measure(Vector2F)). (Inherited from UIControl.)
	Events	Gets the game object events. (Inherited from GameObject.)
	ExtentHeight	Gets the extent height which is equal to the desired height of the Content.
	ExtentWidth	Gets the extent width which is equal to the desired width of the Content.
	FlickScrollVelocityFactor	Phone/tablet only: Gets or sets the factor that defines the scroll velocity after a flick gesture.
	Focusable	Gets or sets a value indicating whether this UIControl can receive the input focus. This is a game object property. (Inherited from UIControl.)
	FocusWhenMouseOver	Gets or sets a value indicating whether the control automatically receives focus when the mouse is over the control (without being clicked). This is a game object property. (Inherited from UIControl.)
	Font	Gets or sets the font that is used if the control renders text. This is a game object property. (Inherited from UIControl.)
	Foreground	Gets or sets the foreground color. This is a game object property. (Inherited from UIControl.)
	HasRenderTransform	Gets a value indicating whether this control has a render transform that is not the identity transformation. (Inherited from UIControl.)
	Height	Gets or sets the user-defined height. This is a game object property. (Inherited from UIControl.)
	HorizontalAlignment	Gets or sets the horizontal alignment of this control. This is a game object property. (Inherited from UIControl.)
	HorizontalOffset	Gets or sets the horizontal offset (= the Value of the horizontal ScrollBar). This is a game object property.
	HorizontalScrollBarStyle	Gets or sets the style that is applied to the horizontal ScrollBar. This is a game object property.
	HorizontalScrollBarVisibility	Gets or sets the ScrollBarVisibility of the horizontal ScrollBar. This is a game object property.
	InputService	Gets the IInputService. (Inherited from UIControl.)
	IsArrangeValid	Gets a value indicating whether the Arrange(Vector2F, Vector2F) results are up-to-date. (Inherited from UIControl.)
	IsEnabled	Gets or sets a value indicating whether this control is enabled. This is a game object property. (Inherited from UIControl.)
	IsFocused	Gets a value indicating whether this control has the input focus. This is a game object property. (Inherited from UIControl.)
	IsFocusScope	Gets or sets a value indicating whether this control is a focus scope. This is a game object property. (Inherited from UIControl.)
	IsFocusWithin	Gets (or sets) a value indicating whether the focus is on this control or on any of the visual children. (Inherited from UIControl.)
	IsLoaded	Gets a value indicating whether the content of this object was loaded. (Inherited from GameObject.)
	IsMeasureValid	Gets a value indicating whether the Measure(Vector2F) results (DesiredWidth and DesiredHeight) are up-to-date. (Inherited from UIControl.)
	IsMouseDirectlyOver	Gets a value indicating whether the mouse is over this control and not over a visual child control. (Inherited from UIControl.)
	IsMouseOver	Gets or sets a value indicating whether the mouse is over this control or over a visual child. This is a game object property. (Inherited from UIControl.)
	IsVisible	Gets or sets a value indicating whether this control is visible. This is a game object property. (Inherited from UIControl.)
	IsVisualValid	Gets a value indicating whether the cached RenderData is up-to-date. (Inherited from UIControl.)
	Margin	Gets or sets the margin. This is a game object property. (Inherited from UIControl.)
	MaxHeight	Gets or sets the maximal height of the control. This is a game object property. (Inherited from UIControl.)
	MaxScrollVelocity	Phone/tablet only: Gets or sets the maximal allowed scroll velocity. (Higher scrolling velocities are clamped to this value.)
	MaxWidth	Gets or sets the maximal width of the control. This is a game object property. (Inherited from UIControl.)
	MinHeight	Gets or sets the minimal height of the control. This is a game object property. (Inherited from UIControl.)
	MinScrollVelocity	Phone/tablet only: Gets or sets the minimal scroll velocity that determines when scrolling is stopped.
	MinWidth	Gets or sets the minimal width of the control. This is a game object property. (Inherited from UIControl.)
	Name	Gets or sets the name. (Inherited from GameObject.)
	Opacity	Gets or sets the opacity. This is a game object property. (Inherited from UIControl.)
	Padding	Gets or sets the padding. This is a game object property. (Inherited from UIControl.)
	Properties	Gets the game object properties. (Inherited from GameObject.)
	RenderData	Gets or sets the cached renderer data. (Inherited from UIControl.)
	RendererInfo	Obsolete. Gets or sets the cached renderer data. (Inherited from UIControl.)
	RenderRotation	Gets or sets the rotation of the RenderTransform. This is a game object property. (Inherited from UIControl.)
	RenderScale	Gets or sets the scale of the RenderTransform. This is a game object property. (Inherited from UIControl.)
	RenderTransform	Gets the render transformation. (Inherited from UIControl.)
	RenderTransformOrigin	Gets or sets the relative origin of the RenderTransform. This is a game object property. (Inherited from UIControl.)
	RenderTranslation	Gets or sets the translation of the RenderTransform. This is a game object property. (Inherited from UIControl.)
	Screen	Gets the UIScreen. (Inherited from UIControl.)
	ScrollDamping	Phone/tablet only: Gets or sets the damping factor with which the scrolling is damped.
	ScrollThreshold	Gets or sets the vertical scroll threshold that the finger movement has to exceed to start a scroll action.
	SpringConstant	Phone/tablet only: Gets or sets the spring constant which is applied when the user drags the content beyond the limit.
	SpringDamping	Phone/tablet only: Gets or sets the damping which is applied when the user drags the content beyond the limit.
	SpringLength	Phone/tablet only: Gets or sets the max spring length which defines how far the user can drag the content beyond the limit.
	Style	Gets or sets the style. (Inherited from UIControl.)
	Tag	Obsolete. Gets or sets a user-defined tag. (Inherited from UIControl.)
	Template	Gets or sets the template. (Inherited from GameObject.)
	ToolTip	Gets or sets the tool tip. This is a game object property. (Inherited from UIControl.)
	UIService	Gets the IUIService. (Inherited from UIControl.)
	UserData	Gets or sets user-defined data. (Inherited from UIControl.)
	VerticalAlignment	Gets or sets the vertical alignment of this control. This is a game object property. (Inherited from UIControl.)
	VerticalOffset	Gets or sets the vertical offset (= the Value of the vertical ScrollBar). This is a game object property.
	VerticalScrollBarStyle	Gets or sets the style that is applied to the vertical ScrollBar. This is a game object property.
	VerticalScrollBarVisibility	Gets or sets the ScrollBarVisibility of the vertical ScrollBar. This is a game object property.
	ViewportHeight	Gets the height of the viewport which defines the visual part of the Content.
	ViewportWidth	Gets the width of the viewport which defines the visual part of the Content.
	VisualChildren	Gets the visual children. (Inherited from UIControl.)
	VisualParent	Gets the visual parent. (Inherited from UIControl.)
	VisualState	Gets the visual state of the control as string. (Inherited from UIControl.)
	Width	Gets or sets the user-defined width. This is a game object property. (Inherited from UIControl.)
	X	Gets or sets the x-position offset of the control. (Use this only for controls in a Canvas or under the UIScreen.) This is a game object property. (Inherited from UIControl.)
	Y	Gets or sets the y-position offset of the control. (Use this only for controls in a Canvas or under the UIScreen.) This is a game object property. (Inherited from UIControl.)

Top

	Name	Description
	InputProcessed	Occurs after the device input was processed. (Inherited from UIControl.)
	InputProcessing	Occurs before the device input is processed. (Inherited from UIControl.)
	PropertyChanged	Occurs when a property value has changed. (Inherited from GameObject.)
	TemplateChanged	Occurs when the Template changed. (Inherited from GameObject.)

Top

	Name	Description
	INotifyPropertyChangedPropertyChanged	Occurs when a property value has changed. (Inherited from GameObject.)
	IAnimatableObjectGetAnimatablePropertyT	Gets the property with given name and type which can be animated. (Inherited from GameObject.)
	IAnimatableObjectGetAnimatedProperties	Gets either the properties which are currently animated, or all properties which can be animated. (See remarks.) (Inherited from GameObject.)

Top

The ScrollViewer displays a part of the Content, which can be larger than the size of the ScrollViewer.

The visible part can be controlled using two scroll bars or the mouse wheel. When scrolling with the mouse wheel, the scroll speed is proportional to SmallChange.

Phone and Tablets: On phone and tablets the ScrollViewer can be controlled with touch input (only vertical scrolling). A flick gesture creates a scroll velocity that is slowly damped. The vertical scroll bar is transparent by default and becomes visible during scrolling. The dynamic scroll behavior can be configured using MinScrollVelocity, MaxScrollVelocity, ScrollDamping and FlickScrollVelocityFactor, and is the same for all ScrollViewer instances.

The user can push the content beyond the usual limits by dragging the content with the finger or by scrolling really fast. The content automatically bounces back when the user is not touching the control. This effect is simulated with a "damped spring". The properties SpringConstant, SpringDamping and SpringLength control the effect. The visual effect is achieved by applying a scale transform to the DigitalRune.Game.UI.Content (see RenderScale). (Any existing render transform will be overwritten!)

The following example shows to display a large image inside a scroll viewer.

C#

Copy

// Use an image control to display a texture.
var image = new Image
{
  Texture = content.Load<Texture2D>("Image_1024x1024")
};

// Use a scroll viewer to show a region of the texture.
var scrollViewer = new ScrollViewer
{
  Margin = new Vector4F(4),
  Width = 200
  Height = 200,
};
scrollViewer.Content = image;

// To show the scroll viewer, add it to an existing content control or panel.
panel.Children.Add(scrollViewer);

Reference

DigitalRune.Game.UI.Controls Namespace