API Expand.Property: Difference between revisions

Revision as of 11:41, 16 January 2023

	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

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)

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Expands a string to the name of a property used in the generated code
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Property'''
-====Class hierarchy====
+|-
-[[API Expand|Expand]]
+| colspan="2" | Expands a string to the name of a property used in the generated code&nbsp;
-:[[API Expand|Property]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Source
-==Parameters==
+|-
-[[Variable Types|STRING]] ''Source''
+| colspan="2" | The property name to expand&nbsp;
-:The property name to expand
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-[[Variable Types|HANDLE]] ''Owner''
+| width="90%" | Owner
-:A component that owns the property
+|-
-:''The default value for this parameter is: '''''this'''
+| colspan="2" | A component that owns the property&nbsp;
+|-
-[[Variable Types|BOOL]] ''AddName''
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-:Set true to return the name part of the expansion
+| width="90%" | AddName
+|-
-[[Variable Types|BOOL]] ''AddValue''
+| colspan="2" | Set true to return the name part of the expansion&nbsp;
-:Set true to return the value part of the expansion
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | AddValue
-==Return value==
+|-
-[[Variable Types|STRING]]
+| colspan="2" | Set true to return the value part of the expansion&nbsp;
+|-
-Returns the expanded name of the property
+| 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''
+|}

Wiki bot (talk | contribs)

Revision as of 11:41, 16 January 2023

Detailed description

Examples

Calling in a calculation