API Component.Property.SetColor

From Flowcode Help
Revision as of 11:41, 16 January 2023 by Wiki bot (talk | contribs)
Jump to navigationJump to search
Error creating thumbnail: Unable to save thumbnail to destination
SetColor
Sets a components 'color' property as a R,G,B value 
Error creating thumbnail: Unable to save thumbnail to destination
- HANDLE
Handle
The component handle of the property owner 
Error creating thumbnail: Unable to save thumbnail to destination
- BYTE
Red
The 0-255 red part of the colour 
Error creating thumbnail: Unable to save thumbnail to destination
- BYTE
Green
The 0-255 green part of the colour 
Error creating thumbnail: Unable to save thumbnail to destination
- BYTE
Blue
The 0-255 blue part of the colour 
Error creating thumbnail: Unable to save thumbnail to destination
- 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