Difference between revisions of "API Component.Property.SetChildValues"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Sets all child components property as a string | Sets all child components property as a string | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
− | ===Class hierarchy===[[API Component|Component]] | + | ====Class hierarchy==== |
+ | [[API Component|Component]] | ||
:[[API Component.Property|Property]] | :[[API Component.Property|Property]] | ||
::[[API Component.Property|SetChildValues]] | ::[[API Component.Property|SetChildValues]] | ||
Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
− | + | [[Variable Types|HANDLE]] ''Parent'' | |
:The owning component whose children will all be written to | :The owning component whose children will all be written to | ||
− | + | [[Variable Types|STRING]] ''Property'' | |
:The textual name of the property | :The textual name of the property | ||
− | + | [[Variable Types|STRING]] ''Value'' | |
:The value to update the properties text with | :The value to update the properties text with | ||
+ | |||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
+ | |||
==Detailed description== | ==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== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetChildValues(parent, "property", "value")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetChildValues(parent, "property", "value")</pre> | ||
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets all child components property as a string
Contents
Parameters
HANDLE Parent
- The owning component whose children will all be written to
STRING Property
- The textual name of the property
STRING Value
- The value to update the properties text with
Return value
This call does not return a value
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")
No additional examples