Difference between revisions of "API Component.Property.SetValue"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Sets a components property as a string | Sets a components property as a string | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy=== | + | ====Class hierarchy==== |
| − | + | [[API Component|Component]] | |
| − | : | + | :[[API Component.Property|Property]] |
| − | :: | + | ::[[API Component.Property|SetValue]] |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The component handle of the property owner | :The component handle of the property owner | ||
| − | + | [[Variable Types|STRING]] ''Property'' | |
:The textual name of the property | :The textual name of the property | ||
| − | + | [[Variable Types|STRING]] ''Value'' | |
:The value to update the property text with | :The value to update the property text with | ||
| + | |||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| + | |||
==Detailed description== | ==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()'''. | ||
| + | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetValue(handle, "property", "value")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetValue(handle, "property", "value")</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets a components property as a string
Contents
Parameters
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
Return value
This call does not return a value
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")
No additional examples
