Difference between revisions of "API Panel.Position.StopAnimate"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Stops all animations started by this component
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''StopAnimate'''
 +
|-
 +
| colspan="2" | Stops all animations started by this component&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''This function has no parameters''
+
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.
  
−
===Return value===
 
−
''This call does not return a value''
 
  
−
===Detailed description===
+
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]].
−
''No additional information''
 
  
−
===Examples===
+
 
−
====Calling in a calculation====
+
==Examples==
−
* Add to a calculation icon: <pre class="brush:[C]">::Panel.Position.StopAnimate()</pre>
+
===Calling in a calculation===
 +
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.StopAnimate()</pre>

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png StopAnimate
Stops all animations started by this component 
Fc9-void-icon.png - NONE Return


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()
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Panel.Position.StopAnimate&oldid=30167"