Difference between revisions of "API Expand.Property"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
Line 29: Line 29:
 
[[Variable Types|STRING]]
 
[[Variable Types|STRING]]
  
''<span style="color:red;">No additional information</span>''
+
Returns the expanded name of the property
  
  

Revision as of 18:11, 17 June 2013


<sidebar>API contents</sidebar> Expands a string to the name of a property used in the generated code

Class hierarchy

Expand

Property

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

STRING

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