Difference between revisions of "API Component.Property.SetValue"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 2: Line 2:
 
Sets a components property as a string
 
Sets a components property as a string
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Component
 +
::Property
 +
:::SetValue
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|HANDLE]] Handle''
 
''[[Variable types|HANDLE]] Handle''
 
:The component handle of the property owner
 
:The component handle of the property owner
Line 13: Line 20:
 
:The value to update the property text with
 
:The value to update the property text with
  
===Return value===
+
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetValue(handle, "property", "value")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetValue(handle, "property", "value")</pre>

Revision as of 15:19, 11 May 2013

<sidebar>API contents</sidebar> Sets a components property as a string

Class hierarchy

Component
Property
SetValue

Parameters

HANDLE Handle

The component handle of the property owner

STRING Property

The textual name of the property

STRING Value

The value to update the property text with

Return value

This call does not return a value

Detailed description

No additional information

Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Component.Property.SetValue(handle, "property", "value")