API Component.Property.SetColor: Difference between revisions
No edit summary |
No edit summary |
||
| Line 42: | Line 42: | ||
===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> | ||
Revision as of 11:54, 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)