Difference between revisions of "API Component.Property.CopyValue"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
|||
| Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Source'' |
:The source component to copy from | :The source component to copy from | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Dest'' |
:The target component to copy to | :The target component to copy to | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''Property'' |
:The textual name of the property | :The textual name of the property | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|STRING]] |
The value copied to the ''Dest'' components ''Property''. | The value copied to the ''Dest'' components ''Property''. | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Copies a property value from one target to another
Contents
Parameters
HANDLE Source
- The source component to copy from
HANDLE Dest
- The target component to copy to
STRING Property
- The textual name of the property
Return value
The value copied to the Dest components Property.
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")
No additional information
