API Component.Property.CopyValue

<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

STRING

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