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.
|