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

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|SetColor]]
 
::[[API Component.Property|SetColor]]
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|BYTE]] Red''
+
[[Variable types|BYTE]] ''Red''
 
:The 0-255 red part of the colour
 
:The 0-255 red part of the colour
  
''[[Variable types|BYTE]] Green''
+
[[Variable types|BYTE]] ''Green''
 
:The 0-255 green part of the colour
 
:The 0-255 green part of the colour
  
''[[Variable types|BYTE]] Blue''
+
[[Variable types|BYTE]] ''Blue''
 
:The 0-255 blue part of the colour
 
:The 0-255 blue part of the colour
  
Line 26: Line 27:
  
 
==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.SetColor(handle, red, green, blue)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetColor(handle, red, green, blue)</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

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

No additional information