API Panel.LinkBar.EnableAuto: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	EnableAuto
Sets whether Flowcode should automatically draw links for component object property types
- HANDLE	Component
The component to enable or disable links for
- BOOL	Enable
True to draw default links from this component, else false
- 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)

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''EnableAuto'''
+|-
+| colspan="2" | Sets whether Flowcode should automatically draw links for component object property types&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Component
+|-
+| colspan="2" | The component to enable or disable links for&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Enable
+|-
+| colspan="2" | True to draw default links from this component, else false&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''
+|}
-<sidebar>API contents</sidebar>
+==Detailed description==
-Sets whether Flowcode should automatically draw links for component object property types
+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.
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Panel|Panel]]
-:[[API Panel.LinkBar|LinkBar]]
-::[[API Panel.LinkBar|EnableAuto]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|HANDLE]] ''Component''
-:The component to enable or disable links for
-:''The default value for this parameter is: '''''this'''
-[[Variable Types|BOOL]] ''Enable''
-:True to draw default links from this component, else false
-==Return value==
-''This call does not return a value''
-==Detailed description==
+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.
-''<span style="color:red;">No additional information</span>''
@@ Line 32: / Line 32: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.EnableAuto(component, true)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation