Jump to content

API Component.Property.SetValue

From Flowcode Help
Revision as of 14:11, 13 July 2026 by SteveT (talk | contribs) (Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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


Detailed description

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().


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Component.Property.SetValue(handle, "property", "value")