API Component.Property.SetColor

From Flowcode Help
Jump to navigationJump to search
Fc9-comp-macro.png SetColor
Sets a components 'color' property as a R,G,B value 
Fc9-h32-icon.png - HANDLE Handle
The component handle of the property owner 
Fc9-u8-icon.png - BYTE Red
The 0-255 red part of the colour 
Fc9-u8-icon.png - BYTE Green
The 0-255 green part of the colour 
Fc9-u8-icon.png - BYTE Blue
The 0-255 blue part of the colour 
Fc9-void-icon.png - 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)