Scroller Element

Scrolls content.

Syntax

<Scroller
    Alpha="float"
    AnimationsEnabled="{true | false}"
    CenterPointOffset="Vector3"
    CenterPointPercent="Vector3"
    ColorFilter="Color"
    ColorMask="Color"
    DebugOutline="Color"
    FadeAmount="float"
    FadeSize="float"
    FarOffset="float"
    FocusOrder="int"
    FocusPadding="int"
    Layout="{Anchor | Center | Dock | Fill | Form | Grid | HorizontalFlow | Rotate | Scale | VerticalFlow}"
    LayoutInput="LayoutInput"
    Margins="Inset"
    MaximumSize="Size"
    MinimumSize="Size"
    MouseInteractive="{true | false}"
    Name="string"
    Navigation="NavigationPolicies enumeration"
    NearOffset="float"
    Orientation="{Horizontal | Vertical}"
    Padding="Inset"
    Prefetch="float"
    Rotation="Rotation"
    Scale="Vector3"
    ScrollingData="ScrollingData element"
    ShowFar="{true | false}"
    ShowNear="{true | false}"
    TouchInteractive="{true | false}"
    Visible="{true | false}"
>
    <Animations />
    <Children />
    <Layout />
    <LayoutInput />
</Scroller>

Attributes

Alpha

Specifies the opacity value for the view item. This value must be between 0.0 and 1.0.

AnimationsEnabled

Specifies whether animations are enabled for the view item and child elements.

Animations

Contains a list of elements that describe an animation. Possible elements are:

Animation

MergeAnimation

SwitchAnimation

TransformAnimation

TransformByAttributeAnimation

CenterPointOffset

Specifies a center point adjustment based on a pixel-offset value when applying a scale or rotation to the view item. This value is applied after the CenterPointPercent value has been applied if both are provided. Use the inline construction for the Vector3 structure.

CenterPointPercent

Specifies a center point adjustment based on a percentage value when applying a scale or rotation to the view item. This value must be between 0 and 1, where a value of 1 equals 100%. Use the inline construction for the Vector3 structure.

Children

Specifies the child elements for a view item. Only one child is allowed. Possible child elements are:

Clip

ColorFill

Graphic

Host

Panel

Repeater

Scroller

Text

Video

ColorFilter

Indicates the Color filter to apply on top of the color of the view item.

ColorMask

Defines what sort of Color effect the edge fade will have. By default it is an alpha fade.

DebugOutline

Enables and sets the Color of the debugging outline of the view item.

FadeAmount

Defines the severity of the fade based on a percentage value. This value must be between 0 and 1, where a value of 1 equals 100%.

FadeSize

Indicates the size of the clip fade, in pixels.

FarOffset

Specifies the offset for the far edge of the gradient (dependent on the orientation).

FocusOrder

Specifies relative priorities to sibling view items within the container for determining which item has default focus when entering a UI. Values can range from 0 (the highest priority) to Int32.MaxValue (the lowest priority and the default).

FocusPadding

Specifies the amount of space around the focus area to ensure it is in view.

Layout

Specifies the current layout associated with this view item. You can use the inline construction or expanded syntax with the following child elements that define a layout:

AnchorLayout

DockLayout

FlowLayout

GridLayout

RotateLayout

ScaleLayout

LayoutInput

Specifies the layout input for use by parent layouts. You can use the inline construction to specify a reference to a layout element, or use expanded syntax with the following child elements that define input:

AnchorLayoutInput

DockLayoutInput

FormLayoutInput

Margins

An Inset structure that specifies extra spacing outside the boundaries of the view item.

MaximumSize

Specifies the maximum Size, in pixels. If a maximum size is not specified or the maximum size is set to zero, the size will not be restricted.

MinimumSize

Specifies the minimum Size, in pixels. If a maximum size is not specified or the maximum size is set to zero, the size will not be restricted.

MouseInteractive

Determines whether the view item can receive and react to mouse input.

Name

Identifies this element.

Navigation

Specifies how the view item should behave during directional navigation. This value must be a member of the NavigationPolicies enumeration.

NearOffset

Specifies the offset for the near edge of the gradient (dependent on the orientation).

Orientation

Specifies the orientation of the scrolling. This value must be a member of the Orientation enumeration.

Padding

An Inset structure that specifies the extra spacing, in pixels, between the view item and its child elements.

Prefetch

Amount of area beyond the visible scrolling area to have content ready.

Rotation

Applies a Rotation to the view item. Use the inline construction for this element.

Scale

A Vector3 structure that applies a scaling factor to the view item. Use the inline construction for this element.

ScrollingData

Specifies a reference to a ScrollingData element that defines the scroller configuration.

ShowFar

Indicates whether to display the far fade.

ShowNear

Indicates whether to display the near fade.

TouchInteractive

Determines whether the view item can receive and react to touch input.

Visible

Indicates whether the view item is visible.

Public Instance Methods

MethodDescription
AttachAnimationDynamically adds an animation.
DetachAnimationDynamically removes an animation from the view item.
ForceContentChangeManually forces a content change for animations.
NavigateIntoRequests navigation into the view item to send focus to the view item or one of its children.

Remarks

A Scroller view item can have only one child.

Requirements

Platform: Windows Vista Ultimate, Windows Vista Home Premium, and later

See Also

Show: