Jump to content

API Component.Property.CopyValue: Difference between revisions

From Flowcode Help
No edit summary
No edit summary
Line 44: Line 44:
* Declare a variable 'result' of type STRING
* Declare a variable 'result' of type STRING
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.CopyValue(source, dest, "property")</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.CopyValue(source, dest, "property")</pre>
''<span style="color:red;">No additional examples</span>''

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")