Version

CarouselViewSettings Class

Contains settings that support controls which implement Carousel views (e.g., XamCarouselPanel and XamCarouselListBox)).
Syntax
'Declaration
 
Public Class CarouselViewSettings 
   Inherits ViewSettingsBase
public class CarouselViewSettings : ViewSettingsBase 
Remarks

The XamCarouselPanel and the XamCarouselListBox each expose a ViewSettings property (XamCarouselPanel.ViewSettings and XamCarouselListBox.ViewSettings) of type CarouselViewSettings. By manipulating properties on the CarouselViewSettings object you can control how the XamCarouselPanel arranges and applies effects to items.

A partial list of the properties that affect layout and parent effects include:

  • ItemPath - Specifies the path along which items are arranged
  • ItemPathRenderBrush - Specifies a Brush used to fill the path
  • ItemPathRenderPen - Specifies a Pen used to outline the path
  • ItemSize - Specifies the size of items
  • ItemsPerPage - Specifies the maximum number of items that should be displayed at any one time
  • AutoScaleItemContentsToFit - Specifies whether the contents of each item should be scaled to fit within the size specified for each item
  • OpacityEffectStops - Specifies one or more EffectStops (i.e., Offset+Value pairs) that describe how Opacity effects should be applied to each item based on its position in the XamCarouselPanel
  • ScalingEffectStops - Specifies one or more EffectStops (i.e., Offset+Value pairs) that describe how Scaling effects should be applied to each item based on its position in the XamCarouselPanel
  • SkewAngleXEffectStops - Specifies one or more EffectStops (i.e., Offset+Value pairs) that describe how Skewing about the X-axis should be applied to each item based on its position in the XamCarouselPanel
  • SkewAngleYEffectStops - Specifies one or more EffectStops (i.e., Offset+Value pairs) that describe how Skewing about the Y-axis should be applied to each item based on its position in the XamCarouselPanel
  • ZOrderEffectStops - Specifies one or more EffectStops (i.e., Offset+Value pairs) that describe how ZOrder effects should be applied to each item based on its position in the XamCarouselPanel
Refer to the documentation contained within for a complete list of the properties supported by this class and the functionality enabled by each property.

Refer to the Carousel Architecture Overview topic in the Developer's Guide for an explanation of how Carousel presentation works.

Example
The following example demonstrates how to create a CarouselViewSettings object for a XamCarouselPanel and initialize some of its properties. For a description and example of each property, please check the documentation for that property.
<igWindows:XamCarouselPanel x:Name="XamCarouselPanel1">
    
<igWindows:XamCarouselPanel.Resources>
        
<Path Visibility="Hidden" 
                
Fill="{x:Null}" 
                
Stretch="Fill" 
                
Stroke="#FF000000" 
                
x:Key="ovalPath" 
                
Data="M230,239 C230,239 254.00029,48.999465 420.00029,47.999465 586.00029,46.999465 629.00026,157.00004 618.00026,276.00004 607.00026,395.00004 538.91118,531.32446 425.00013,523.00028 164.99995,504.00048 189.99998,154.99988 189.99998,154.99988" 
                
Opacity="0.5" 
                
Margin="0,0,0,0"/>
    
</igWindows:XamCarouselPanel.Resources>
    
    
<igWindows:XamCarouselPanel.ViewSettings>
        
        
<igWindows:CarouselViewSettings 
                
IsListContinuous="True" 
                
ItemPath="{Binding ElementName=ovalPath, Mode=OneWay}" 
                
ItemPathAutoPad="False" 
                
ItemPathPadding="251,50,260,170" 
                
ItemSize="200,200" 
                
ItemPathHorizontalAlignment="Stretch" 
                
ItemPathVerticalAlignment="Stretch" 
                
ItemsPerPage="8" 
                
UseOpacity="True" 
                
UseZOrder="True" >
            
            
<igWindows:CarouselViewSettings.ScalingEffectStops>
                
<igWindows:ScalingEffectStopCollection>
                    
<igWindows:ScalingEffectStop Value="0.3"/>
                    
<igWindows:ScalingEffectStop Offset="0.35" Value="0.7"/>
                    
<igWindows:ScalingEffectStop Offset="0.44" Value="1.5"/>
                    
<igWindows:ScalingEffectStop Offset="0.6" Value="0.4"/>
                    
<igWindows:ScalingEffectStop Offset="0.8" Value="0.3"/>
                    
<igWindows:ScalingEffectStop Offset="1"/>
                
</igWindows:ScalingEffectStopCollection>
            
</igWindows:CarouselViewSettings.ScalingEffectStops>
            
            
<igWindows:CarouselViewSettings.OpacityEffectStops>
                
<igWindows:OpacityEffectStopCollection>
                    
<igWindows:OpacityEffectStop/>
                    
<igWindows:OpacityEffectStop Offset="0.35" Value="0.5"/>
                    
<igWindows:OpacityEffectStop Offset="0.44" Value="1"/>
                    
<igWindows:OpacityEffectStop Offset="0.6" Value="0.5"/>
                    
<igWindows:OpacityEffectStop Offset="0.8" Value="0.2"/>
                    
<igWindows:OpacityEffectStop Offset="1"/>
                
</igWindows:OpacityEffectStopCollection>
            
</igWindows:CarouselViewSettings.OpacityEffectStops>
            
            
<igWindows:CarouselViewSettings.ZOrderEffectStops>
                
<igWindows:ZOrderEffectStopCollection>
                    
<igWindows:ZOrderEffectStop/>
                    
<igWindows:ZOrderEffectStop Offset="0.4" Value="1"/>
                    
<igWindows:ZOrderEffectStop Offset="1"/>
                
</igWindows:ZOrderEffectStopCollection>
            
</igWindows:CarouselViewSettings.ZOrderEffectStops>
            
        
</igWindows:CarouselViewSettings>
        
    
</igWindows:XamCarouselPanel.ViewSettings>
    
    
<Ellipse Width="50" Height="50" Stroke="Black" Fill="Red" />
    
<Ellipse Width="100" Height="50" Stroke="Black" Fill="Green" />
    
<Polygon Points="0, 25, 25, 0, 75, 0, 100, 25, 75, 50, 25, 50" Stroke="Black" Fill="Yellow" />
    
<Rectangle Width="100" Height="50" Stroke="Black" Fill="Purple" />
    
<Polyline Points="0, 25, 25, 0, 50, 25, 25, 50, 0, 25" Stroke="SlateGray" StrokeThickness="2" Fill="Blue"/>
    
<Path Stroke="Black" Fill="Gray" Data="M 10,10 C 10,100 100,-100 100,10" />
    
</igWindows:XamCarouselPanel>
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also