Difference between revisions of "API Panel.LinkBar.Update"

From Flowcode Help
Jump to navigationJump to search
(XML import of LinkBar API)
 
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Update'''
 +
|-
 +
| colspan="2" | Manually refresh the screen the bar exists on 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | LinkBar
 +
|-
 +
| colspan="2" | The handle to the bar to redraw 
 +
|-
 +
| 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''
 +
|}
  
  
<sidebar>API contents</sidebar>
+
==Detailed description==
Manually refresh the screen the point cloud exists on
+
This forces a redraw of the panel the link resides on. This is a useful call if the link is connected to an object that would not redraw the screen on update, such as a hidden component or position object.
 
 
<div style="width:25%; float:right" class="toc">
 
====Class hierarchy====
 
[[API Panel|Panel]]
 
:[[API Panel.LinkBar|LinkBar]]
 
::[[API Panel.LinkBar|Update]]
 
</div>
 
__TOC__
 
 
 
==Parameters==
 
[[Variable Types|HANDLE]] ''PCloud''
 
:The handle to the cloud to redraw
 
  
  
==Return value==
+
Note this call does not redraw the screen immediately, but signals to Flowcode the screen requires redrawing.
''This call does not return a value''
 
 
 
 
 
==Detailed description==
 
''<span style="color:red;">No additional information</span>''
 
  
  
Line 28: Line 27:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.Update(pcloud)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.Update(pcloud)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png Update
Manually refresh the screen the bar exists on 
Fc9-h32-icon.png - HANDLE LinkBar
The handle to the bar to redraw 
Fc9-void-icon.png - NONE Return


Detailed description

This forces a redraw of the panel the link resides on. This is a useful call if the link is connected to an object that would not redraw the screen on update, such as a hidden component or position object.


Note this call does not redraw the screen immediately, but signals to Flowcode the screen requires redrawing.


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Panel.LinkBar.Update(pcloud)