Difference between revisions of "API Component.Property.SetChildValues"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Sets all child components property as a string
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetChildValues'''
 +
|-
 +
| colspan="2" | Sets all child components property as a string&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Parent
 +
|-
 +
| colspan="2" | The owning component whose children will all be written to&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Property
 +
|-
 +
| colspan="2" | The textual name of the property&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | The value to update the properties text with&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==
−
''[[Variable types|HANDLE]] Parent''
+
This call steps through all the children of the component and sets the property specified in each to the given value. It is useful for updating a property in all the children of a group, for example.
−
:The owning component whose children will all be written to
 
  
−
''[[Variable types|STRING]] Property''
 
−
:The textual name of the property
 
  
−
''[[Variable types|STRING]] Value''
+
Note this does not step through the children of compiled components, only those 'owned' by the ''Parent''.
−
:The value to update the properties text with
 
  
−
===Return value===
 
−
''This call does not return a value''
 
  
−
===Detailed description===
+
==Examples==
−
''No additional information''
+
===Calling in a calculation===
−
 
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetChildValues(parent, "property", "value")</pre>
−
===Examples===
 
−
====Calling in a calculation====
 
−
* Add to a calculation icon: ::Component.Property.SetChildValues(parent, "property", "value")
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png SetChildValues
Sets all child components property as a string 
Fc9-h32-icon.png - HANDLE Parent
The owning component whose children will all be written to 
Fc9-string-icon.png - STRING Property
The textual name of the property 
Fc9-string-icon.png - STRING Value
The value to update the properties text with 
Fc9-void-icon.png - NONE Return


Detailed description

This call steps through all the children of the component and sets the property specified in each to the given value. It is useful for updating a property in all the children of a group, for example.


Note this does not step through the children of compiled components, only those 'owned' by the Parent.


Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::Component.Property.SetChildValues(parent, "property", "value")
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Component.Property.SetChildValues&oldid=30128"