EffectStop Class

Abstract base class that represents an EffectStop and contains an Offset and a Value.

Syntax

Visual Basic

'Declaration
 
Public MustInherit Class EffectStop 
   Inherits Infragistics.DependencyObjectNotifier

C#

public abstract class EffectStop : Infragistics.DependencyObjectNotifier 

Remarks

There are 5 specific effect stop types derived from this base class:

• OpacityEffectStop - Defines an EffectStop used to apply Opacity effects to items.
• ScalingEffectStop - Defines an EffectStop used to apply Scaling effects to items.
• SkewAngleXEffectStop - Defines an EffectStop used to apply Skewing effects along the X-axis to items.
• SkewAngleYEffectStop - Defines an EffectStop used to apply Skewing effects along the Y-axis to items.
• ZOrderEffectStop - Defines an EffectStop used to apply ZOrder effects to items to control their positions in the Z-space.

An EffectStop contains an Offset and a Value which define how a particular parent effect is applied to items in the XamCarouselPanel The XamCarouselPanel supports 5 parent effects the: Opacity, Scaling, Skewing along the X-axis, Skewing along the Y-Axis and ZOrder. Each of the 5 effects has a corresponding EffectStop-derived class that defines an offset and value for applying that effect.

You can define 1 or more EffectStops for each parent effect by creating the appropriate derived EffectStop (e.g., OpacityEffectStop) and adding it to the appropriate derived EffectStopCollection (e.g., OpacityEffectStopCollection).

The 5 effect stop collections are exposed as properties on the CarouselViewSettings object (CarouselViewSettings.OpacityEffectStops, CarouselViewSettings.ScalingEffectStops, CarouselViewSettings.SkewAngleXEffectStops, CarouselViewSettings.SkewAngleYEffectStops, CarouselViewSettings.ZOrderEffectStops). The CarouselViewSettings object is exposed via the ViewSettings properties on both the XamCarouselPanel.XamCarouselPanel.ViewSettings and XamCarouselListBox.XamCarouselListBox.ViewSettings.

When applying a parent effect to an item in the list, the XamCarouselPanel considers 4 pieces of information. For example, when the XamCarouselPanel is deciding how to apply an Opacity effect to an item it considers the following 4 pieces of information:

• The setting of the UseOpacity property to determine if opacity effects are being used. You can use this property to turn Opacity effects on or off. If this property is set to false, the XamCarouselPanel stops its evaluation and does not apply an opacity effect to the item.
• The list of CarouselViewSettings.OpacityEffectStops that have been defined. The XamCarouselPanel uses linear interpolation to establish Values for Offsets that fall between defined stops.
• The value of the OpacityEffectStopDirection property which determines how the 'Offset' of each OpacityEffectStop is evaluated. For example, if the OpacityEffectStopDirection is set to EffectStopDirection.UseItemPath, and the item's position is 50 percent along the CarouselViewSettings.ItemPath, the Value applied to the item's Opacity would be based on an offset of .5. If however, the OpacityEffectStopDirection is set to EffectStopDirection.Vertical, and the item's Y-position in the XamCarouselPanel's display area is one third of the way down from the top of the XamCarouselPanel's display area, the value applied to the item's Opacity would be based on an offset of .3.
• The position of the item in the XamCarouselPanel's display area (used as described in the previous bullet).

The other types of parent effects are evaluated in exactly the same way using correspondingly named properties on the CarouselViewSettings object.

By applying different combinations of EffectStops you can achieve some interesting layout effects in the XamCarouselPanel.

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

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