API Expand.Property: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|STRING]] ''Source'' | ||
:The property name to expand | :The property name to expand | ||
[[Variable | [[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 | [[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 | [[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== | ==Return value== | ||
[[Variable | [[Variable Types|STRING]] | ||
''<span style="color:red;">No additional information</span>'' | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Expands a string to the name of a property used in the generated code
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)
No additional information