API Expand.Property: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API Expand|Expand]] | ====Class hierarchy==== | ||
[[API Expand|Expand]] | |||
:[[API Expand|Property]] | :[[API Expand|Property]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==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 | ||
| Line 25: | Line 26: | ||
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
No additional information | ''<span style="color:red;">No additional information</span>'' | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 34: | Line 38: | ||
* 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 information</span>'' | |||
Revision as of 22:10, 11 May 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