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

From Flowcode Help
Jump to navigationJump to search
(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 Component|Component]]
+
====Class hierarchy====
 +
[[API Component|Component]]
 
:[[API Component.Property|Property]]
 
:[[API Component.Property|Property]]
 
::[[API Component.Property|SetValue]]
 
::[[API Component.Property|SetValue]]
Line 10: Line 11:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] Handle''
+
[[Variable types|HANDLE]] ''Handle''
 
:The component handle of the property owner
 
:The component handle of the property owner
  
''[[Variable types|STRING]] Property''
+
[[Variable types|STRING]] ''Property''
 
:The textual name of the property
 
:The textual name of the property
  
''[[Variable types|STRING]] Value''
+
[[Variable types|STRING]] ''Value''
 
:The value to update the property text with
 
:The value to update the property text with
  
Line 23: Line 24:
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==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>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:07, 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")

No additional information