Share via


EffectInformation.AnimateBackground Property

Returns msoTrue if the specified effect is a background animation. Read-only.

Namespace:  Microsoft.Office.Interop.PowerPoint
Assembly:  Microsoft.Office.Interop.PowerPoint (in Microsoft.Office.Interop.PowerPoint.dll)

Syntax

'Declaration
ReadOnly Property AnimateBackground As MsoTriState
    Get
'Usage
Dim instance As EffectInformation
Dim value As MsoTriState

value = instance.AnimateBackground
MsoTriState AnimateBackground { get; }

Property Value

Type: Microsoft.Office.Core.MsoTriState

Remarks

Use the TextLevelEffect and [F:Microsoft.Office.Interop.PowerPoint.EffectInformation.AnimateBackground.ppproTextUnitEffect1_HV05193919.htm#TextUnitEffect#SameCHM] properties to control the animation of text attached to the specified shape.

If this property is set to msoTrue and the TextLevelEffect property is set to ppAnimateByAllLevels, the shape and its text are animated simultaneously. If this property is set to msoTrue and the TextLevelEffect property is set to anything other than ppAnimateByAllLevels, the shape is animated immediately before the text is animated.

You won't see effects of setting this property unless the specified shape is animated. For a shape to be animated, the TextLevelEffect property for the shape must be set to something other than ppAnimateLevelNone, and either the AnimateAction property must be set to msoTrue, or the [F:Microsoft.Office.Interop.PowerPoint.EffectInformation.AnimateBackground.ppproEntryEffect1_HV05192493.htm#EntryEffect#SameCHM] property must be set to a constant other than ppEffectNone.

The value returned by the AnimateBackground property can be one of these MsoTriState constants.

Constant

Description

msoFalse

The specified effect is not a background animation.

msoTrue

The specified effect is a background animation.

Examples

This example changes the direction of the animation if the background is currently animated.

Sub ChangeAnimationDirection()

    With ActivePresentation.Slides(1).TimeLine.MainSequence(1)

        If .EffectInformation.AnimateBackground= msoTrue Then

            .EffectParameters.Direction = msoAnimDirectionTopLeft

        End If

    End With

End Sub

See Also

Reference

EffectInformation Interface

EffectInformation Members

Microsoft.Office.Interop.PowerPoint Namespace