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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets whether Flowcode should automatically draw links for component object property types
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EnableAuto'''
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
| colspan="2" | Sets whether Flowcode should automatically draw links for component object property types&nbsp;
:[[API Panel.LinkBar|LinkBar]]
+
|-
::[[API Panel.LinkBar|EnableAuto]]
+
|-
</div>
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
__TOC__
+
| width="90%" | Component
 
+
|-
==Parameters==
+
| colspan="2" | The component to enable or disable links for&nbsp;
[[Variable Types|HANDLE]] ''Component''
+
|-
:The component to enable or disable links for
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
:''The default value for this parameter is: '''''this'''
+
| width="90%" | Enable
 
+
|-
[[Variable Types|BOOL]] ''Enable''
+
| colspan="2" | True to draw default links from this component, else false&nbsp;
:True to draw default links from this component, else false
+
|-
 
+
| 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''
==Return value==
+
|}
''This call does not return a value''
 
  
  
Line 33: Line 32:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.EnableAuto(component, true)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.EnableAuto(component, true)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png EnableAuto
Sets whether Flowcode should automatically draw links for component object property types 
Fc9-h32-icon.png - HANDLE Component
The component to enable or disable links for 
Fc9-bool-icon.png - BOOL Enable
True to draw default links from this component, else false 
Fc9-void-icon.png - NONE Return


Detailed description

When components create properties linking components Flowcode will, by default, draw links from the source tot he destination. These are simple line-drawn links from the center of the positions.


If greater control or a different style is required, the default behavior may be switched off in the source component (the component which owns the properties) and Flowcodes default behavior can then be replaced by component-managed link bars.


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Panel.LinkBar.EnableAuto(component, true)