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

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")

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sets a components property as a string
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''SetValue'''
-====Class hierarchy====
+|-
-[[API Component|Component]]
+| colspan="2" | Sets a components property as a string&nbsp;
-:[[API Component.Property|Property]]
+|-
-::[[API Component.Property|SetValue]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | Handle
+|-
-==Parameters==
+| colspan="2" | The component handle of the property owner&nbsp;
-[[Variable Types|HANDLE]] ''Handle''
+|-
-:The component handle of the property owner
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Property
-[[Variable Types|STRING]] ''Property''
+|-
-:The textual name of the property
+| colspan="2" | The textual name of the property&nbsp;
+|-
-[[Variable Types|STRING]] ''Value''
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-:The value to update the property text with
+| width="90%" | Value
+|-
+| colspan="2" | The value to update the property text with&nbsp;
-==Return value==
+|-
-''This call does not return a value''
+| 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''
+|}
@@ Line 41: / Line 43: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetValue(handle, "property", "value")</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation