API Component.Property.SetValue: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetValue
Sets a components property as a string
- HANDLE	Handle
The component handle of the property owner
- STRING	Property
The textual name of the property
- STRING	Value
The value to update the property text with
- NONE	Return

This sets the internal value of a property, and compliments GetValue.

Note this call does not set the value the property will evaluate to, but sets the value that will be evaluated.

For example, a port connection property may be set to the string "$PORTA", but this call can not be used to change the value of a port.

When code is generated the value of the property becomes fixed for the generated code corresponding to the last call to SetValue().

Add to a calculation icon:

::Component.Property.SetValue(handle, "property", "value")

@@ Line 1: / Line 1: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
+| width="90%" class="mtx-class-macrohead" | '''SetValue'''
 |-
 | colspan="2" | Sets a components property as a string&nbsp;