API Component.Property.CopyValue: Difference between revisions

Latest revision as of 14:11, 13 July 2026

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

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Copies a property value from one target to another
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''CopyValue'''
+|-
+| colspan="2" | Copies a property value from one target to another&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Source
+|-
+| colspan="2" | The source component to copy from&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Dest
+|-
+| colspan="2" | The target component to copy to&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Property
+|-
+| colspan="2" | The textual name of the property&nbsp;
+|-
+| 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''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API |API ]]
-:[[API Component|Component]]
-::[[API Component.Property|Property]]
-:::CopyValue
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|HANDLE]] Source''
+This copies a components property value named ''Property'' from the ''Source'' component to the ''Dest''. It is provided for convenience.
-:The source component to copy from
-''[[Variable types|HANDLE]] Dest''
-:The target component to copy to
-''[[Variable types|STRING]] Property''
+An equivalent call using [[API Component.Property.SetValue|SetValue]] from ''this'' to a ''dest'' component may be:
-:The textual name of the property
+:<tt>::Component.Property.SetValue(dest, "property", this::property)</tt>
-==Return value==
-[[Variable types|STRING]]
-No additional information
+And from any component to another:
+:<tt>value = ::Component.Property.GetValue(source, "property")
+:<nowiki/>::Component.Property.SetValue(dest, "property", value)</tt>
-==Detailed description==
-''No additional information''
 ==Examples==

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation