API Expand.Property: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	Property
Expands a string to the name of a property used in the generated code
- STRING	Source
The property name to expand
- HANDLE	Owner
A component that owns the property
- BOOL	AddName
Set true to return the name part of the expansion
- BOOL	AddValue
Set true to return the value part of the expansion
- STRING	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type STRING

Add to a calculation icon:

result = ::Expand.Property("source", owner, false, true)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Expands a string to the name of a property used in the generated code
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''Property'''
+|-
+| colspan="2" | Expands a string to the name of a property used in the generated code&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Source
+|-
+| colspan="2" | The property name to expand&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Owner
+|-
+| colspan="2" | A component that owns the property&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | AddName
+|-
+| colspan="2" | Set true to return the name part of the expansion&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | AddValue
+|-
+| colspan="2" | Set true to return the value part of the expansion&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|STRING]] Source''
-:The property name to expand
-''[[Variable types|HANDLE]] Owner''
-:A component that owns the property
-:''The default value for this parameter is: '''''this'''
-''[[Variable types|BOOL]] AddName''
-:Set true to return the name part of the expansion
-''[[Variable types|BOOL]] AddValue''
+==Examples==
-:Set true to return the value part of the expansion
+===Calling in a calculation===
-===Return value===
-[[Variable types|STRING]]
-No additional information
-===Detailed description===
-''No additional information''
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type STRING
-* Add to a calculation icon: result = ::Expand.Property("source", owner, false, true)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.Property("source", owner, false, true)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation