ParallaxView ParallaxView ParallaxView ParallaxView Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents a container that ties the scroll position of a foreground element, such as a list, to a background element, such as an image. As you scroll through the foreground element, it animates the background element to create a parallax effect.

public : class ParallaxView : FrameworkElement, IParallaxViewpublic class ParallaxView : FrameworkElement, IParallaxViewPublic Class ParallaxView Inherits FrameworkElement Implements IParallaxView// You can use this class in JavaScript.
<ParallaxView .../>

Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Inherited Members

Inherited properties

Inherited events

Inherited methods

Constructors

ParallaxView() ParallaxView() ParallaxView() ParallaxView()

Prerelease. Initializes a new instance of the ParallaxView class.

public : ParallaxView()public ParallaxView()Public Sub New()// You can use this method in JavaScript.

Properties

Child Child Child Child

Prerelease. Gets or sets the background content of the ParallaxView.

public : UIElement Child { get; set; }public UIElement Child { get; set; }Public ReadWrite Property Child As UIElement// You can use this property in JavaScript.
<ParallaxView Child="childElement" .../>

Value
UIElement UIElement UIElement UIElement

The background content of the ParallaxView, typically an image. The default is null.

ChildProperty ChildProperty ChildProperty ChildProperty

Prerelease. Identifies the Child dependency property.

public : static DependencyProperty ChildProperty { get; }public static DependencyProperty ChildProperty { get; }Public Static ReadOnly Property ChildProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the Child dependency property.

HorizontalShift HorizontalShift HorizontalShift HorizontalShift

Prerelease. Represents the horizontal range of motion of the child element.

public : double HorizontalShift { get; set; }public double HorizontalShift { get; set; }Public ReadWrite Property HorizontalShift As double// You can use this property in JavaScript.
<ParallaxView HorizontalShift="double" .../>

Value
double double double double

The horizontal range of motion. The default is 0.

Remarks

The default value of 0 means there is no horizontal parallax motion. A value of 100 means the Child element is sized to 100px wider than the ParallaxView, so the range of the parallax motion is 100px.

HorizontalShiftProperty HorizontalShiftProperty HorizontalShiftProperty HorizontalShiftProperty

Prerelease. Identifies the HorizontalShift dependency property.

public : static DependencyProperty HorizontalShiftProperty { get; }public static DependencyProperty HorizontalShiftProperty { get; }Public Static ReadOnly Property HorizontalShiftProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the HorizontalShift dependency property.

HorizontalSourceEndOffset HorizontalSourceEndOffset HorizontalSourceEndOffset HorizontalSourceEndOffset

Prerelease. Represents the horizontal scroll offset at which the parallax motion ends.

public : double HorizontalSourceEndOffset { get; set; }public double HorizontalSourceEndOffset { get; set; }Public ReadWrite Property HorizontalSourceEndOffset As double// You can use this property in JavaScript.
<ParallaxView HorizontalSourceEndOffset="double" .../>

Value
double double double double

The horizontal scroll offset at which parallax motion ends. The default is 0.

HorizontalSourceEndOffsetProperty HorizontalSourceEndOffsetProperty HorizontalSourceEndOffsetProperty HorizontalSourceEndOffsetProperty

Prerelease. Identifies the HorizontalSourceEndOffset dependency property.

public : static DependencyProperty HorizontalSourceEndOffsetProperty { get; }public static DependencyProperty HorizontalSourceEndOffsetProperty { get; }Public Static ReadOnly Property HorizontalSourceEndOffsetProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the HorizontalSourceEndOffset dependency property.

HorizontalSourceOffsetKind HorizontalSourceOffsetKind HorizontalSourceOffsetKind HorizontalSourceOffsetKind

Prerelease. Gets or sets a value that determines how the horizontal source offset values of a ParallaxView are interpreted.

public : ParallaxSourceOffsetKind HorizontalSourceOffsetKind { get; set; }public ParallaxSourceOffsetKind HorizontalSourceOffsetKind { get; set; }Public ReadWrite Property HorizontalSourceOffsetKind As ParallaxSourceOffsetKind// You can use this property in JavaScript.
<ParallaxView HorizontalSourceOffsetKind="parallaxSourceOffsetKindName" .../>

Value
ParallaxSourceOffsetKind ParallaxSourceOffsetKind ParallaxSourceOffsetKind ParallaxSourceOffsetKind

A value of the enumeration that determines how the horizontal source offset values of a ParallaxView are interpreted.

HorizontalSourceOffsetKindProperty HorizontalSourceOffsetKindProperty HorizontalSourceOffsetKindProperty HorizontalSourceOffsetKindProperty

Prerelease. Identifies the HorizontalSourceOffsetKind dependency property.

public : static DependencyProperty HorizontalSourceOffsetKindProperty { get; }public static DependencyProperty HorizontalSourceOffsetKindProperty { get; }Public Static ReadOnly Property HorizontalSourceOffsetKindProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the HorizontalSourceOffsetKind dependency property.

HorizontalSourceStartOffset HorizontalSourceStartOffset HorizontalSourceStartOffset HorizontalSourceStartOffset

Prerelease. Represents the horizontal scroll offset at which parallax motion starts.

public : double HorizontalSourceStartOffset { get; set; }public double HorizontalSourceStartOffset { get; set; }Public ReadWrite Property HorizontalSourceStartOffset As double// You can use this property in JavaScript.
<ParallaxView HorizontalSourceStartOffset="double" .../>

Value
double double double double

The horizontal scroll offset at which parallax motion starts. The default is 0.

HorizontalSourceStartOffsetProperty HorizontalSourceStartOffsetProperty HorizontalSourceStartOffsetProperty HorizontalSourceStartOffsetProperty

Prerelease. Identifies the HorizontalSourceStartOffset dependency property.

public : static DependencyProperty HorizontalSourceStartOffsetProperty { get; }public static DependencyProperty HorizontalSourceStartOffsetProperty { get; }Public Static ReadOnly Property HorizontalSourceStartOffsetProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the HorizontalSourceStartOffset dependency property.

IsHorizontalShiftClamped IsHorizontalShiftClamped IsHorizontalShiftClamped IsHorizontalShiftClamped

Prerelease. Gets or sets a value that indicates whether the horizontal parallax ratio is clampled to a specified percentage of the source scroll velocity.

public : PlatForm::Boolean IsHorizontalShiftClamped { get; set; }public bool IsHorizontalShiftClamped { get; set; }Public ReadWrite Property IsHorizontalShiftClamped As bool// You can use this property in JavaScript.
<ParallaxView IsHorizontalShiftClamped="bool" .../>

Value
PlatForm::Boolean bool bool bool

true if the parallax ratio is clampled to a specified percentage of the source scroll velocity; otherwise, false. The default is true.

IsHorizontalShiftClampedProperty IsHorizontalShiftClampedProperty IsHorizontalShiftClampedProperty IsHorizontalShiftClampedProperty

Prerelease. Identifies the IsHorizontalShiftClamped dependency property.

public : static DependencyProperty IsHorizontalShiftClampedProperty { get; }public static DependencyProperty IsHorizontalShiftClampedProperty { get; }Public Static ReadOnly Property IsHorizontalShiftClampedProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the IsHorizontalShiftClamped dependency property.

IsVerticalShiftClamped IsVerticalShiftClamped IsVerticalShiftClamped IsVerticalShiftClamped

Prerelease. Gets or sets a value that indicates whether the vertical parallax ratio is clampled to a specified percentage of the source scroll velocity.

public : PlatForm::Boolean IsVerticalShiftClamped { get; set; }public bool IsVerticalShiftClamped { get; set; }Public ReadWrite Property IsVerticalShiftClamped As bool// You can use this property in JavaScript.
<ParallaxView IsVerticalShiftClamped="bool" .../>

Value
PlatForm::Boolean bool bool bool

true if the parallax ratio is clampled to a specified percentage of the source scroll velocity; otherwise, false. The default is true.

IsVerticalShiftClampedProperty IsVerticalShiftClampedProperty IsVerticalShiftClampedProperty IsVerticalShiftClampedProperty

Prerelease. Identifies the IsVerticalShiftClamped dependency property.

public : static DependencyProperty IsVerticalShiftClampedProperty { get; }public static DependencyProperty IsVerticalShiftClampedProperty { get; }Public Static ReadOnly Property IsVerticalShiftClampedProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the IsVerticalShiftClamped dependency property.

MaxHorizontalShiftRatio MaxHorizontalShiftRatio MaxHorizontalShiftRatio MaxHorizontalShiftRatio

Prerelease. Clamps the horizontal parallax ratio to the specified percentage of the source scroll velocity.

public : double MaxHorizontalShiftRatio { get; set; }public double MaxHorizontalShiftRatio { get; set; }Public ReadWrite Property MaxHorizontalShiftRatio As double// You can use this property in JavaScript.
<ParallaxView MaxHorizontalShiftRatio="double" .../>

Value
double double double double

The maximum percentage of the source scroll velocity. The default is 1.0.

MaxHorizontalShiftRatioProperty MaxHorizontalShiftRatioProperty MaxHorizontalShiftRatioProperty MaxHorizontalShiftRatioProperty

Prerelease. Identifies the MaxHorizontalShiftRatio dependency property.

public : static DependencyProperty MaxHorizontalShiftRatioProperty { get; }public static DependencyProperty MaxHorizontalShiftRatioProperty { get; }Public Static ReadOnly Property MaxHorizontalShiftRatioProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the MaxHorizontalShiftRatio dependency property.

MaxVerticalShiftRatio MaxVerticalShiftRatio MaxVerticalShiftRatio MaxVerticalShiftRatio

Prerelease. Clamps the vertical parallax ratio to the specified percentage of the source scroll velocity.

public : double MaxVerticalShiftRatio { get; set; }public double MaxVerticalShiftRatio { get; set; }Public ReadWrite Property MaxVerticalShiftRatio As double// You can use this property in JavaScript.
<ParallaxView MaxVerticalShiftRatio="double" .../>

Value
double double double double

The maximum percentage of the source scroll velocity. The default is 1.0.

MaxVerticalShiftRatioProperty MaxVerticalShiftRatioProperty MaxVerticalShiftRatioProperty MaxVerticalShiftRatioProperty

Prerelease. Identifies the MaxVerticalShiftRatio dependency property.

public : static DependencyProperty MaxVerticalShiftRatioProperty { get; }public static DependencyProperty MaxVerticalShiftRatioProperty { get; }Public Static ReadOnly Property MaxVerticalShiftRatioProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the MaxVerticalShiftRatio dependency property.

Source Source Source Source

Prerelease. The element that either is or contains the ScrollViewer that controls the parallax operation.

public : UIElement Source { get; set; }public UIElement Source { get; set; }Public ReadWrite Property Source As UIElement// You can use this property in JavaScript.
<ParallaxView Source="sourceElement" .../>

Remarks

If the source element is not a ScrollViewer, the XAML tree is walked starting at the source element to find an embedded ScrollViewer.

SourceProperty SourceProperty SourceProperty SourceProperty

Prerelease. Identifies the Source dependency property.

public : static DependencyProperty SourceProperty { get; }public static DependencyProperty SourceProperty { get; }Public Static ReadOnly Property SourceProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the Source dependency property.

VerticalShift VerticalShift VerticalShift VerticalShift

Prerelease. Represents the vertical range of motion of the child element.

public : double VerticalShift { get; set; }public double VerticalShift { get; set; }Public ReadWrite Property VerticalShift As double// You can use this property in JavaScript.
<ParallaxView VerticalShift="double" .../>

Value
double double double double

The vertical range of motion. The default is 0.

Remarks

The default value of 0 means there is no vertical parallax motion. A value of 100 means the Child element is sized to 100px taller than the ParallaxView, so the range of the parallax motion is 100px.

VerticalShiftProperty VerticalShiftProperty VerticalShiftProperty VerticalShiftProperty

Prerelease. Identifies the VerticalShift dependency property.

public : static DependencyProperty VerticalShiftProperty { get; }public static DependencyProperty VerticalShiftProperty { get; }Public Static ReadOnly Property VerticalShiftProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the VerticalShift dependency property.

VerticalSourceEndOffset VerticalSourceEndOffset VerticalSourceEndOffset VerticalSourceEndOffset

Prerelease. Represents the vertical scroll offset at which the parallax motion ends.

public : double VerticalSourceEndOffset { get; set; }public double VerticalSourceEndOffset { get; set; }Public ReadWrite Property VerticalSourceEndOffset As double// You can use this property in JavaScript.
<ParallaxView VerticalSourceEndOffset="double" .../>

Value
double double double double

The vertical scroll offset at which parallax motion ends. The default is 0.

VerticalSourceEndOffsetProperty VerticalSourceEndOffsetProperty VerticalSourceEndOffsetProperty VerticalSourceEndOffsetProperty

Prerelease. Identifies the VerticalSourceEndOffset dependency property.

public : static DependencyProperty VerticalSourceEndOffsetProperty { get; }public static DependencyProperty VerticalSourceEndOffsetProperty { get; }Public Static ReadOnly Property VerticalSourceEndOffsetProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the VerticalSourceEndOffset dependency property.

VerticalSourceOffsetKind VerticalSourceOffsetKind VerticalSourceOffsetKind VerticalSourceOffsetKind

Prerelease. Gets or sets a value that determines how the vertical source offset values of a ParallaxView are interpreted.

public : ParallaxSourceOffsetKind VerticalSourceOffsetKind { get; set; }public ParallaxSourceOffsetKind VerticalSourceOffsetKind { get; set; }Public ReadWrite Property VerticalSourceOffsetKind As ParallaxSourceOffsetKind// You can use this property in JavaScript.
<ParallaxView VerticalSourceOffsetKind="parallaxSourceOffsetKindName" .../>

Value
ParallaxSourceOffsetKind ParallaxSourceOffsetKind ParallaxSourceOffsetKind ParallaxSourceOffsetKind

A value of the enumeration that determines how the vertical source offset values of a ParallaxView are interpreted.

VerticalSourceOffsetKindProperty VerticalSourceOffsetKindProperty VerticalSourceOffsetKindProperty VerticalSourceOffsetKindProperty

Prerelease. Identifies the VerticalSourceOffsetKind dependency property.

public : static DependencyProperty VerticalSourceOffsetKindProperty { get; }public static DependencyProperty VerticalSourceOffsetKindProperty { get; }Public Static ReadOnly Property VerticalSourceOffsetKindProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the VerticalSourceOffsetKind dependency property.

VerticalSourceStartOffset VerticalSourceStartOffset VerticalSourceStartOffset VerticalSourceStartOffset

Prerelease. Represents the vertical scroll offset at which parallax motion starts.

public : double VerticalSourceStartOffset { get; set; }public double VerticalSourceStartOffset { get; set; }Public ReadWrite Property VerticalSourceStartOffset As double// You can use this property in JavaScript.
<ParallaxView VerticalSourceStartOffset="double" .../>

Value
double double double double

The vertical scroll offset at which parallax motion starts. The default is 0.

VerticalSourceStartOffsetProperty VerticalSourceStartOffsetProperty VerticalSourceStartOffsetProperty VerticalSourceStartOffsetProperty

Prerelease. Identifies the VerticalSourceStartOffset dependency property.

public : static DependencyProperty VerticalSourceStartOffsetProperty { get; }public static DependencyProperty VerticalSourceStartOffsetProperty { get; }Public Static ReadOnly Property VerticalSourceStartOffsetProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the VerticalSourceStartOffset dependency property.

Methods

RefreshAutomaticHorizontalOffsets() RefreshAutomaticHorizontalOffsets() RefreshAutomaticHorizontalOffsets() RefreshAutomaticHorizontalOffsets()

Prerelease. Forces the automatically computed horizontal offsets to be recomputed.

public : void RefreshAutomaticHorizontalOffsets()public void RefreshAutomaticHorizontalOffsets()Public Function RefreshAutomaticHorizontalOffsets() As void// You can use this method in JavaScript.

RefreshAutomaticVerticalOffsets() RefreshAutomaticVerticalOffsets() RefreshAutomaticVerticalOffsets() RefreshAutomaticVerticalOffsets()

Prerelease. Forces the automatically computed vertical offsets to be recomputed.

public : void RefreshAutomaticVerticalOffsets()public void RefreshAutomaticVerticalOffsets()Public Function RefreshAutomaticVerticalOffsets() As void// You can use this method in JavaScript.