Difference between revisions of "API Expand.Property"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | API | + | <sidebar>API Contents</sidebar> |
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==== | ||
| + | [[API Expand|Expand]] | ||
| + | :[[API Expand|Property]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|STRING]] ''Source'' | |
:The property name to expand | :The property name to expand | ||
| − | + | [[Variable Types|HANDLE]] ''Owner'' | |
:A component that owns the property | :A component that owns the property | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
| − | + | [[Variable Types|BOOL]] ''AddName'' | |
:Set true to return the name part of the expansion | :Set true to return the name part of the expansion | ||
| − | + | [[Variable Types|BOOL]] ''AddValue'' | |
: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]] | ||
| − | + | Returns the expanded name of the property | |
| − | |||
| − | ===Examples | + | |
| − | + | ==Detailed description== | |
| + | ''<span style="color:red;">No additional information</span>'' | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type STRING | * 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> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Expands a string to the name of a property used in the generated code
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
Returns the expanded name of the property
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
