API Component.Property.SetValue

From Flowcode Help
Jump to navigationJump to search
Fc9-comp-macro.png SetValue
Sets a components property as a string 
Fc9-h32-icon.png - HANDLE Handle
The component handle of the property owner 
Fc9-string-icon.png - STRING Property
The textual name of the property 
Fc9-string-icon.png - STRING Value
The value to update the property text with 
Fc9-void-icon.png - 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")