AnimateEffect Class

Article
08/03/2013

Animate Effect.When the object is serialized out as xml, its qualified name is p:animEffect.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Presentation.AnimateEffect

Namespace: DocumentFormat.OpenXml.Presentation
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(CommonBehavior))> _
<ChildElementInfoAttribute(GetType(Progress))> _
Public Class AnimateEffect _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As AnimateEffect

[ChildElementInfoAttribute(typeof(CommonBehavior))]
[ChildElementInfoAttribute(typeof(Progress))]
public class AnimateEffect : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

CommonBehavior <p:cBhvr>
Progress <p:progress>

[ISO/IEC 29500-1 1st Edition]

19.5.3 animEffect (Animate Effect)

This animation behavior provides the ability to do image transform/filter effects on elements. Some visual effects are dynamic in nature and have a progress that animates from 0 to 1 over a period of time to do visual transitions between hidden and visible states. Other filters are static and apply a effects like a blur or drop-shadow which aren't inherently time-based.

[Example: Consider trying to emphasize a shape by creating an entrance animation using a "blinds" motion.

<p:animEffect transition="in" filter="blinds(horizontal)">
  <p:cBhvr>
    <p:cTn id="7" dur="500"/>
    <p:tgtEl>
      <p:spTgt spid="4"/>
    </p:tgtEl>
  </p:cBhvr>
</p:animEffect>

end example]

Parent Elements
childTnLst (§19.5.25); subTnLst (§19.5.78); tnLst (§19.5.87)

Child Elements	Subclause
cBhvr (Common Behavior)	§19.5.22
progress (Progress)	§19.5.57

Attributes	Description
filter (Filter)	This attribute specifies the animation types and subtypes to be used for the effect. Multiple animations are allowed to be listed so that in the event that a superseding animation (leftmost) cannot be rendered, a fallback animation is available. That is, the rendering application parses the list from left to right until a supported animation is found. The syntax used for the filter attribute value is as follows: "type(subtype);type(subtype)". Subtype can be a string value such as "fromLeft" or a numerical value depending on the type specified. Reserved Animation Types(subtypes): Value Description blinds(horizontal) blinds(vertical) box(in) box(out) checkerboard(across) checkerboard(down) circle diamond dissolve fade slide(fromTop) slide(fromBottom) slide(fromLeft) slide(fromRight) plus(in) plus(out) barn(inVertical) barn(inHorizontal) barn(outVertical) barn(outHorizontal) randomBars(horizontal) randomBars(vertical) strips(downLeft) strips(upLeft) strips(downRight) strips(upRight) wedge wheel(1) wheel(2) wheel(3) wheel(4) wheel(8) wipe(right) wipe(left) wipe(down) wipe(up) [Note: The renderings shown above are for example purposes only. Exact rendering of any animation is determined by the rendering application. As such, the same animation can have many variations, depending on the implementation. More detail for each rendering above can be found in transition (§19.3.1.50). end note] [Example: Consider the following animation effect: `<p:animEffect transition="in" filter="blinds(horizontal);blinds(vertical)"> <p:cBhvr> <p:cTn id="7" dur="500"/> <p:tgtEl> <p:spTgtspid="5"/> </p:tgtEl> </p:cBhvr> </p:animEffect>` There are two animation filters shown in this example. The first is the blinds (horizontal), which the rendering application is to use as the primary animation effect. If, however, the rendering application does not support this animation, the blinds (vertical) animation is used. In this example there are only two animation filters listed, a primary and a fallback, but it is possible to list multiple fallback filters using the syntax defined above. end example] The possible values for this attribute are defined by the W3C XML Schema string datatype.
prLst (Property List)	This attribute specifies a list of properties that coincide with the effect specified. Although there are many animation types allowed, this attribute allows the setting of specific property settings in order to describe an even wider variety of animation types. The syntax used for the prLst attribute value is as follows: “name:value;name:value”. When multiple animation types are listed in the filter attribute, the rendering application attempts to apply each property value even though some might not apply to it. Reserved Names(values): •opacity (float values of 0.0 - 1.0) [Example: Consider the following animation effect: `<p:animEffect filter="image" prLst="opacity: 0.5"> <p:cBhvr rctx="IE"> <p:cTn id="7" dur="indefinite"/> <p:tgtEl> <p:spTgtspid="3"/> </p:tgtEl> </p:cBhvr> </p:animEffect>` The animation filter specified is an image filter type that has a specific property called opacity set to a value of 0.5. end example] The possible values for this attribute are defined by the W3C XML Schema string datatype.
transition (Transition)	This attribute specifies whether to transition the element in or out or treat it as a static filter. The values are "none", "in" and "out", and the default value is "in". When a value of "in" is specified, the element is not visible at the start of the animation and is completely visible be the end of the duration. When "out" is specified, the element is visible at the start and not visible at the end of the effect. This visibility is in addition to the effect of setting CSS visibility or display attributes. The possible values for this attribute are defined by the ST_TLAnimateEffectTransition simple type (§19.7.24).

Attributes

Description

filter (Filter)

This attribute specifies the animation types and subtypes to be used for the effect. Multiple animations are allowed to be listed so that in the event that a superseding animation (leftmost) cannot be rendered, a fallback animation is available. That is, the rendering application parses the list from left to right until a supported animation is found.

The syntax used for the filter attribute value is as follows: "type(subtype);type(subtype)". Subtype can be a string value such as "fromLeft" or a numerical value depending on the type specified.

Reserved Animation Types(subtypes):

Value

Description

blinds(horizontal)

DocumentFormat.OpenXml.Presentation.AnimateEffect-

blinds(vertical)

box(in)

box(out)

checkerboard(across)

checkerboard(down)

circle

diamond

dissolve

fade

slide(fromTop)

slide(fromBottom)

slide(fromLeft)

slide(fromRight)

plus(in)

plus(out)

barn(inVertical)

barn(inHorizontal)

barn(outVertical)

barn(outHorizontal)

randomBars(horizontal)

randomBars(vertical)

strips(downLeft)

strips(upLeft)

strips(downRight)

strips(upRight)

wedge

wheel(1)

wheel(2)

wheel(3)

wheel(4)

wheel(8)

wipe(right)

wipe(left)

wipe(down)

wipe(up)

[Note: The renderings shown above are for example purposes only. Exact rendering of any animation is determined by the rendering application. As such, the same animation can have many variations, depending on the implementation. More detail for each rendering above can be found in transition (§19.3.1.50). end note]

[Example: Consider the following animation effect:

<p:animEffect transition="in" filter="blinds(horizontal);blinds(vertical)">
  <p:cBhvr>
    <p:cTn id="7" dur="500"/>
      <p:tgtEl>
        <p:spTgtspid="5"/>
      </p:tgtEl>
  </p:cBhvr>
</p:animEffect>

There are two animation filters shown in this example. The first is the blinds (horizontal), which the rendering application is to use as the primary animation effect. If, however, the rendering application does not support this animation, the blinds (vertical) animation is used. In this example there are only two animation filters listed, a primary and a fallback, but it is possible to list multiple fallback filters using the syntax defined above.

end example]

The possible values for this attribute are defined by the W3C XML Schema string datatype.

prLst (Property List)

This attribute specifies a list of properties that coincide with the effect specified. Although there are many animation types allowed, this attribute allows the setting of specific property settings in order to describe an even wider variety of animation types.

The syntax used for the prLst attribute value is as follows: “name:value;name:value”. When multiple animation types are listed in the filter attribute, the rendering application attempts to apply each property value even though some might not apply to it.

Reserved Names(values):

•opacity (float values of 0.0 - 1.0)

[Example: Consider the following animation effect:

<p:animEffect filter="image" prLst="opacity: 0.5">
  <p:cBhvr rctx="IE">
    <p:cTn id="7" dur="indefinite"/>
    <p:tgtEl>
      <p:spTgtspid="3"/>
    </p:tgtEl>
  </p:cBhvr>
</p:animEffect>

The animation filter specified is an image filter type that has a specific property called opacity set to a value of 0.5. end example]

The possible values for this attribute are defined by the W3C XML Schema string datatype.

transition (Transition)

This attribute specifies whether to transition the element in or out or treat it as a static filter. The values are "none", "in" and "out", and the default value is "in".

When a value of "in" is specified, the element is not visible at the start of the animation and is completely visible be the end of the duration. When "out" is specified, the element is visible at the start and not visible at the end of the effect. This visibility is in addition to the effect of setting CSS visibility or display attributes.

The possible values for this attribute are defined by the ST_TLAnimateEffectTransition simple type (§19.7.24).

[Note: The W3C XML Schema definition of this element’s content model (CT_TLAnimateEffectBehavior) is located in §A.3. end note]

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

AnimateEffect Class

Inheritance Hierarchy

Syntax

Remarks

Thread Safety

See Also

Reference

Additional resources