Difference between revisions of "API Component.Property.CopyValue"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (17 intermediate revisions by 3 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;" | '''CopyValue''' | ||
| + | |- | ||
| + | | colspan="2" | Copies a property value from one target to another | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Source | ||
| + | |- | ||
| + | | colspan="2" | The source component to copy from | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Dest | ||
| + | |- | ||
| + | | colspan="2" | The target component to copy to | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Property | ||
| + | |- | ||
| + | | colspan="2" | The textual name of the property | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | == | + | ==Detailed description== |
| − | '' | + | This copies a components property value named ''Property'' from the ''Source'' component to the ''Dest''. It is provided for convenience. |
| − | |||
| − | |||
| − | |||
| − | + | An equivalent call using [[API Component.Property.SetValue|SetValue]] from ''this'' to a ''dest'' component may be: | |
| − | : | + | :<tt>::Component.Property.SetValue(dest, "property", this::property)</tt> |
| − | |||
| − | |||
| − | + | And from any component to another: | |
| + | :<tt>value = ::Component.Property.GetValue(source, "property") | ||
| + | :<nowiki/>::Component.Property.SetValue(dest, "property", value)</tt> | ||
| − | |||
| − | |||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: result = ::Component.Property.CopyValue(source, dest, "property") | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.CopyValue(source, dest, "property")</pre> |
Latest revision as of 11:54, 16 January 2023
|
CopyValue |
| Copies a property value from one target to another | |
 - HANDLE
|
Source |
| The source component to copy from | |
| - HANDLE
|
Dest |
| The target component to copy to | |
 - STRING
|
Property |
| The textual name of the property | |
| - STRING
|
Return |
Detailed description
This copies a components property value named Property from the Source component to the Dest. It is provided for convenience.
An equivalent call using SetValue from this to a dest component may be:
- ::Component.Property.SetValue(dest, "property", this::property)
And from any component to another:
- value = ::Component.Property.GetValue(source, "property")
- ::Component.Property.SetValue(dest, "property", value)
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Component.Property.CopyValue(source, dest, "property")
