Jump to content

API Component.Property.SetColor: Difference between revisions

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
JonnyW (talk | contribs)
3,997 edits
XML import
No edit summary
Line 1: Line 1:
<sidebar>API Contents</sidebar>
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets a components 'color' property as a R,G,B value
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetColor'''
====Class hierarchy====
|-
[[API Component|Component]]
| colspan="2" | Sets a components 'color' property as a R,G,B value&nbsp;
:[[API Component.Property|Property]]
|-
::[[API Component.Property|SetColor]]
|-
</div>
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
__TOC__
| width="90%" | Handle
 
|-
==Parameters==
| colspan="2" | The component handle of the property owner&nbsp;
[[Variable Types|HANDLE]] ''Handle''
|-
:The component handle of the property owner
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | Red
[[Variable Types|BYTE]] ''Red''
|-
:The 0-255 red part of the colour
| colspan="2" | The 0-255 red part of the colour&nbsp;
 
|-
[[Variable Types|BYTE]] ''Green''
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
:The 0-255 green part of the colour
| width="90%" | Green
 
|-
[[Variable Types|BYTE]] ''Blue''
| colspan="2" | The 0-255 green part of the colour&nbsp;
:The 0-255 blue part of the colour
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | Blue
==Return value==
|-
''This call does not return a value''
| 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''
|}




Revision as of 11:41, 16 January 2023

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)

No additional examples

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Component.Property.SetColor&oldid=29731"