Difference between revisions of "API Expand.Property"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Expands a string to the name of a property used in the generated code | Expands a string to the name of a property used in the generated code | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Expand | ||
| + | ::Property | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|STRING]] Source'' | ''[[Variable types|STRING]] Source'' | ||
:The property name to expand | :The property name to expand | ||
| Line 17: | Line 23: | ||
:Set true to return the value part of the expansion | :Set true to return the value part of the expansion | ||
| − | + | ==Return value== | |
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
No additional information | No additional information | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.Property("source", owner, false, true)</pre> |
Revision as of 17:05, 11 May 2013
<sidebar>API contents</sidebar> Expands a string to the name of a property used in the generated code
Class hierarchy
- Expand
- Property
Contents
Parameters
STRING Source
- The property name to expand
HANDLE Owner
- A component that owns the property
- The default value for this parameter is: this
BOOL AddName
- Set true to return the name part of the expansion
BOOL AddValue
- Set true to return the value part of the expansion
Return value
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)
