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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 2: Line 2:
 
Sets a components 'color' property as a R,G,B value
 
Sets a components 'color' property as a R,G,B value
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Component
 +
::Property
 +
:::SetColor
 +
</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 16: Line 23:
 
:The 0-255 blue part of the colour
 
:The 0-255 blue part of the colour
  
===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.SetColor(handle, red, green, blue)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetColor(handle, red, green, blue)</pre>

Revision as of 15:19, 11 May 2013

<sidebar>API contents</sidebar> Sets a components 'color' property as a R,G,B value

Class hierarchy

Component
Property
SetColor

Parameters

HANDLE Handle

The component handle of the property owner

BYTE Red

The 0-255 red part of the colour

BYTE Green

The 0-255 green part of the colour

BYTE Blue

The 0-255 blue part of the colour

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.SetColor(handle, red, green, blue)