Difference between revisions of "API Panel.Position.StopAnimate"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Stops all animations started by this component | Stops all animations started by this component | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API | | + | ====Class hierarchy==== |
| − | :[[API Panel| | + | [[API Panel|Panel]] |
| − | ::[[API Panel.Position| | + | :[[API Panel.Position|Position]] |
| − | + | ::[[API Panel.Position|StopAnimate]] | |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
| Line 12: | Line 12: | ||
==Parameters== | ==Parameters== | ||
''This function has no parameters'' | ''This function has no parameters'' | ||
| + | |||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | + | This call stops all animations invoked by the caller of the routine through [[API Panel.Position.Animate|Animate]]. The animations are stopped by jumping each animation to the end of its sequence. | |
| + | |||
| + | |||
| + | A component can not stop another components animations, and this can not be used to exit leaving an animation partially complete. For this level of control the [[API Panel.Position.Morph|Morph]] call should be used in a [[Event System.Timer|timer]]. | ||
| + | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.StopAnimate()</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.StopAnimate()</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Stops all animations started by this component
Contents
Parameters
This function has no parameters
Return value
This call does not return a value
Detailed description
This call stops all animations invoked by the caller of the routine through Animate. The animations are stopped by jumping each animation to the end of its sequence.
A component can not stop another components animations, and this can not be used to exit leaving an animation partially complete. For this level of control the Morph call should be used in a timer.
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.Position.StopAnimate()
No additional examples
