CarouselPanel.PointPathFunction Property

Gets or sets a piece-linear function that specifies a path for the Carousel’s items.

Namespace: DevExpress.Xpf.Carousel

Assembly: DevExpress.Xpf.Carousel.v19.2.dll

Declaration

C#

public PieceLinearFunction PointPathFunction { get; set; }

VB.NET

Public Property PointPathFunction As PieceLinearFunction

Property Value

Type	Description
DevExpress.Xpf.Carousel.PieceLinearFunction	A DevExpress.Xpf.Carousel.PieceLinearFunction object that specifies the path.

Remarks

You can specify a path for a Carousel’s items via the CarouselPanel.ItemMovingPath or PointPathFunction property. If a path is specified via the CarouselPanel.ItemMovingPath property, the Carousel’s items are evenly arranged along the path.

If the PointPathFunction property is used to specifiy a path, the CarouselPanel.ItemMovingPath property is ignored, and the Carousel’s items are displayed strictly at the points defined by the PointPathFunction function.

Example

This example shows how to anchor a Carousel's items to specific points along a path.

Items can be anchored to points by specifying a path via the PointPathFunction property. In the example, a complex piece linear function is defined. Items are displayed within points specified by the function.

The following image shows the result:

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-anchor-a-carousels-items-to-specific-points-e1707.

Window1.xaml

<Window x:Class="CarouselPointPathFunction.Window1" 
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
        xmlns:dxca="http://schemas.devexpress.com/winfx/2008/xaml/carousel"
        Title="Window1" Height="300" Width="548" >
    <Grid>
        <Grid.Resources>
            <Style TargetType="{x:Type Rectangle}" BasedOn="{StaticResource {ComponentResourceKey TypeInTargetAssembly={x:Type dxca:CarouselPanel}, ResourceId=advancedCarouselItemStyle}}">
                <Setter Property="Opacity" Value="1" />
            </Style>
        </Grid.Resources>

        <dxca:CarouselPanel Margin="12" Name="carouselPanel1" VisibleItemCount="5" ActiveItemIndex="3">
            <dxca:CarouselPanel.PointPathFunction>
                <dxca:PieceLinearFunction>
                    <dxca:PieceLinearFunction.Points>
                        <dxca:PointCollection>
                            <Point X="0" Y="100" />
                            <Point X="50" Y="100" />
                            <Point X="100" Y="100" />
                            <Point X="100" Y="0" />
                            <Point X="160" Y="100" />
                            <Point X="280" Y="100" />
                            <Point X="300" Y="100" />
                        </dxca:PointCollection>
                    </dxca:PieceLinearFunction.Points>
                </dxca:PieceLinearFunction>
            </dxca:CarouselPanel.PointPathFunction>

            <Rectangle Fill="Red" />
            <Rectangle Fill="Green" />
            <Rectangle Fill="Blue" />
            <Rectangle Fill="Yellow" />
            <Rectangle Fill="Cyan" />
            <Rectangle Fill="Orchid" />
            <Rectangle Fill="Black" />
            <Rectangle Fill="Orange" />
        </dxca:CarouselPanel>
    </Grid>
</Window>

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PointPathFunction property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-anchor-a-carousels-items-to-specific-points-e1707/VB/CarouselPointPathFunction/Window1.xaml#L14

<dxca:CarouselPanel Margin="12" Name="carouselPanel1" VisibleItemCount="5" ActiveItemIndex="3">
    <dxca:CarouselPanel.PointPathFunction>
        <dxca:PieceLinearFunction>