Class SlideAnimationCollection

Holds the animation effects for a single slide and exposes authoring methods to add and remove them.

Inheritance

object

SlideAnimationCollection

Implements

IEnumerable<AnimationEffect>

IEnumerable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Presentation.Animation

Assembly: DRIT.Presentation.dll

Syntax

public sealed class SlideAnimationCollection : IEnumerable<AnimationEffect>, IEnumerable

Properties

Count

Gets the number of animation effects on this slide.

Declaration

public int Count { get; }

Property Value

Type	Description
int

this[int]

Gets the effect at the specified zero-based index.

Declaration

public AnimationEffect this[int index] { get; }

Parameters

Type	Name	Description
int	index

Property Value

Type	Description
AnimationEffect

Methods

AddEffect(PresentationChart, EffectChartMajorGroupingType, int, EffectType, EffectSubtype, EffectTriggerType, int, int)

Adds a chart animation effect grouped by series or category.

Declaration

public AnimationEffect AddEffect(PresentationChart targetChart, EffectChartMajorGroupingType groupingType, int groupIndex, EffectType effectType, EffectSubtype effectSubtype, EffectTriggerType triggerType = EffectTriggerType.OnClick, int durationMs = 500, int delayMs = 0)

Parameters

Type	Name	Description
PresentationChart	targetChart
EffectChartMajorGroupingType	groupingType
int	groupIndex
EffectType	effectType
EffectSubtype	effectSubtype
EffectTriggerType	triggerType
int	durationMs
int	delayMs

Returns

Type	Description
AnimationEffect

AddEffect(PresentationChart, EffectChartMinorGroupingType, int, int, EffectType, EffectSubtype, EffectTriggerType, int, int)

Adds a chart animation effect grouped by element within series/category.

Declaration

public AnimationEffect AddEffect(PresentationChart targetChart, EffectChartMinorGroupingType groupingType, int groupIndex, int elementIndex, EffectType effectType, EffectSubtype effectSubtype, EffectTriggerType triggerType = EffectTriggerType.OnClick, int durationMs = 500, int delayMs = 0)

Parameters

Type	Name	Description
PresentationChart	targetChart
EffectChartMinorGroupingType	groupingType
int	groupIndex
int	elementIndex
EffectType	effectType
EffectSubtype	effectSubtype
EffectTriggerType	triggerType
int	durationMs
int	delayMs

Returns

Type	Description
AnimationEffect

AddEffect(PresentationChart, EffectType, EffectSubtype, EffectTriggerType, int, int)

Adds an animation effect on a chart.

Declaration

public AnimationEffect AddEffect(PresentationChart targetChart, EffectType effectType, EffectSubtype effectSubtype, EffectTriggerType triggerType = EffectTriggerType.OnClick, int durationMs = 500, int delayMs = 0)

Parameters

Type	Name	Description
PresentationChart	targetChart
EffectType	effectType
EffectSubtype	effectSubtype
EffectTriggerType	triggerType
int	durationMs
int	delayMs

Returns

Type	Description
AnimationEffect

AddEffect(AbstractShape, EffectPresetClassType, int, EffectTriggerType, int, int)

Adds an animation effect on targetShape.

Declaration

public AnimationEffect AddEffect(AbstractShape targetShape, EffectPresetClassType presetClass, int presetId, EffectTriggerType triggerType = EffectTriggerType.OnClick, int durationMs = 500, int delayMs = 0)

Parameters

Type	Name	Description
AbstractShape	targetShape	The shape to animate. Must not be null.
EffectPresetClassType	presetClass	Whether this is an entrance, exit, or emphasis effect.
int	presetId	The preset animation number. Use constants in AnimationPresetId or supply a custom integer value.
EffectTriggerType	triggerType	When the effect starts. Defaults to OnClick.
int	durationMs	Duration of the animation in milliseconds. Defaults to 500.
int	delayMs	Delay in milliseconds before the animation begins. Defaults to 0.

Returns

Type	Description
AnimationEffect	The newly created AnimationEffect.

AddMotionEffect(AbstractShape, IMotionPath, EffectTriggerType, int, int, MotionOriginType, MotionPathEditMode)

Adds a custom motion-path animation on targetShape.

Declaration

public AnimationEffect AddMotionEffect(AbstractShape targetShape, IMotionPath motionPath, EffectTriggerType triggerType = EffectTriggerType.OnClick, int durationMs = 500, int delayMs = 0, MotionOriginType origin = MotionOriginType.Parent, MotionPathEditMode pathEditMode = MotionPathEditMode.Relative)

Parameters

Type	Name	Description
AbstractShape	targetShape	The shape to animate. Must not be null.
IMotionPath	motionPath	The path followed by the shape. Must not be null or empty.
EffectTriggerType	triggerType	When the effect starts.
int	durationMs	Duration of the animation in milliseconds.
int	delayMs	Delay in milliseconds before the animation begins.
MotionOriginType	origin	The coordinate system used by the motion path.
MotionPathEditMode	pathEditMode	How the path behaves when the shape is moved.

Returns

Type	Description
AnimationEffect	The newly created motion-path AnimationEffect.

Clear()

Removes all animation effects from this slide.

Declaration

public void Clear()

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<AnimationEffect> GetEnumerator()

Returns

Type	Description
IEnumerator<AnimationEffect>	An enumerator that can be used to iterate through the collection.

Remove(AnimationEffect)

Removes the specified effect from the collection.

Declaration

public bool Remove(AnimationEffect effect)

Parameters

Type	Name	Description
AnimationEffect	effect

Returns

Type	Description
bool	true if the effect was found and removed; otherwise false.

Implements

IEnumerable<T>

IEnumerable