Difference between revisions of "API Component.Property.CopyValue"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Copies a property value from one target to another | Copies a property value from one target to another | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Component|Component]] | ||
| + | :[[API Component.Property|Property]] | ||
| + | ::[[API Component.Property|CopyValue]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Source'' | |
:The source component to copy from | :The source component to copy from | ||
| − | + | [[Variable Types|HANDLE]] ''Dest'' | |
:The target component to copy to | :The target component to copy to | ||
| − | + | [[Variable Types|STRING]] ''Property'' | |
:The textual name of the property | :The textual name of the property | ||
| − | |||
| − | |||
| − | + | ==Return value== | |
| + | [[Variable Types|STRING]] | ||
| − | + | The value copied to the ''Dest'' components ''Property''. | |
| − | '' | ||
| − | ===Examples | + | |
| − | + | ==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: <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>'' | ||
Latest revision as of 15:57, 16 January 2014
<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 examples
