ParallaxView Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Represents a container that associates the scroll position of a foreground element, such as a list, with a background element, such as an image. A 3D effect is created from each element having a different scrolling rate.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.UI.Xaml.Markup.ContentProperty(Name="Child")]
/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class ParallaxView : FrameworkElement

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.UI.Xaml.Markup.ContentProperty(Name="Child")]
[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class ParallaxView : FrameworkElement

Public Class ParallaxView
Inherits FrameworkElement

<ParallaxView .../>

Inheritance

FrameworkElement

ParallaxView

Attributes

MarshalingBehaviorAttribute ThreadingAttribute ContentPropertyAttribute Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackAttribute Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodNameAttribute ContractVersionAttribute

Examples

Tip

For more info, design guidance, and code examples, see Parallax.

The WinUI 3 Gallery and WinUI 2 Gallery apps include interactive examples of most WinUI 3 and WinUI 2 controls, features, and functionality.

If installed already, open them by clicking the following links: WinUI 3 Gallery or WinUI 2 Gallery.

If they are not installed, you can download the WinUI 3 Gallery and the WinUI 2 Gallery from the Microsoft Store.

You can also get the source code for both from GitHub (use the main branch for WinUI 3 and the winui2 branch for WinUI 2).

Constructors

ParallaxView()

Initializes a new instance of the ParallaxView class. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Properties

Child	Gets or sets the background content of the ParallaxView. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ChildProperty	Identifies the Child dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalShift	Represents the horizontal range of motion of the child element. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalShiftProperty	Identifies the HorizontalShift dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalSourceEndOffset	Represents the horizontal scroll offset at which the parallax motion ends. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalSourceEndOffsetProperty	Identifies the HorizontalSourceEndOffset dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalSourceOffsetKind	Gets or sets a value that determines how the horizontal source offset values of a ParallaxView are interpreted. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalSourceOffsetKindProperty	Identifies the HorizontalSourceOffsetKind dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalSourceStartOffset	Represents the horizontal scroll offset at which parallax motion starts. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalSourceStartOffsetProperty	Identifies the HorizontalSourceStartOffset dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsHorizontalShiftClamped	Gets or sets a value that indicates whether the horizontal parallax ratio is clampled to a specified percentage of the source scroll velocity. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsHorizontalShiftClampedProperty	Identifies the IsHorizontalShiftClamped dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsVerticalShiftClamped	Gets or sets a value that indicates whether the vertical parallax ratio is clampled to a specified percentage of the source scroll velocity. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsVerticalShiftClampedProperty	Identifies the IsVerticalShiftClamped dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MaxHorizontalShiftRatio	Clamps the horizontal parallax ratio to the specified percentage of the source scroll velocity. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MaxHorizontalShiftRatioProperty	Identifies the MaxHorizontalShiftRatio dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MaxVerticalShiftRatio	Clamps the vertical parallax ratio to the specified percentage of the source scroll velocity. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MaxVerticalShiftRatioProperty	Identifies the MaxVerticalShiftRatio dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Source	The element that either is or contains the ScrollViewer that controls the parallax operation. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SourceProperty	Identifies the Source dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalShift	Represents the vertical range of motion of the child element. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalShiftProperty	Identifies the VerticalShift dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalSourceEndOffset	Represents the vertical scroll offset at which the parallax motion ends. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalSourceEndOffsetProperty	Identifies the VerticalSourceEndOffset dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalSourceOffsetKind	Gets or sets a value that determines how the vertical source offset values of a ParallaxView are interpreted. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalSourceOffsetKindProperty	Identifies the VerticalSourceOffsetKind dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalSourceStartOffset	Represents the vertical scroll offset at which parallax motion starts. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalSourceStartOffsetProperty	Identifies the VerticalSourceStartOffset dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Methods

RefreshAutomaticHorizontalOffsets()	Forces the automatically computed horizontal offsets to be recomputed. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
RefreshAutomaticVerticalOffsets()	Forces the automatically computed vertical offsets to be recomputed. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

See also

• Parallax overview