API Panel.Position.StopAnimate: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	StopAnimate
Stops all animations started by this component
- 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()
```

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Stops all animations started by this component
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''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''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Panel|Panel]]
-:[[API Panel.Position|Position]]
-::[[API Panel.Position|StopAnimate]]
-</div>
-__TOC__
-==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==
+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]].
-''This call does not return a value''
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 25: / Line 22: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.StopAnimate()</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation