Difference between revisions of "API Expand.Property"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(One intermediate revision by the same user not shown)
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]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Expand|Expand]]
 
−
:[[API Expand|Property]]
 
−
</div>
 
−
__TOC__
 
  
−
==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''
 
−
:Set true to return the value part of the expansion
 
−
 
 
−
 
 
−
==Return value==
 
−
[[Variable Types|STRING]]
 
  
−
Returns the expanded name of the property
 
−
 
−
 
−
==Detailed description==
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
Line 38: Line 40:
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.Property("source", owner, false, true)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.Property("source", owner, false, true)</pre>
−
 
−
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png Property
Expands a string to the name of a property used in the generated code 
Fc9-string-icon.png - STRING Source
The property name to expand 
Fc9-h32-icon.png - HANDLE Owner
A component that owns the property 
Fc9-bool-icon.png - BOOL AddName
Set true to return the name part of the expansion 
Fc9-bool-icon.png - BOOL AddValue
Set true to return the value part of the expansion 
Fc9-string-icon.png - 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)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Expand.Property&oldid=30268"