API Component.Property.CopyValue: Difference between revisions
XML import API changes |
No edit summary |
||
| Line 24: | Line 24: | ||
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
'' | The value copied to the ''Dest'' components ''Property''. | ||
==Detailed description== | ==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> | |||
Revision as of 19:00, 9 June 2013
<sidebar>API contents</sidebar> Copies a property value from one target to another
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