Difference between revisions of "API Component.Property.SetValue"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
|||
| (22 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Sets a components property as a string | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue''' | ||
| + | |- | ||
| + | | colspan="2" | Sets a components property as a string | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Handle | ||
| + | |- | ||
| + | | colspan="2" | The component handle of the property owner | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Property | ||
| + | |- | ||
| + | | colspan="2" | The textual name of the property | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Value | ||
| + | |- | ||
| + | | colspan="2" | The value to update the property text with | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | == | + | ==Detailed description== |
| − | + | This sets the internal value of a property, and compliments [[API Component.Property.GetValue|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") | + | |
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetValue(handle, "property", "value")</pre> | ||
Latest revision as of 11:54, 16 January 2023
|
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")
