Jump to content

API Component.Property.SetColor: Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,422 edits
Admin (talk | contribs)
3,524 edits
XML import of API auto-gen
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
{| class="mtx-class-macrotable wikitable"
Sets a components 'color' property as a R,G,B value
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetColor'''
|-
| colspan="2" | Sets a components 'color' property as a R,G,B value&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Handle
|-
| colspan="2" | The component handle of the property owner&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Red
|-
| colspan="2" | The 0-255 red part of the colour&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Green
|-
| colspan="2" | The 0-255 green part of the colour&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Blue
|-
| colspan="2" | The 0-255 blue part of the colour&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===Parameters===
==Detailed description==
''[[Variable types|HANDLE]] Handle''
This is a helper function that takes the red, green and blue values form 0-255 and calls [[API Component.Property.SetValue|SetValue]] with the property name "color" and the argument the RGB value built from this calls arguments.
:The component handle of the property owner


''[[Variable types|BYTE]] Red''
:The 0-255 red part of the colour


''[[Variable types|BYTE]] Green''
No check is made to see if the target ''Handle'' has a property called "color", and no error is returned if it does not.
:The 0-255 green part of the colour


''[[Variable types|BYTE]] Blue''
:The 0-255 blue part of the colour


===Return value===
==Examples==
''This call does not return a value''
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetColor(handle, red, green, blue)</pre>
===Detailed description===
''No additional information''
 
===Examples===
====Calling in a calculation====
* Add to a calculation icon: ::Component.Property.SetColor(handle, red, green, blue)

Latest revision as of 14:11, 13 July 2026

SetColor
Sets a components 'color' property as a R,G,B value 
- 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 
- NONE Return


Detailed description

This is a helper function that takes the red, green and blue values form 0-255 and calls SetValue with the property name "color" and the argument the RGB value built from this calls arguments.


No check is made to see if the target Handle has a property called "color", and no error is returned if it does not.


Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::Component.Property.SetColor(handle, red, green, blue)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Component.Property.SetColor&oldid=43110"