Page History: Animation Reference
Compare Page Revisions
Page Revision: 2010/05/04 21:50
AnimationExtender Server Reference
Extender used to play animations when a control's events fire
AnimationExtender Server Properties
| Name | Description |
|---|
| OnClick |
OnClick Animation
|
| OnHoverOut |
OnHoverOut Animation
|
| OnHoverOver |
OnHoverOver Animation
|
| OnLoad |
OnLoad Animation
|
| OnMouseOut |
OnMouseOut Animation
|
| OnMouseOver |
OnMouseOver Animation
|
AnimationExtender Server Methods
| Name | Description |
|---|
| OnPreRender(System.EventArgs) |
Change any AnimationTarget references from server control IDs into the ClientIDs
that the animation scripts are expecting.
|
Animation Client Reference
Animation is an abstract base class used as a starting point for all the other animations.
It provides the basic mechanics for the animation (playing, pausing, stopping, timing, etc.)
and leaves the actual animation to be done in the abstract methods getAnimatedValue
and setValue.
Animation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| target | |
Animation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| initialize | |
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the animation.
|
| updated | |
Animation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
ParentAnimation Client Reference
The ParentAnimation serves as a base class for all animations that contain children (such as
, ,
etc.). It does not actually play the animations, so any classes that inherit from it must do so. Any animation
that requires nested child animations must inherit from this class, although it will likely want to inherit off of
or
which will actually play their child animations.
ParentAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| target | |
ParentAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose of the child animations
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the animation.
|
| updated | |
ParentAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
ParallelAnimation Client Reference
The ParallelAnimation plays several animations simultaneously. It inherits from
, but makes itself the owner of all
its child animations to allow the use a single timer and syncrhonization mechanisms shared with
all the children (in other words, the duration properties of any child animations
are ignored in favor of the parent's duration). It is very useful in creating
sophisticated effects through combination of simpler animations.
ParallelAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| target | |
ParallelAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation and make ourselves its owner.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose of the child animations
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
Finish playing all of the child animations
|
| onStart |
Get the child animations ready to play
|
| onStep |
Progress the child animations through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the animation.
|
| updated | |
ParallelAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
SequenceAnimation Client Reference
The SequenceAnimation runs several animations one after the other. It can also
repeat the sequence of animations for a specified number of iterations (which defaults to a
single iteration, but will repeat forever if you specify zero or less iterations). Also, the
SequenceAnimation cannot be a child of a
(or any animation inheriting from it).
SequenceAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInfinite | true if this animation will repeat forever, false otherwise. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| iterations | Number of times to repeatedly play the sequence. If zero or less iterations are specified, the sequence
will repeat forever. The default value is 1 iteration. |
| percentComplete | Percentage of the animation already played. |
| target | |
SequenceAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time
|
| onStep |
Raises an invalid operation exception because this will only be called if a SequenceAnimation
has been nested inside an (or a derived type).
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the sequence of animations from the beginning or where it was left off when paused
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the entire sequence of animations
|
| updated | |
SequenceAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
SelectionAnimation Client Reference
The SelectionAnimation will run a single animation chosen from of its child animations. It is
important to note that the SelectionAnimation ignores the duration and fps
properties, and will let each of its child animations use any settings they please. This is a base class with no
functional implementation, so consider using or
instead.
SelectionAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| target | |
SelectionAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose of the child animations
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| getSelectedIndex |
Get the index of the animation that is selected to be played. If this returns an index outside the bounds of
the child animations array, then nothing is played.
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the animation.
|
| updated | |
SelectionAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
ConditionAnimation Client Reference
The ConditionAnimation is used as a control structure to play a specific child animation
depending on the result of executing the conditionScript. If the conditionScript
evaluates to true, the first child animation is played. If it evaluates to false,
the second child animation is played (although nothing is played if a second animation is not present).
ConditionAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| conditionScript | JavaScript that should evaluate to true or false to determine which
child animation to play. |
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| target | |
ConditionAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose of the child animations
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| getSelectedIndex |
Get the index of the animation that is selected to be played. If this returns an index outside the bounds of
the child animations array, then nothing is played.
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the animation.
|
| updated | |
ConditionAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
CaseAnimation Client Reference
The CaseAnimation is used as a control structure to play a specific child animation depending on
the result of executing the selectScript, which should return the index of the child animation to
play (this is similar to the case or select statements in C#/VB, etc.). If the provided
index is outside the bounds of the child animations array (or if nothing was returned) then we will not play anything.
CaseAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| selectScript | JavaScript that should evaluate to the index of the appropriate child animation to play. If this returns an index outside the bounds of the child animations array, then nothing is played. |
| target | |
CaseAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose of the child animations
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| getSelectedIndex |
Get the index of the animation that is selected to be played. If this returns an index outside the bounds of
the child animations array, then nothing is played.
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the animation.
|
| updated | |
CaseAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
FadeAnimation Client Reference
The FadeAnimation is used to fade an element in or out of view, depending on the
provided , by settings its opacity.
The minimum and maximum opacity values can be specified to precisely control the fade.
You may also consider using or
if you know the only direction you
are fading.
FadeAnimation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| effect | Determine whether to fade the element in or fade the element out. The possible values are
FadeIn and FadeOut. The default value is FadeOut. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| forceLayoutInIE | Whether or not we should force a layout to be created for Internet Explorer by giving it a width and setting its
background color (the latter is required in case the user has ClearType enabled). The default value is true.
This is obviously ignored when working in other browsers. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| maximumOpacity | Maximum opacity to use when fading in or out. Its value can range from between 0 to 1.
The default value is 1. |
| minimumOpacity | Minimum opacity to use when fading in or out. Its value can range from between 0 to 1.
The default value is 0. |
| percentComplete | Percentage of the animation already played. |
| target | |
FadeAnimation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Determine the current opacity after the given percentage of its duration has elapsed
|
| initialize | |
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current opacity of the element.
|
| stop |
Stop playing the animation.
|
| updated | |
FadeAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
FadeInAnimation Client Reference
The FadeInAnimation will fade the target in by moving from hidden to visible.
It starts the animation the target's current opacity.
FadeInAnimation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| effect | Determine whether to fade the element in or fade the element out. The possible values are
FadeIn and FadeOut. The default value is FadeOut. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| forceLayoutInIE | Whether or not we should force a layout to be created for Internet Explorer by giving it a width and setting its
background color (the latter is required in case the user has ClearType enabled). The default value is true.
This is obviously ignored when working in other browsers. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| maximumOpacity | Maximum opacity to use when fading in or out. Its value can range from between 0 to 1.
The default value is 1. |
| minimumOpacity | Minimum opacity to use when fading in or out. Its value can range from between 0 to 1.
The default value is 0. |
| percentComplete | Percentage of the animation already played. |
| target | |
FadeInAnimation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Determine the current opacity after the given percentage of its duration has elapsed
|
| initialize | |
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current opacity of the element.
|
| stop |
Stop playing the animation.
|
| updated | |
FadeInAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
FadeOutAnimation Client Reference
The FadeInAnimation will fade the element out by moving from visible to hidden. It starts the animation
at the element's current opacity.
FadeOutAnimation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| effect | Determine whether to fade the element in or fade the element out. The possible values are
FadeIn and FadeOut. The default value is FadeOut. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| forceLayoutInIE | Whether or not we should force a layout to be created for Internet Explorer by giving it a width and setting its
background color (the latter is required in case the user has ClearType enabled). The default value is true.
This is obviously ignored when working in other browsers. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| maximumOpacity | Maximum opacity to use when fading in or out. Its value can range from between 0 to 1.
The default value is 1. |
| minimumOpacity | Minimum opacity to use when fading in or out. Its value can range from between 0 to 1.
The default value is 0. |
| percentComplete | Percentage of the animation already played. |
| target | |
FadeOutAnimation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Determine the current opacity after the given percentage of its duration has elapsed
|
| initialize | |
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current opacity of the element.
|
| stop |
Stop playing the animation.
|
| updated | |
FadeOutAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
PulseAnimation Client Reference
The PulseAnimation fades an element in and our repeatedly to create a pulsating
effect. The iterations determines how many pulses there will be (which defaults
to three, but it will repeat infinitely if given zero or less). The duration
property defines the duration of each fade in or fade out, not the duration of
the animation as a whole.
PulseAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| forceLayoutInIE | Whether or not we should force a layout to be created for Internet Explorer by giving it a width and setting its
background color (the latter is required in case the user has ClearType enabled). The default value is true.
This is obviously ignored when working in other browsers. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInfinite | true if this animation will repeat forever, false otherwise. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| iterations | Number of times to repeatedly play the sequence. If zero or less iterations are specified, the sequence
will repeat forever. The default value is 1 iteration. |
| maximumOpacity | Maximum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 1. |
| minimumOpacity | Minimum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 0. |
| percentComplete | Percentage of the animation already played. |
| target | |
PulseAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time
|
| onStep |
Raises an invalid operation exception because this will only be called if a SequenceAnimation
has been nested inside an (or a derived type).
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the sequence of animations from the beginning or where it was left off when paused
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the entire sequence of animations
|
| updated | |
PulseAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
PropertyAnimation Client Reference
The PropertyAnimation is a useful base animation that will assign the value from
getAnimatedValue to a specified property. You can provide the name of
a property alongside an optional propertyKey (which indicates the value
property
propertyKey, like style
FORMATTER ERROR (":" and "&" not supported in Page Names)).
PropertyAnimation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| property | Property of the target element to set when animating |
| propertyKey | Optional key of the property to be set (which indicates the value propertypropertyKey, like style'backgroundColor'). Note that for the style property, the key must be in a JavaScript friendly format (i.e. backgroundColor instead of background-color). |
| target | |
PropertyAnimation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| getValue |
Get the current value from the property
|
| initialize | |
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current value of the property
|
| stop |
Stop playing the animation.
|
| updated | |
PropertyAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
DiscreteAnimation Client Reference
The DiscreteAnimation inherits from
and sets the value of the property to the elements in a provided array of values.
DiscreteAnimation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| property | Property of the target element to set when animating |
| propertyKey | Optional key of the property to be set (which indicates the value propertypropertyKey, like style'backgroundColor'). Note that for the style property, the key must be in a JavaScript friendly format (i.e. backgroundColor instead of background-color). |
| target | |
| values | Array of possible values of the property that will be iterated over as the animation is played |
DiscreteAnimation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Assign the value whose index corresponds to the current percentage
|
| getValue |
Get the current value from the property
|
| initialize | |
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current value of the property
|
| stop |
Stop playing the animation.
|
| updated | |
DiscreteAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
InterpolatedAnimation Client Reference
The InterpolatedAnimation assigns a range of values between startValue
and endValue to the designated property.
InterpolatedAnimation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| endValue | End of the range of values |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| property | Property of the target element to set when animating |
| propertyKey | Optional key of the property to be set (which indicates the value propertypropertyKey, like style'backgroundColor'). Note that for the style property, the key must be in a JavaScript friendly format (i.e. backgroundColor instead of background-color). |
| startValue | Start of the range of values |
| target | |
InterpolatedAnimation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| getValue |
Get the current value from the property
|
| initialize | |
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current value of the property
|
| stop |
Stop playing the animation.
|
| updated | |
InterpolatedAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
ColorAnimation Client Reference
The ColorAnimation transitions the value of the property between
two colors (although it does ignore the alpha channel). The colors must be 7-character hex strings
(like #246ACF).
ColorAnimation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| endValue | End of the range of values |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| property | Property of the target element to set when animating |
| propertyKey | Optional key of the property to be set (which indicates the value propertypropertyKey, like style'backgroundColor'). Note that for the style property, the key must be in a JavaScript friendly format (i.e. backgroundColor instead of background-color). |
| startValue | Start of the range of values |
| target | |
ColorAnimation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Get the interpolated color values
|
| getRGB |
Convert the color to an RGB triplet
|
| getValue |
Get the current value from the property
|
| initialize | |
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
Determine which dimensions of color will be animated
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current value of the property
|
| stop |
Stop playing the animation.
|
| toColor |
Convert an RBG triplet into a 7-character hex string (like #246ACF)
|
| updated | |
ColorAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
LengthAnimation Client Reference
The LengthAnimation is identical to
except it adds a unit to the value before assigning it to the property.
LengthAnimation Client Properties
| Name | Description |
|---|
| duration | Length of the animation in seconds. The default is 1. |
| endValue | End of the range of values |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| property | Property of the target element to set when animating |
| propertyKey | Optional key of the property to be set (which indicates the value propertypropertyKey, like style'backgroundColor'). Note that for the style property, the key must be in a JavaScript friendly format (i.e. backgroundColor instead of background-color). |
| startValue | Start of the range of values |
| target | |
| unit | Unit of the interpolated values. The default value is 'px'. |
LengthAnimation Client Methods
| Name | Description |
|---|
| beginUpdate | |
| dispose |
Dispose the animation
|
| endUpdate | |
| getAnimatedValue |
Get the interpolated length value
|
| getValue |
Get the current value from the property
|
| initialize | |
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
The onEnd method is called just after the animation is played each time.
|
| onStart |
The onStart method is called just before the animation is played each time.
|
| onStep |
The onStep method is called repeatedly to progress the animation through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current value of the property
|
| stop |
Stop playing the animation.
|
| updated | |
LengthAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
MoveAnimation Client Reference
MoveAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| horizontal | If relative is true, this is the offset to move horizontally. Otherwise this is the x
coordinate on the page where the target should be moved. |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| relative | true if we are moving relative to the current position, false if we are moving absolutely |
| target | |
| unit | Length unit for the size of the target. The default value is 'px'. |
| vertical | If relative is true, this is the offset to move vertically. Otherwise this is the y
coordinate on the page where the target should be moved. |
MoveAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation and make ourselves its owner.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose of the child animations
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
Finish playing all of the child animations
|
| onStart |
Use the target's current position as the starting point for the animation
|
| onStep |
Progress the child animations through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the animation.
|
| updated | |
MoveAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|
ResizeAnimation Client Reference
The ResizeAnimation changes the size of the target from its
current value to the specified width and height.
ResizeAnimation Client Properties
| Name | Description |
|---|
| animations | Array of child animations to be played (there are no assumptions placed on order because it will matter for some
derived animations like , but not for
others like ). To manipulate the child
animations, use the functions add, clear, remove, and removeAt. |
| duration | Length of the animation in seconds. The default is 1. |
| events | The collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code. |
| fps | Number of steps per second. The default is 25. |
| height | New height of the target |
| id | |
| isActive | true if animation is active, false if not. |
| isInitialized | |
| isPlaying | true if animation is playing, false if not. |
| isUpdating | |
| percentComplete | Percentage of the animation already played. |
| target | |
| unit | Length unit for the size of the target. The default value is 'px'. |
| width | New width of the target |
ResizeAnimation Client Methods
| Name | Description |
|---|
| add |
Add an animation as a child of this animation and make ourselves its owner.
|
| beginUpdate | |
| clear |
Clear the array of child animations.
|
| dispose |
Dispose of the child animations
|
| endUpdate | |
| getAnimatedValue |
Determine the state of the animation after the given percentage of its duration has elapsed
|
| initialize |
Initialize the parent along with any child animations that have not yet been initialized themselves
|
| interpolate |
The interpolate function is used to find the appropriate value between starting and
ending values given the current percentage.
|
| onEnd |
Finish playing all of the child animations
|
| onStart |
Use the target's current size as the starting point for the animation
|
| onStep |
Progress the child animations through each frame
|
| pause |
Pause the animation if it is playing. Calling play will resume where
the animation left off.
|
| play |
Play the animation from the beginning or where it was left off when paused.
|
| play |
Create an animation, play it immediately, and dispose it when finished.
|
| raiseEnded |
Raise the ended event
|
| raisePropertyChanged | Raises a change notification event. |
| raiseStarted |
Raise the started event
|
| raiseStep |
Raise the step event
|
| remove |
Remove the animation from the array of child animations.
|
| removeAt |
Remove the animation at a given index from the array of child animations.
|
| setOwner |
Make this animation the child of another animation
|
| setValue |
Set the current state of the animation
|
| stop |
Stop playing the animation.
|
| updated | |
ResizeAnimation Client Events
| Name | Description |
|---|
| disposing | |
| ended |
Adds an event handler for the ended event.
|
| propertyChanged | |
| started |
Adds an event handler for the started event.
|
| step |
Adds an event handler for the step event.
|